Payouts

Retrieve aggregate payout and opaque delivery parts

get/api/v1/payouts/{id}

Request

  • Base URL: https://api.xrpay.it
  • URL: https://api.xrpay.it/api/v1/payouts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Payout

idstring required
object'payout' required
livemodeboolean required
simulatedboolean required

True when the payout changes only isolated test balances.

external_transfer_sentboolean nullable required

Always false for test payouts. Null for live payouts because delivery state is represented by status and deliveries.

status_messagestring nullable required

For test payouts, explicitly confirms that no external bank or Mobile Money transfer was sent. Null for live payouts.

funding_source'provider_balance'
destination_idstring required
currencystring required
recipient_amountstring required

An exact non-negative decimal amount. Never parse this as a binary floating-point number.

withdrawal_fee_amountstring

An exact non-negative decimal amount. Never parse this as a binary floating-point number.

total_debit_amountstring required

An exact non-negative decimal amount. Never parse this as a binary floating-point number.

status'pending' | 'processing' | 'partially_completed' | 'completed' | 'failed' | 'action_required' required
failure_codestring nullable
failure_messagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.