POST
Initiate a payment collection

Authorizations

x-api-key
string
header
required

Your business API key, generated from the dashboard. Required on every business-facing endpoint.

Body

application/json
amount
string
required
Example:

"500"

fromCurrency
enum<string>
required

Fiat currencies: NGN, EUR, GBP, USD, KES, UGX, GHS, CAD, XOF, XAF. Crypto currencies: USDT, USDC.

Available options:
NGN,
EUR,
GBP,
USD,
USDT,
USDC,
KES,
UGX,
GHS,
CAD,
XOF,
XAF
toCurrency
enum<string>
required

Fiat currencies: NGN, EUR, GBP, USD, KES, UGX, GHS, CAD, XOF, XAF. Crypto currencies: USDT, USDC.

Available options:
NGN,
EUR,
GBP,
USD,
USDT,
USDC,
KES,
UGX,
GHS,
CAD,
XOF,
XAF
paymentReference
string
required

Unique reference you generate. Reusing one returns a 400.

Example:

"invoice-4471"

source
string
rateKey
string

Required when fromCurrency differs from toCurrency. Obtain from GET /api/qoutes/{fromCurrency}/{toCurrency}/{amount}.

narration
string
Example:

"Invoice #4471"

receipent
object

Only required when the collection settles to a crypto or specific bank destination.

Response

Collection created.

message
string
Example:

"Payment collection initiated successfully"

data
object
error
boolean
Example:

false