Skip to main content
GET
/
api
/
payouts
/
{id}
Get Payout
curl --request GET \
  --url https://api.example.com/api/payouts/{id} \
  --header 'Authorization: <authorization>'
{
  "id": "pay_abc123",
  "transaction_type": "payout",
  "payout_amount": 4425.00,
  "source_amount": 1000.00,
  "source_currency": "USD",
  "payout_currency": "MYR",
  "status": "completed",
  "recipient_id": "rec_xyz",
  "bank_name": "Maybank",
  "bank_account": "1234567890",
  "payment_method": "fiat_bank_transfer",
  "payment_purpose": "trade_settlement",
  "created_at": "2026-03-01T10:00:00Z",
  "completed_at": "2026-03-01T10:05:00Z",
  "provider_metadata": {
    "version": 1,
    "onramp": { "protocol": "airwallex", "status": "completed" },
    "offramp": { "protocol": "airwallex", "amount": 4425, "currency": "MYR" }
  }
}
​
Authorization
string
required
Bearer token from Auth0
​
id
string
required
Payout ID
​
id
string
Payout ID
​
transaction_type
string
payout or swap
​
payout_amount
number
Amount in payout currency
​
source_amount
number
Amount in source currency
​
source_currency
string
Source currency code
​
payout_currency
string
Payout currency code
​
status
string
pending, processing, completed, failed, or cancelled
​
recipient_id
string
Recipient ID
​
bank_account
string
Bank account number
​
wallet_address
string
Wallet address (for crypto payouts)
​
payment_method
string
Payment method used
​
payment_purpose
string
Purpose of payment
​
reference
string
Payment reference
​
provider_metadata
object
Provider-specific metadata (onramp, offramp, swap, bridge details)
{
  "id": "pay_abc123",
  "transaction_type": "payout",
  "payout_amount": 4425.00,
  "source_amount": 1000.00,
  "source_currency": "USD",
  "payout_currency": "MYR",
  "status": "completed",
  "recipient_id": "rec_xyz",
  "bank_name": "Maybank",
  "bank_account": "1234567890",
  "payment_method": "fiat_bank_transfer",
  "payment_purpose": "trade_settlement",
  "created_at": "2026-03-01T10:00:00Z",
  "completed_at": "2026-03-01T10:05:00Z",
  "provider_metadata": {
    "version": 1,
    "onramp": { "protocol": "airwallex", "status": "completed" },
    "offramp": { "protocol": "airwallex", "amount": 4425, "currency": "MYR" }
  }
}