Skip to main content
POST
Collect payment (Pay-In)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key
string
required

Your API key

operation
integer
required

Operation code. For this endpoint, must be 2

Example:

2

service
integer
required

The service your customer will pay for

Example:

2

otp
integer

For Orange Money service, provide OTP code if required by your logic

Body

application/json
wallet
string
required

The wallet where we proceed the payment

Example:

"690000001"

amount
number<float>
required

Amount of current payment

Example:

1000

currency
string
required

Currency in which the payment is processed

Example:

"XAF"

order_id
string
required

Unique order ID in your app for the current payment

Example:

"abc1234"

description
string
required

Short description of the current payment

Example:

"pay for rent"

payer
string
required

Name of your customer

Example:

"John"

payerEmail
string<email>
required

Customer email to receive payment receipt after confirmation

Example:

"john@mail.com"

successUrl
string<uri>
required

URL to notify when payment succeeds

Example:

"https://successurl.com/receive-payment"

failureUrl
string<uri>
required

URL to notify when payment fails

Example:

"https://failureurl.com/payment-fail"

Response

Success request - Transaction is processing

success
boolean
Example:

true

code
integer
Example:

200

status
string
Example:

"PROCESSING"

created_at
string
Example:

"2024-12-16 10:05:01"

data
object
message
string
Example:

"transaction processing"