Skip to main content

Create

Create payout

POST/api/v1/payment/createOrder

Submit a payout order to transfer funds to a payee account.

Bodyapplication/x-www-form-urlencoded

orderTypestringrequiredsign

Payout type. See the payout type reference for full details.

Value BANK
Discriminator
Order information
memberidstringrequiredsign

Merchant ID assigned by the platform.

out_trade_nostringrequiredsign

Unique payout order ID generated by the merchant.

amountstring, two decimal placesrequiredsign

Payout amount.

currencystringrequiredsign

Currency code (e.g., USD, JPY, GBP, EUR, AUD, HKD, CAD, MXNUSDT, USDC).

notifyurlstringrequiredsign

Webhook URL notified when the payout completes. See Payout webhook.

remarkstring, minimum 4 charactersrequiredsign

Payout remark. Cannot be empty.

signstringrequired
Payee information
firstnamestringrequiredsign

Payee first name.

lastnamestringsign

Payee last name. Required for ach, Visa Direct, or local bank payouts in some countries. Omit from signing when blank.

payeeCountrystringrequiredsign

Payee country code(ISO 3166-1 alpha-2). Required for ach, Cash App, or local bank payouts.

Bank information
payeeaccountstringrequiredsign

Bank card number or wallet account number.

bankcodestringrequiredsign

Local bank code. See payout bank codes.

banknamestringrequiredsign

Bank name of the payout account.(The value is Short code when the country is VN)

Response

transaction_idstring

Platform transaction ID.

statusstring

Request result: success or error.

msgstring

Result message.