Skip to main content

Payments

POST /payments/initiate

Initiates an inbound mobile money payment.

Request body

FieldTypeRequiredDescription
amountnumberAmount in currency unit
currencystringXOF by default
operatorSlugstringOperator slug (e.g. orange-money-ci)
customerPhonestringPayer's phone number
customerNamestringPayer's name
customerEmailstringPayer's email
merchantRefstringInternal merchant reference
notifyUrlstringWebhook notification URL
successUrlstringRedirect on success
failedUrlstringRedirect on failure
descriptionstringTransaction description
metadataobjectFree-form data

GET /payments/:reference

Retrieves a payment status by its reference.