Create a payout

post

http://localhost:4000/v1/payouts/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

string

required

^\d+(\.\d{1,8})?$

Decimal amount with up to 8 fractional digits, e.g. "1500" or "1500.75"

currency

string

enum

required

network

string

enum

required

recipient

object

required

description

string

length ≤ 500

category

string

length ≤ 50

counterpartyId

string

paymentPin

string

length between 6 and 6

^\d{6}$

totp

string

length between 6 and 6

^\d{6}$

Headers

idempotency-key

string

length ≤ 128

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Default Response

401Authentication required

403Forbidden — no org / role / KYB

422Validation error or business-rule violation