Skip to main content
POST
Collect a payment from a customer

Authorizations

Authorization
string
header
required

Scoped Bearer token from POST /merchant/api/auth.

Body

application/json
amount
number<float>
required
Required range: 0.01 <= x <= 1000000
Example:

5000

payment_method
enum<string>
required

Mobile-money provider for collections/deposits.

Available options:
OrangeMoney,
Wave,
Sama,
Moov
customer_phone
string
required
Example:

"+22370000000"

currency
string
default:USD
Example:

"USD"

customer_email
string<email>
reference
string

Your unique idempotency reference. Auto-generated if omitted.

description
string
return_url
string<uri>

Redirect after success (hosted checkout providers).

cancel_url
string<uri>

Redirect after cancel (hosted checkout providers).

Response

Payment initiated; awaiting customer confirmation.

success
boolean
Example:

true

message
string
request_id
string<uuid>
data
object