Skip to main content
GET
Get transfer
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
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"

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"

payout_currency
enum<string>

Supported currencies for payins, payouts, and transfers.

Available options:
XAF,
XOF
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