Initiate a payment

Initiates a payment against an existing invoice. The response shape varies by method: wallet and bank payments return a redirect session URL, card payments are settled synchronously, and QR payments return a scannable code with an in-app deep link.

POST

Headers

string

The Bearer token for authentication.

string

The user agent of the request. Must contain at least two identifiers separated by a space.

string

The content type of the request.

Request Body

application/json
string

The ID of the invoice being paid

object

The payment method to be used

string

Type of payment method

walletqrcardbank
object

Payment method data

string

The slug of the QR code provider.

uni5paymopelightning

object

Customer shipping details schema.

string

Full name of the customer.

string

Phone number of the customer. (e.g. +597-8123456)

string

Address line 1.

string

Address line 2.

string

City.

string

State.

string

Zip code.

string

Country code in ISO 3166-1 alpha-2 format.

Response Body

application/json
boolean

Indicates that the request was successful.

object

The payment response data.

string

The ID of the newly created payment.

string

The status of the newly created payment.

object

The next action to take for the payment.

string

The type of action to perform

string

The provider slug

string

The encoded code value. Present this value as a QR code to the customer

string

The deeplink url used to trigger the app on the customer's device