Skip to main content
POST
Initiate payment

Authorizations

x-api-key
string
header
required

Body

application/json
amount
number
required
Example:

20

reference
string
required
Example:

"tx-12345"

customer
object
required
Example:
description
string
required
Example:

"Payment for services rendered"

metadata
object
required
Example:
currency
enum<string>
default:USD
required
Available options:
BDT,
BIF,
BWP,
CAD,
CDF,
EGP,
ETB,
EUR,
GBP,
GHS,
GMD,
KES,
LRD,
LSL,
MUR,
MWK,
MZN,
NGN,
RWF,
SLE,
SSP,
TZS,
UGX,
USD,
XAF,
XOF,
ZAR,
ZMW
Example:

"USD"

country
string

ISO 3166-1 alpha-2 country code. Required for currencies shared by multiple countries, such as XOF.

Example:

"SN"

redirectUrl
string

Where the customer is sent back to after completing (or abandoning) checkout.

Example:

"https://your-app.example.com/checkout/callback"

isRecurring
boolean

Merchant-declared intent to charge this saved payment method again later. Purely a signal for reporting - tokenization happens whenever the provider supports it regardless of this flag.

Example:

false

Response

201 - application/json