Create Payout Order
HTTP Request
TIP
POST baseUrl + /api/payOut
Request Headers
| HeaderName | Required | Value |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
RequestBody
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
accountName | Y | string(32) | Brandme | Beneficiary Name |
accountNo | Y | string(32) | 646180000000000007 | Beneficiary Account |
accountType | Y | int | pls refer toPayout Account Type | Beneficiary Account Type |
currency | Y | string(32) | COP | Currency code |
amount | Y | decimal(20,2) | 10000 | Amount 10000-5000000 |
bankId | Y | int | pls refer topayout-bank-list-query | Bank id ） |
mchOrderNo | Y | string(32) | P123456 | Merchant order number |
notifyUrl | Y | string(250) | http://abc.com/ | webhooks (callback) address |
nonceStr | Y | string(32) | 16283812xxxx | Random string |
idType | Y | string(32) | pls refer toPayout Payee ID Type | Payout Payee ID Type |
idCard | Y | string(32) | Beneficiary ID number | |
phone | N | string(32) | +52xxxxxxx | Beneficiary phonenumber |
email | N | string(32) | xyz@gamil.com | Beneficiary email |
remark | Y | string(32) | remark | Order remarks |
TIP
Note that callback/webhook addresses only support https or http protocol addresses. If the address is an ip address, be sure to use a public domain name.
TIP
关于idType字段，请以收款银行账户开设时使用的实际证件类型为准，不一致会导致代付失败。
举例：如果用户开户使用的是NIT证件，发起代付是透传的证件类型为CC, 此时会导致代付失败。
ResponseBody
| Parameter | 类型 | Description |
|---|---|---|
merchantId | int | MerchantId |
mchOrderNo | string(32) | Merchant order number |
orderNo | string(32) | Platform order number |
| amount | decimal(20,2) | Amount |
| fee | decimal(20,2) | fee |
orderStatus | string | 订单状态，pls refer toPayout Order Status Enum |
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "M1656907083234",
"orderNo": "PAYOUT8232147367892025344",
"amount": 100,
"fee": 0,
"orderStatus": "PROCESSING"
}
}Query Payout Order
HTTP Request
TIP
POST baseUrl + /api/payOutQuery
Request Headers
| HeaderName | Required | Value |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
RequestBody
| Parameter | Required | Type | Example | Description |
|---|---|---|---|---|
mchOrderNo | N | string(32) | P123456 | Merchant order number |
orderNo | N | string(32) | PAYIN12345 | Platform order number |
nonceStr | Y | string(32) | 1628381288000 | Random string |
TIP
We recommend using orderNo (platform order number) first. At least one of the platform order number and merchant order number needs to be passed.
ResponseBody
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "M1656756338536",
"orderNo": "PAYOUT8231515112790892544",
"amount": 100.0,
"fee": null,
"orderStatus": "PAYING",
"completionTime": null,
"resultDesc": "SUCCESS"
}
}| Parameter | Type | Description |
|---|---|---|
merchantId | int | MerchantId |
mchOrderNo | string(32) | Merchant order number |
orderNo | string(32) | Platform order number |
channelOrderNo | string(32) | Channel order number |
amount | decimal(20,2) | Amount |
fee | decimal(20,2) | fee |
orderStatus | string(32) | Order Statuspls refer toPayout Order Status Enum |
completionTime | date | Completion time yyyy-MM-dd HH:mm:ss |
resultDesc | string(64) | Order Status,pls refer toOrder Status Description |
Async Webhook Notification
HTTP Request
TIP
POST : notifyUrlnotifyUrlis provided by the merchant
Request Headers
| HeaderName | Required | Value |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
Webhook RequestBody
{
"orderStatus": "SUCCESS",
"amount": 100.0,
"fee": 0,
"mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
"merchantId": "100001",
"orderNo": "PAYOUT8388679728902370944",
"completionTime": "2022-08-08 08:08:08",
"resultDesc": "SUCCESS"
}| Parameter | Type | Description |
|---|---|---|
merchantId | int | MerchantId |
mchOrderNo | string(32) | Merchant order number |
orderNo | string(32) | Platform order number |
channelOrderNo | string(32) | Channel order number |
amount | decimal(20,2) | Amount |
fee | decimal(20,4) | fee |
orderStatus | string(32) | pls refer toPayout Order Status |
resultDesc | string(64) | pls refer toOrder Status Description |
completionTime | date | Complete time |
TIP
fee and completionTime only have a value if the order is successfully paid.
TIP
Please respond with SUCCESS if the process is successful. For other responses, we will consider the callback to have failed. After the callback fails, it will be retried in 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 minutes, and the callback will be retried 10 times in total.