v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-044359269.1 KB

Payouts

Create payout

Creates a new payout.

post/v1/payouts

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

source_account_idstring uuid required

ID of the account to debit.

amountstring required

Amount as a string decimal (e.g. "100.50").

currency'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL' required

Currency for the payout.

rail'sepa_instant' | 'sepa' | 'faster_payments'

Payment rail. It is enforced when provided, otherwise auto-selected.

referencestring required

Payment reference.

metadataobject

Key-value pairs stored with the payout.

Response

Success

idstring required

Unique identifier of the payout.

type'payout' required

Resource type discriminator.

status'pending' | 'paid' | 'failed' | 'returned' required

Current status of the payout.

source_account_idstring required

ID of the account that was debited.

amountstring required

Amount as a string decimal (e.g. "100.50").

currency'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL' required

Currency code (ISO 4217 currency code or crypto currency code).

referencestring required

Payment reference.

metadataobject required

Key-value pairs stored with the payout.

created_atstring date-time required

ISO 8601 UTC timestamp when the payout was created.

updated_atstring date-time required

ISO 8601 UTC timestamp when the payout was last updated.