fbpx

Cardless Payment

This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!

URL:

https://api.kashflow.com/v2/internal/cardlesspayments

Method(s):

post

Response Formats:

JSON or XML

Description:


This method allows user to make a cardless payment for an invoice using a cardless payment provider like GoCardless.

Request Parameters

NameTypeDescription
InvoiceNumber NumericInvoice number for which payment is being made.
AmountNumericPayment amount

All parameters are mandatory for request.

POST Operation

Makes a cardless payment for an invoice.

URL : /internal/cardlesspayments

Example request for POST of cardless payment


{
"InvoiceNumber" : 1245,
"Amount" : 12.05
}

Response : 201 Created

Response Parameters

NameTypeDescription
AuthorizationCodeStringBill id generated for further reference.
MessageStringMessage returned from cardless provider.

Example Response for POST of cardless payment


{
    "AuthorizationCode": "0D7XD6WBY5",
    "Message": "The GoCardless payment was successful"
}

On payment failure 400 Bad request is thrown with appropriate message returned from GoCardless.

See how KashFlow works with your business and your books