Withdraw Request
Request
API URL: /merchant/withdraw
Note
✅ Required ⭕ Optional ❌ Not used
Header | Content | Description |
---|---|---|
Content-Type | text/plain | |
Authorization | {token_type} {access_token} | Concat token_type and access_token with whitespace. |
Param | Type | Required | Sign | Description |
---|---|---|---|---|
user_id | String | ✅ | ✅ | Merchant identification |
order_id | String | ✅ | ✅ | Withdraw order Id of merchant system. The order id should be unique. |
amount | String | ✅ | ✅ | Transaction amount (Support up to 6 decimal places) |
currency | String | ✅ | ✅ | Please refer to Currencies & Channels. |
channel | String | ✅ | ✅ | Please refer to Currencies & Channels. |
card_no | String | ✅ | ✅ | Withdraw card number.If your channel is running virtual currency, then put the wallet address here. |
card_name | String | ✅ | ✅ | Card (Virtual wallet) owner's name. |
card_type | Integer | ✅ | ✅ | 1 = private 2 = public. |
bank_code | String | ✅ | ✅ | Please Refer to Banks. |
bank_name | String | ✅ | ✅ | Please Refer to Banks. |
bank_branch | String | ✅ | ✅ | Bank branch(Limited length: 20, a Chinese word length is 2). |
bank_province | String | ✅ | ✅ | Bank province(Limited length: 20, a Chinese word length is 2). |
bank_city | String | ✅ | ✅ | Bank city(Limited length: 20, a Chinese word length is 2). |
cnaps_code | String | ✅ | ✅ | Bank lines. REQUIRED when card_type = 2. |
String | ✅ | ❌ | Validate email format. | |
phone | String | ✅ | ❌ | Validate phone number format, ex: 09123456789. |
first_name | String | ⭕ | ❌ | Client's first name, cannot contain numbers, if channel = GCASH_API, this field is required. |
middle_name | String | ⭕ | ❌ | Client's middle name, cannot contain numbers, this could empty string, if channel = GCASH_API, this field is required. |
last_name | String | ⭕ | ❌ | Client's last name, cannot contain numbers, if channel = GCASH_API, this field is required. |
callback_url | URL | ✅ | ✅ | Service will send a callback request to this URL when the transaction completes. |
timestamp | Integer | ✅ | ✅ | Request timestamp (10 digits). |
remark | String | ⭕ | ❌ | Remark. |
sign | String | ✅ | ❌ | Signature string. |
Response
Param | Type | Required | Sign | Description |
---|---|---|---|---|
user_id | String | ✅ | ✅ | Merchant identification |
order_id | String | ✅ | ✅ | Withdraw order Id of merchant system. The order id should be unique. |
transaction_id | String | ✅ | ✅ | PTS withdraw transaction id |
channel | String | ✅ | ✅ | Supported channels please refer Currencies & Channels |
submit_currency | String | ✅ | ✅ | Submit currency |
submit_amount | Float | ✅ | ✅ | Submit amount (Support up to 6 decimal places) |
accept_currency | String | ✅ | ✅ | The currency real paid |
accept_amount | Float | ✅ | ✅ | Paid amount of accept currency (Support up to 6 decimal places) |
exchange_rate | Float | ✅ | ✅ | Exchange rate |
sign | String | ✅ | ❌ | Signature string |
Response Example
{
"code": "1000",
"message": "Accepted",
"data": {
"user_id": "1",
"order_id": "20210521181858",
"transaction_id": "W12021052118190115910",
"channel": "CNY2ERC",
"submit_currency": "CNY",
"submit_amount": 40000,
"accept_currency": "USDT-ERC",
"accept_amount": 6644,
"exchange_rate": 0.1661,
"sign": "hZJiccj0EPEQkoOlsmkRWEzHZ+dvbgD8t2RyNzL..."
}
}