Payouts

Retrieve consolidated payout balances

Returns posted available, retained minimum, reserved, in-flight, pending, and destination-specific withdrawable decimal amounts. early_transfer_eligible is the subset of pending proceeds currently backed by prefunded liquidity. transferable equals usable settled available plus early_transfer_eligible; do not add it to ledger_balance or pending. funding_verified_at reports the funding snapshot time when an early-transfer amount is offered. Quotes include transfer fees and atomically recheck liquidity when submitted. Custody providers remain private. Test credentials return only isolated virtual test balances; live and test balances never mix.

get/api/v1/balances

Request

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

Query parameters

destination_idstring

Response

Consolidated balances

Changes

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