Skip to main content
POST
https://api.business.bumxpress.com
/
quotes
/
payout
Create payout quote
curl --request POST \
  --url https://api.business.bumxpress.com/quotes/payout \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-key>' \
  --data '
{
  "customer_id": "22222222-2222-2222-2222-222222222222",
  "country_code": "CM",
  "operator_code": "CM_MTN_MOMO",
  "rail_type": "mobile_money",
  "send_amount": "25.00",
  "send_currency": "USD"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z",
  "send_amount": "10000",
  "send_currency": "XAF",
  "receive_amount": "10000",
  "receive_currency": "XAF",
  "country_code": "CM",
  "operator_code": "<string>",
  "corridor_code": "<string>",
  "corridor_type": "<string>",
  "payer_operator_code": "<string>",
  "recipient_operator_code": "<string>",
  "total_fee": "10000",
  "wallet_impact": {},
  "created_at": "2023-11-07T05:31:56Z",
  "_meta": {
    "idempotency_key": "<string>",
    "idempotency_replayed": true
  }
}
{
  "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"
  }
}
Use payout quotes before sending funds from your USD merchant wallet to a recipient in local currency.

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
​
country_code
string
required
Required string length: 2
Example:

"CM"

​
operator_code
string
required
Example:

"CM_MTN_MOMO"

​
rail_type
enum<string>
required
Available options:
mobile_money,
bank_transfer
​
send_amount
string
required
Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"10000"

​
send_currency
string
required
Required string length: 3
Example:

"XAF"

​
customer_id
string<uuid>

Response

Payout quote created.

​
id
string<uuid>
​
customer_id
string<uuid>
​
flow_type
enum<string>
Available options:
payin,
payout,
transfer
​
status
enum<string>
Available options:
active,
expired,
consumed
​
expires_at
string<date-time>
​
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"

​
operator_code
string
​
rail_type
enum<string>
Available options:
mobile_money,
bank_transfer
​
corridor_code
string
​
corridor_type
string
​
payer_operator_code
string
​
recipient_operator_code
string
​
total_fee
string
Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"10000"

​
wallet_impact
object
​
created_at
string<date-time>
​
_meta
object
Last modified on July 8, 2026