multipart/form-data
with a stringified JSON payload under the transaction
field.
{{baseURL}}/v1/payout
Header | Value | Required |
---|---|---|
x-api-key | YOUR_API_KEY | ✅ Yes |
Header | Value Example | Description |
---|---|---|
x-api-key | API_KEY | API authentication key |
Parameter | Type | Description |
---|---|---|
transaction | JSON | Stringified JSON transaction payload |
Field | Type | Description |
---|---|---|
quoteId | String | Quote ID from FX pricing |
transactionPin | String | 6-digit security PIN |
remark | String | Internal reference note |
reason | String | Transaction purpose |
Field | Type | Description |
---|---|---|
name | String | Legal business name |
firstName | String | Contact first name |
idType | String | ID type (ID_CARD ) |
idNumber | String | Government-issued ID |
mobileNumber | String | Contact number with country code |
relationship | String | Recipient relationship (EMPLOYEE ) |
type | String | Entity type (BUSINESS ) |
invoiceNo | String | Business invoice reference (optional) |
paymentChannel | String | Payment method (BANK_TRANSFER ) |
currency | String | Transaction currency (CNY ) |
country | String | Country code (CN ) |
stored | Boolean | Save recipient details |
Field | Type | Description |
---|---|---|
name | String | Account holder name |
accountNumber | String | Corporate bank account number |
type | String | Account type (INDIVIDUAL ) |
Status Code | Meaning | Example Response | How to Handle |
---|---|---|---|
400 | Invalid Bank Details | Invalid sort code for bank | Verify bank routing information |
400 | ID Validation Failed | Invalid business registration ID | Check government-issued ID |
400 | Invalid Transaction PIN | Invalid transaction authorization | Verify 6-digit PIN |
400 | Business Info Mismatch | Account name mismatch with registration | Ensure names match official records |