Create Paydesk Order
- 代收（收银台）
聚合了所有开通的支付方式
HTTP Request
TIP
POST baseUrl + /api/payDesk
Request Headers
| HeaderName | Required | Value |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
RequestBody
| 参数名 | 必选 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|---|
mobileMoneyPhone | Y | string(32) | 721323213 | Mobile Wallet Number |
currency | Y | string(32) | TZS | Currency code(TZS) |
amount | Y | decimal(20,0) | 1000 | Integer, amount 500-5000000 |
reusableStatus | Y | boolean | false | （false=不允许 true=允许）目前只能是false |
mchOrderNo | Y | string(32) | P123456 | Merchant order number |
expireTime | Y | long | 3600 | Expiration time, default 3600 seconds |
notifyUrl | Y | string(250) | http://abc.com/ | webhooks (callback) address |
nonceStr | Y | string(32) | 1628381288000 | Random string |
realName | Y | string(32) | Jeck | Payer NameMaximum length is 64 characters |
phone | Y | string(32) | 255xxxxxxx | Payer phonenumber |
email | Y | string(64) | example@maildomain.com | Payer email |
idType | N | pls refer toPayin Payer ID Type | Payer ID type | |
idCard | N | string(32) | Payer ID number | |
returnUrl | N | string(250) | http://abc.com/ | 同步跳转地址 |
goodsSubject | N | string(32) | apple | Product subject |
goodsBody | N | string(32) | apple | Product description |
remark | Y | string(32) | remark | Order remarks |
TIP
注意回调/同步跳转地址仅支持https或者http协议的地址，如果地址是ip地址，请务必使用公网域名。
ResponseBodyDescription
{
"msg": "SUCCESS",
"code": 200,
"data": {
"merchantId": "100001",
"mchOrderNo": "M165690800000001",
"orderNo": "PAYDESKxxxxxxxxxxxxxxxxxx",
"payUrl": "http://paydesk.testpage.com/PAYDESKxxxxxxxxxxxxxxx",
"amount": "100000",
"expireTime": "2022-12-06 17:48:40"
}
}| Parameter | Type | Description |
|---|---|---|
merchantId | int | MerchantId |
mchOrderNo | string(32) | Merchant order number |
orderNo | string(32) | Platform order number |
amount | decimal(20,2) | Amount |
payUrl | string(250) | Payment Url |
expireTime | date | expire time |
Paydesk Order Query
HTTP Request
TIP
POST baseUrl + /api/payDeskQuery
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) | PAYDESKxxxxxxxxxx | Platform order number |
nonceStr | Y | string(32) | 1628381288000 | Random string |
TIP
We recommend prioritizing the use of orderNo (platform order number), and 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": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
"orderNo": "PAYDESKxxxxxxxxxx",
"payType": 154,
"payUrl": "http://paydesk.testpage.com/PAYDESKxxxxxxxxxx",
"amount": 10000.0,
"fee": 0,
"orderStatus": "PAYING",
"completionTime": null
}
}| Parameter | Type | Description |
|---|---|---|
merchantId | int | MerchantId |
mchOrderNo | string(32) | Merchant order number |
orderNo | string(32) | Platform order number |
payType | int | Payment Product Type,pls refer topayin-paytype-enum |
payUrl | string(250) | Patment Url |
amount | decimal(20,2) | Amount |
fee | decimal(20,4) | fee |
orderStatus | string(32) | Order StatusPaydesk Order Status Enum |
completionTime | date | Complete time |
TIP
fee and completionTime have Value only when the order is successfully paid. completionTime has the format yyyy-MM-dd HH:mm:ss.
TIP
payType only has a value if the order was successfully paid.
Paydesk Order Async Webhook Notification
HTTP Request
TIP
POST Callback address notifyUrl for merchants to submit orders
Request Headers
| HeaderName | Required | Value |
|---|---|---|
Content-Type | Y | application/json |
MerchantId | Y | MerchantId |
Sign | Y | Sign |
Async Webhook Notification
{
"orderStatus": "SUCCESS",
"amount": 10000.0,
"fee": 0,
"mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
"merchantId": "100001",
"payType": 154,
"orderNo": "PAYDESKxxxxxxxxxxx",
"payUrl": "http://paydesk.testpage.com/PAYDESKxxxxxxxxxx",
"completionTime": "2022-08-08 08:08:08",
"nonceStr": "xxxxxxxxxx"
}| Parameter | Type | Description |
|---|---|---|
merchantId | int | MerchantId |
mchOrderNo | string(32) | Merchant order number |
orderNo | string(32) | Platform order number |
payType | int | Payment Product Type,pls refer topayin-paytype-enum |
amount | decimal(20,2) | Amount |
fee | decimal(20,4) | fee |
payUrl | string(32) | Payment Url |
orderStatus | string(32) | Order StatusPaydesk Order Status Enum |
completionTime | date | Complete time |
nonceStr | string(32) | Random string |
TIP
fee and completionTime have Value only when the order is successfully paid. completionTime has the format yyyy-MM-dd HH:mm:ss.
TIP
Please respond SUCCESS for successful processing, otherwise we will consider the callback failed. If 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.