Transfer with Custom Payee
API Information
- Path:
/api/v2/txn/remittance - Method: POST
- Content-Type: application/json
Business Description
- Supports two modes: specifying sourceAmount(payment amount) and targetAmount(expected arrival amount)
- When specifying payment amount, the expected arrival amount is the payment amount minus fees
- When specifying expected arrival amount, the payment amount is the expected arrival amount plus fees
- Supports filling in payer details when initiating payment
- This interface currently has usage restrictions, please contact us before use
Request Parameters
Headers
Request Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| Content-Type | application/json | Yes | Request body type |
Request Body
Main Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| merchantNo | string | Merchant Number | M |
| payerId | integer | Payer ID | C |
| payerDetail | string | Payer information (Note: choose either payerId or payerDetail) | C |
| sourceAmount | number | Source Amount | C, Required when chargeFlag is N |
| sourceCurrency | string | Source Currency | M |
| targetAmount | number | Target Amount | C, Required when chargeFlag is Y |
| targetCurrency | string | Target Currency | M |
| requestId | string(32) | Business transaction ID, filled by merchant, must be unique for each payment | M |
| reference | string(256) | Payment Reference | C |
| transactionPurpose | string(64) | Transaction Purpose | M |
| chargeFlag | string | Full Amount Arrival | M |
| bankCountry | string(12) | Submit payment Country | M |
| payoutCurrency | string(128) | Payout Currency | M |
| entityType | string(1) | Entity Type [0:Company, 1:Individual] | M |
| paymentMethod | string | Payment Method | M |
| receiverInfo | string(1024) | Payee Information | M |
| address | string(1024) | Address Information | M |
| accountInfomation | string(1024) | Account information | M |
| sign | string | Signature | M |
Request Example
json
{
"merchantNo": "801022",
"payerId":1953712585351499776,
"payerDetail":"{\"createTime\":\"2025-08-16 14:21:57\",\"merchantNo\":\"801040\",\"country\":\"CN\",\"addressEn1\":\"Nanshan Science & Technology Park, Shenzhen\",\"addressEn2\":\"2all\",\"addressEn3\":\"3\",\"postcode\":\"518057\",\"status\":0,\"email\":\"1@qq.com\",\"areaCode\":\"+86\",\"phoneNumber\":\"15072871023\",\"state\":\"hubei\",\"city\":\"wuhan\",\"subEntityType\":\"1\",\"firstName\":\"zhang\",\"lastName\":\"san2\",\"idType\":\"0\",\"idNumber\":\"371328198410044019\",\"birthDate\":\"1984-10-04\",\"idValidDateFrom\":\"2016-08-04\",\"idValidDateTo\":\"2026-08-04\"}",
"sourceAmount": 113.00,
"sourceCurrency": "USD",
"targetAmount": 1901.00,
"targetCurrency": "PKR",
"requestId": "DM2025081120520",
"reference": "REFERENCE PAYPAL",
"transactionPurpose": "4",
"chargeFlag": "Y",
"bankCountry": "US",
"payoutCurrency": "USD",
"entityType": "1",
"paymentMethod": "BANK_TRANSFER",
"receiverInfo": "{\"nickName\":\"USTEST12\",\"companyName\":\"\",\"lastName\":\"USDMDD\",\"firstName\":\"DAN\",\"areaCode\":\"\",\"phone\":\"\",\"email\":\"hynchen@onerway.com\",\"identityType\":\"SSN\"}",
"address": "{\"countryCode\":null,\"state\":\"CALIFORNIA\",\"city\":\"Adin\",\"addressLine1\":\"ADRESS TEST 1\",\"addressLine2\":null,\"addressLine3\":null,\"postalCode\":\"890890\"}",
"accountInfomation": "{\"cardNumber\":\"3890601780555\",\"accountType\":\"1\",\"swiftCode\":\"ABOCUS33\", \"bankName\":\"MCB BankLimited\",\"sortCode\": \"021001088\", \"bankAccount\": \"AGRICULTURAL BANK OF CHINA NEW YORK BRANCH\"}",
"sign": "d2ea92efff636320122021f65b613201403f6d34334cfbc7e589ce9f842988f7"
}Response Result
Response Headers
| Parameter | Value | Required | Description |
|---|---|---|---|
| content-type | application/json;charset=UTF-8 | Yes | Response body type |
Response Parameters
Response Fields
| Parameter | Type | Description |
|---|---|---|
| respCode | string | Response Code |
| respMsg | string | Response Message |
| data | object | Response Data |
| └─merchantNo | integer | Merchant Number |
| └─payoutId | integer | Payment Transaction ID |
| └─status | string | Status |
| └─requestId | string | Payment Transaction ID |
Response Example
json
{
"respCode": "20000",
"respMsg": null,
"data": {
"merchantNo": "801022",
"payoutId": "1967418277869780992",
"status": "A",
"requestId": "DM2025081120520"
}
}