Payouts

Quote an exact-net or maximum-balance payout

Creates an expiring quote without moving funds. Payout-balance quotes subtract the account's retained minimum before calculating withdrawable funds. The response aggregates internal custody legs and exposes fees and transfer count, never provider names. With test credentials, simulated is true and test_mode_notice states that execution will not send external money.

post/api/v1/payout-quotes

Request

  • Base URL: https://api.xrpay.it
  • URL: https://api.xrpay.it/api/v1/payout-quotes
  • Auth: HTTP bearer

Request body

destination_idstring required
currencystring required
amount_mode'exact' | 'maximum' required
amountstring

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

funding_source'provider_balance'

Response

Expiring payout quote

idstring required
object'payout_quote' required
livemodeboolean required
simulatedboolean required

True when the quote uses an isolated test balance.

test_mode_noticestring nullable required

For test quotes, confirms that execution will not send money to a bank or Mobile Money wallet. Null for live quotes.

funding_source'provider_balance' required
amount_mode'exact' | 'maximum' required
currencystring required
requested_amountstring

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

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.

transfer_countinteger required
estimated_delivery_secondsinteger nullable

Aggregate delivery estimate for the slowest internal transfer part, when every part has an estimate.

can_executeboolean
blockersobject[]
expires_atstring date-time required

Changes

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