Payouts

Atomically reserve and execute a quoted payout

With live credentials, this is a money-moving operation: XRPay validates the quote, reserves the total debit, and submits the bank or Mobile Money payout. With test credentials, XRPay changes only isolated virtual balances, contacts no external financial network, and returns external_transfer_sent=false.

post/api/v1/payouts

Request

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

Headers

Idempotency-Keystring required

Stable key for one logical operation. Reusing a key with different parameters returns HTTP 409.

Request body

quote_idstring required

Response

Idempotent replay

Changes

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