v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Auto Payouts

Configure auto-payout for a currency

Creates or updates a daily auto-payout rule for the given currency. Each day at the configured global hour, the merchant's full withdrawable balance (net of obligations) for that currency is swept to the destination account.

put/api/auto-payout

Request body

currency'USDC' | 'EURC' required

Withdrawal currency for this auto-payout rule

accountIdstring required

Identifier of the payout destination (bank or wallet account)

Destination network. Required when the destination account is a crypto wallet.

enabledboolean

Whether this auto-payout rule is active

Example request

{
  "currency": "USDC",
  "accountId": "acc_1234567890abcdef"
}

Response

Auto-payout configuration saved

currency'USDC' | 'EURC' required

accountIdstring required

destinationLabelstring nullable

destinationType'bank-account' | 'wallet' nullable

bankInfostring nullable

Masked IBAN or account number (last 4 digits only)

addressstring nullable

networkstring nullable

enabledboolean required

createdAtstring date-time required

updatedAtstring date-time required