Skip to main content
GET
https://api.business.bumxpress.com
/
transfers
/
{transfer_id}
Get transfer
curl --request GET \
  --url https://api.business.bumxpress.com/transfers/{transfer_id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-key>'
{
  "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",
  "payin_status": "<string>",
  "payout_status": "<string>",
  "send_amount": "10000",
  "send_currency": "XAF",
  "receive_amount": "10000",
  "receive_currency": "XAF",
  "payin_amount": "10000",
  "payin_currency": "XAF",
  "payout_amount": "10000",
  "payout_currency": "XAF",
  "corridor_code": "<string>",
  "corridor_type": "<string>",
  "execution": {},
  "payer": {
    "country_code": "CM",
    "phone": "+237670000000",
    "operator_code": "CM_MTN_MOMO",
    "bank_name": "<string>",
    "bank_code": "<string>",
    "account_name": "<string>",
    "account_number": "<string>"
  },
  "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>"
  },
  "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"
}
{
  "error": {
    "code": "bad_request",
    "message": "quote_id is required"
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "quote_id is required"
  }
}
Use this endpoint to read payin and payout leg status, execution metadata, and timestamps.

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.

Path Parameters

​
transfer_id
string<uuid>
required

Response

Transfer object.

​
id
string<uuid>
​
merchant_id
string<uuid>
​
customer_id
string<uuid>
​
quote_id
string<uuid>
​
status
enum<string>
Available options:
pending,
collecting,
disbursing,
completed,
failed
​
payin_status
string
​
payout_status
string
​
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"

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

"10000"

​
payin_currency
string
Required string length: 3
Example:

"XAF"

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

"10000"

​
payout_currency
string
Required string length: 3
Example:

"XAF"

​
corridor_code
string
​
corridor_type
string
​
execution
object
​
payer
object
​
recipient
object
​
pricing
object
​
history
object[]
​
created_at
string<date-time>
​
updated_at
string<date-time>
Last modified on July 8, 2026