Skip to main content
​
id
string
Unique identifier for the order
​
quote_id
string
ID of the associated quote
​
offering_id
string
ID of the associated offering
​
reference_number
string
Internal reference number for the order
​
external_reference_id
string
External reference ID provided by the organization
​
exchange_rate
string
The exchange rate used for this order
​
effective_exchange_rate
string
The actual effective exchange rate after execution
​
payin
object
Payment input details
​
payin.external_payment_instrument
object
External payment instrument object for incoming payments
​
payin.total
string
Total amount paid in
​
payin.fee
string
Fee amount
​
payin.tax
string
Tax amount
​
payout
object
Payment output details
​
payout.external_payment_instrument
object
External payment instrument object for outgoing payments
​
payout.total
string
Total amount to be paid out
​
status
object
Current status information
​
status.current_status
string
Current status of the order (see Order Statuses)
​
status.status_history
object[]
Historical record of status changes
​
status.status_history[].status
string
The status value for this history entry
​
status.status_history[].created_at
string
Timestamp when this status change occurred
​
funding_instructions
object
Instructions for funding the order. Use this to show the end user where and how to send funds (e.g. bank details for NGN). Structure depends on funding_instructions.currency and funding_instructions.method.
​
funding_instructions.currency
string
Currency for funding (see Currency Symbols). Determines the shape of details.
​
funding_instructions.method
string
Payment method for funding (see Payment Methods). For NGN orders this is NGN_BANK_ACCOUNT.
​
funding_instructions.details
object
Payment method-specific funding details. Echoes the payin external payment instrument. For NGN (currency NGN, method NGN_BANK_ACCOUNT): bank_name, bank_account_number, doc_id, account_holder_first_name, account_holder_last_name, account_holder_business_name. For other currencies (e.g. MXN, BRL), the structure differs.

​
Funding instructions by currency

CurrencyMethodDetails shape
NGNNGN_BANK_ACCOUNTbank_name, bank_account_number, doc_id, account_holder_first_name, account_holder_last_name, account_holder_business_name
MXNBank transferCLABE, reference, bank name, account holder
BRLPIXPix copy-paste code, QR code (base64)
USDCSOLANA_ADDRESSBlockchain address and reference
​
retry_order_id
string
ID of the retry order if this order was retried
​
created_at
string
Timestamp when the order was initially created
​
updated_at
string
When the order was last updated