Create transfer quote

curl --request POST \ --url https://api.business.bumxpress.com/quotes/transfer \ --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", "corridor_code": "CM-CI-XAF-XOF", "payer_operator_code": "CM_MTN_MOMO", "recipient_operator_code": "CI_ORANGE_MOMO", "payin_amount": "100000", "payin_currency": "XAF", "payout_amount": "98500", "payout_currency": "XOF", "send_amount": "100000", "send_currency": "XAF" } '

{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "flow_type": "payin", "status": "active", "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>", "rail_type": "mobile_money", "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 } }

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

corridor_code

string

required

Example:

"CM-CI-XAF-XOF"

payer_operator_code

string

required

Example:

"CM_MTN_MOMO"

recipient_operator_code

string

required

Example:

"CI_ORANGE_MOMO"

payout_currency

enum<string>

required

Supported currencies for payins, payouts, and transfers.

Available options:

XAF,

XOF

Example:

"XAF"

customer_id

string<uuid>

payin_amount

string

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

Example:

"10000"

payin_currency

enum<string>

Supported currencies for payins, payouts, and transfers.

Available options:

XAF,

XOF

Example:

"XAF"

payout_amount

string

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

Example:

"10000"

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"

Response

Transfer quote created.

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

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"

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

Show child attributes

Customers

Customer KYC

Quotes

Payins

Payouts

Transfers

Authorizations

Headers

Body

Response