Sign in

v47

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-013871777.1 KB
Payout

Create a payout

Create a payout for a merchant.

post/api/service/payout/create

Headers

Idempotency-Keystring

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

amountnumber required

The payout amount in decimal format. The minimum amount is 0.01.

currency'EUR' | 'GBP' | 'USDC' | 'USD' required
rail'SEPA_INSTANT' | 'FASTER_PAYMENTS' | 'SEPA' | 'ELIXIR' | 'EXPRESS_ELIXIR' | 'SEK_ACCOUNT_TO_ACCOUNT' | 'SUMCLEARING' | 'STRAKSCLEARING' | 'SWIFT' | 'INTERNAL' | 'TARGET' | 'ACH' | 'FEDWIRE' | 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY'

The payment rail or blockchain used for the payout

metadataobject

This can be used to store any additional information you need to associate with this payout.

paymentReferencestring

The payout payment reference. This is visible to the receiving party, if possible.

Response

Create a payout

idstring required

The payout ID

type'beneficiary' | 'customer' required

The payout type

status'paid' | 'pending' | 'in_transit' | 'failed' | 'canceled' required

The payout status

amountnumber required

The payout amount

currency'EUR' | 'GBP' | 'USDC' | 'USD' required

The payout currency

metadataobject

The payout metadata

{"stackTrail":"components:schemas:CreatePayoutResponseDto:properties:createdAt","oasType":"schema","type":"unknown","description":"The payout created at"}
{"stackTrail":"components:schemas:CreatePayoutResponseDto:properties:updatedAt","oasType":"schema","type":"unknown","description":"The payout updated at"}
paymentReferencestring

The payout payment reference

transactionIdstring

The payout transaction ID