Create payout order

post

https://prod.wavepool.global/open-api/v1/payout/create

Initiates a payout order to a registered payee. For cross-currency payments, the system will handle the conversion based on the specified payment and payee amounts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

callId

string

required

A client-provided unique string used to ensure idempotency and prevent duplicate processing of the same request.

payeeId

string

required

Payee's unique registered identifier for fund transfers.

receiveType

string

enum

required

Payee Receivable Type

Allowed:

paymentCurrency

string

enum

required

Payment currency

payeeCurrency

string

enum

required

Payee currency

paymentAmount

number

required

Payment Amount

payeeAmount

number

required

Payee Amount

reason

string

Note

paymentMaterial

array of strings

Payment Proof Material File ID Array

paymentMaterial

purpose

string

enum

👉 Payment Purpose Codes Guide

Headers

dgp-entity-id

string

required

The unique identifier of the target entity. Mandatory for white-label customers to define the sub-entity context.

Response

Language

URL

Loading…

Response

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

application/json

200