Skip to main content
POST
Create manual payout

Authorizations

Authorization
string
header
required

Enter your API key starting with gtw_sk_

Headers

Idempotency-Key
string

Required unless clientReference is supplied in the request body. Unique per organization.

Maximum string length: 128

Body

application/json
payoutAccountId
string<uuid>
required
amount
number
required

Destination amount for cross-currency; else source==destination

sourceCurrency
string

Wallet to debit; omit for same-currency

Example:

"USD"

clientReference
string

Required unless Idempotency-Key is supplied. Must match the header when both are sent.

Maximum string length: 128
metadata
object

Response

Existing payout returned for an idempotent replay; Idempotency-Replayed is true