代付/提现接口
发起代付/提现
发起提现请求。以下情况会导致接口调用失败，请注意接口返回的错误消息
- 若提现金额超过商户设置的最低与最高提现限制(提现范围限制请参见商户后台，提现手续费请咨询客服)，将返回『提现金额超出限制』
- 若代付提交的收款银行卡有误，如卡号无效，接口将返回『无效卡号……』，请务必将此错误消息返回给下游展示，以便客服第一时间知晓提现失败原因
- 若是支付宝下发，请填写支付账户相关的信息即可，即将银行设置为『支付宝』，『开户行』留空，『账号』填写支付宝的手机号或邮箱即可
- 请求方法：POST
- 接口路径：http://接口域名/api/v1/mch/wdl-orders
- 请求参数：
| 参数名 | 越南 | 泰国 | 巴西 | 印度 | 菲律宾 | 说明 |
|---|---|---|---|---|---|---|
| mch_id | ✅ | ✅ | ✅ | ✅ | ✅ | 商户 ID，请在商户后台配置中查看 |
| trans_id | ✅ | ✅ | ✅ | ✅ | ✅ | 商户交易 ID，由商户提供 |
| channel | ✅ | ✅ | ✅ | ✅ | ✅ | 通道代码，对接测试使用 mock。其他各国通道代码参见系统通道代码 |
| amount | ✅ | ✅ | ✅ | ✅ | ✅ | 订单金额，法币标准单位。⚠️：使用字符串传递，比如 100.00，传递 "100.00" |
| currency | ✅ | ✅ | ✅ | ✅ | ✅ | 币种代码，参见系统货币代码 |
| account_no | ✅ | ✅ | ✅ | ✅ | ✅ | 收款账号或数字钱包账号/地址，GCASH 使用手机号 |
| account_name | ✅ | ✅ | ✅ | ✅ | ✅ | 收款账户姓名 |
| account_org | ✅ | ✅ | ✅ | ✅ | ⭕️ | 收款银行名称(越南银行参见附录中的银行名称) |
| account_org_code | ✅ | ✅ | ⭕️ | ⭕️ | ⭕️ | 收款银行代码(越南银行参见附录中的银行代码，印度银行使用 IFSC) |
| account_sub_org | ⭕️ | ⭕️ | ⭕️ | ⭕️ | ⭕️ | 开户行 |
| account_type | ⭕️ | ⭕️ | ✅ | ⭕️ | ⭕️ | 账户类型，巴西使用：CPF, CNPJ, PHONE, EMAIL, EVP |
| account_tin | ⭕️ | ⭕️ | ✅ | ⭕️ | ⭕️ | 账户税号，巴西使用：CPF 或 CNPJ 号 |
| account_phone | ⭕️ | ⭕️ | ✅ | ⭕️ | ⭕️ | 账户手机，巴西的 account_type 如果是 PHONE，此参数必填 |
| account_email | ⭕️ | ⭕️ | ✅ | ⭕️ | ⭕️ | 账户邮箱，巴西的 account_type 如果是 EMAIL，此参数必填 |
| callback_url | ✅ | ✅ | ✅ | ✅ | ✅ | 回调 URL，用于通知代付结果 |
| nonce | ✅ | ✅ | ✅ | ✅ | ✅ | 随机字符串，至少 6 位 |
| timestamp | ✅ | ✅ | ✅ | ✅ | ✅ | UNIX 时间戳，10 位 |
| sign | ✅ | ✅ | ✅ | ✅ | ✅ | 参数签名。参见签名算法 |
- 返回结果：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | string | 平台唯一订单 ID |
| mch_id | string | 商户 ID |
| trans_id | string | 交易 ID |
| channel | string | 通道代码 |
| order_amount | number | 订单金额 |
| currency | string | 币种 |
| account_name | string | 收款姓名 |
| account_no | string | 收款账号 |
| account_org | string | 收款银行名称 |
| account_org_code | string | 收款银行代码 |
| account_sub_org | string | (选填)开户行 |
| created_at | string | 下单时间 |
| status | string | 订单状态，50 表示取消或驳回，60 表示成功，10，20 表示正在处理中 |
响应示例：
json
{
"code": 200,
"payload": {
"id": "WT1729187424AJCT",
"trans_id": "2019uZP8KImVd2Xbzae",
"mch_id": "8888",
"channel": "bank",
"order_amount": 100,
"account_no": "2333667799212341",
"account_name": "Nguyễn Xuân Hưng",
"account_org": "PVCOMOBANK",
"account_org_code": "970425",
"account_suborg": "Ho Chi Minh City",
"account_email": "[email protected]",
"account_tel_no": "+969839182913",
"currency": "VND",
"attatch": "withdrawal",
"created_at": "2019-04-12 14:12:31",
"status": 20
}
}支付成功后，系统会向平台发送通知，查看代付回调说明。
代付/提现查询
提现状态查询。
- 请求方法：GET
- 接口路径：http://接口域名/api/v1/mch/wdl-orders
- 请求示例：http://接口域名/api/v1/mch/wdl-orders?id=订单号&mch_id=商户号&sign=参数签名
- 请求参数：
| 参数名 | 必填 | 说明 |
|---|---|---|
| id | ✅ | 订单 ID 或交易 ID。请注意，此参数也要参与签名 |
| mch_id | ✅ | 商户 ID，请在商户后台配置中查看 |
| nonce | ✅ | 随机字符串，至少 6 位 |
| timestamp | ✅ | UNIX 时间戳，10 位 |
| sign | ✅ | 参数签名。参见签名算法 |
- 返回结果：
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | string | 平台唯一订单 ID |
| mch_id | string | 商户 ID |
| trans_id | string | 交易 ID |
| order_amount | number | 订单金额 |
| currency | string | 币种，默认为人民币(cny) |
| account_name | string | 收款姓名 |
| account_no | string | 收款账号 |
| account_org | string | 收款银行名称 |
| account_org_code | string | 收款银行代码 |
| account_suborg | string | 开户行 |
| attachments | string | 代付凭证文件，字符串数组 |
| created_at | string | 提现时间 |
| status | number | 订单状态，50 表示取消或驳回，60 表示成功，其他表示正在处理中 |
- 响应示例
json
{
"code": 200,
"payload": {
"id": "WOu154sgKfZB",
"trans_id": "2019uZP8KImVd2Xbzae",
"mch_id": "8888",
"channel": "bank",
"order_amount": 100,
"account_no": "2333667799212341",
"account_name": "Nguyễn Xuân Hưng",
"account_org": "PVCOMOBANK",
"account_org_code": "970425",
"account_email": "[email protected]",
"account_tel_no": "+969839182913",
"currency": "VND",
"attachments": [],
"created_at": "2019-04-12 14:12:31",
"status": 10
}
}