Skip to main content
POST
Create payin
The API returns a pending resource while provider processing continues asynchronously.

Authorizations

X-Api-Key
string
header
required

Public API key from the merchant dashboard.

X-Api-Secret
string
header
required

Secret shown once when the API key is created.

Headers

Idempotency-Key
string
required

Unique key for this business intent. Reuse only when retrying the same request body.

Body

application/json
quote_id
string<uuid>
required
customer_id
string<uuid>
required
source
object
required
otp_code
string
write-only

Required only when the selected provider operator requires an OTP. Never returned by the API.

Response

Payin created.

id
string<uuid>
merchant_id
string<uuid>
customer_id
string<uuid>
quote_id
string<uuid>
send_amount
string
Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"10000"

send_currency
enum<string>

Supported currencies for payins, payouts, and transfers.

Available options:
XAF,
XOF
Example:

"XAF"

receive_amount
string
Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"10000"

receive_currency
enum<string>

Supported currencies for payins, payouts, and transfers.

Available options:
XAF,
XOF
Example:

"XAF"

country_code
string
Required string length: 2
Example:

"CM"

rail_type
enum<string>
Available options:
mobile_money,
bank_transfer
operator_code
string
provider_reference
string | null
wallet_impact
object
pricing
object
history
object[]
created_at
string<date-time>
updated_at
string<date-time>
status
enum<string>
Available options:
created,
pending,
completed,
failed
source
object
Last modified on July 8, 2026