Payouts

Create or reuse a payout destination

Creates setup data only and does not move funds. Requires a stable Idempotency-Key.

post/api/v1/payout-destinations

Request

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

Headers

Idempotency-Keystring required

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

Request body

institution_idstring required
account_holder_namestring required
account_numberstring required
labelstring
make_defaultboolean

Response

Destination created

idstring required
object'payout_destination' required
type'bank' | 'mobile_money' required
countrystring required
currencystring required
labelstring nullable
account_holder_namestring nullable
last4string required
status'pending' | 'verified' | 'inactive' required
is_defaultboolean

Changes

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