Skip to main content
POST
https://api.business.bumxpress.com
/
payouts
Create payout
curl --request POST \
  --url https://api.business.bumxpress.com/payouts \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-key>' \
  --data '
{
  "quote_id": "33333333-3333-3333-3333-333333333333",
  "customer_id": "22222222-2222-2222-2222-222222222222",
  "payment_reason_code": "OTHER",
  "payment_reason_text": "Merchant payout",
  "recipient": {
    "recipient_type": "individual",
    "first_name": "Awa",
    "last_name": "Ngu",
    "country_code": "CM",
    "rail_type": "mobile_money",
    "phone": "+237670000000",
    "email": "awa@example.com",
    "recipient_nationality_code": "CM",
    "operator_code": "CM_MTN_MOMO",
    "address_line1": "123 Main Street",
    "city": "Douala"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "send_amount": "10000",
  "send_currency": "XAF",
  "receive_amount": "10000",
  "receive_currency": "XAF",
  "country_code": "CM",
  "operator_code": "<string>",
  "provider_reference": "<string>",
  "wallet_impact": {},
  "pricing": {},
  "history": [
    {
      "status": "<string>",
      "reason": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "recipient": {
    "country_code": "CM",
    "phone": "+237670000000",
    "operator_code": "CM_MTN_MOMO",
    "bank_name": "<string>",
    "bank_code": "<string>",
    "account_name": "<string>",
    "account_number": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "business_name": "<string>",
    "email": "jsmith@example.com",
    "recipient_nationality_code": "CM",
    "address_line1": "<string>",
    "city": "<string>"
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "quote_id is required"
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "quote_id is required"
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "quote_id is required"
  }
}
Payouts debit the merchant wallet and are processed 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
​
recipient
object
required
​
payment_reason_code
string
Example:

"OTHER"

​
payment_reason_text
string
Example:

"Merchant payout"

Response

Payout 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
string
Required string length: 3
Example:

"XAF"

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

"10000"

​
receive_currency
string
Required string length: 3
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
​
recipient
object
Last modified on July 8, 2026