Skip to content

Create Payin Order

代收(收银台)聚合了所有开通的支付方式

HTTP Request

TIP

POST baseUrl + /api/payDesk

Request Headers

HeaderNameRequiredValue
Content-TypeYapplication/json
MerchantIdYMerchantId
SignYSign

RequestBody

ParameterRequiredTypeExampleDescription
currencyYstring(32)IDRCurrency code
amountYdecimal(20,0)10000Amount ,Min Amount 10000
reusableStatusYbooleanfalseCurrently it can only be false
mchOrderNoYstring(32)mch12345Merchant order number (should be unique in the merchant system)
expireTimeYlong3600Expiration time, default 3600 seconds
notifyUrlYstring(250)https://acb.com/webhooks (callback) address
nonceStrYstring(32)162838128Random string
remarkYstring(32)remarkOrder remarks
realNameYstring(32)JackPayer Name
phoneNstring(32)62xxxxxxxPayer phonenumber
emailNstring(32)xyz@gamil.comPayer email
goodsSubjectNstring(32)appleProduct subject
goodsBodyNstring(32)appleProduct description

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.

ResponseBody

JSON 示例

json
{
  "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"
  }
}
ParameterTypeDescription
merchantIdlongMerchantId
mchOrderNostring(32)Merchant order number
orderNostring(32)Platform order number
amountdecimal(20,0)Amount
orderFeedecimal(20,0)fee
payCodestring(32)Payment account VA
payUrlstring(250)Payment QR code, some ways have QR code ,like QRIS
payDeskUrlstring(250)Payment Url

PayDesk Order Query

HTTP Request

TIP

POST baseUrl + /api/payDeskQuery

Request Headers

HeaderNameRequiredValue
Content-TypeYapplication/json
MerchantIdYMerchantId
SignYSign

RequestBody

ParameterRequiredTypeExampleDescription
mchOrderNoNstring(32)P123456Merchant order number
orderNoNstring(32)PAYIN12345Platform order number
nonceStrYstring(32)1628381288000Random string

TIP

We recommend using orderNo (platform order number) first. At least one of the platform order number and the merchant order number needs to be passed.

ResponseBody

json
{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "100001",
    "mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
    "orderNo": "PAYDESKxxxxxxxxxx",
    "payUrl": "http://paydesk.testpage.com/PAYDESKxxxxxxxxxx",
    "amount": 10000.0,
    "fee": 0,
    "orderStatus": "PAYING",
    "completionTime": null
  }
}
ParameterTypeDescription
merchantIdintMerchantId
mchOrderNostring(32)Merchant order number
orderNostring(32)Platform order number
payUrlstring(250)Payment QrCode , like QRIS
amountdecimal(20,0)Amount
feedecimal(20,4)fee
orderStatusstring(32)Order StatusPayin Order Status Enum
completionTimedateCompletion time

TIP

fee and completionTime only have a value if the order is successfully paid. The format of completionTime is yyyy-MM-dd HH:mm:ss.

Paydesk Order Async Webhook Notification

HTTP Request

TIP

POST 商户提交订单的回调地址 notifyUrl

Request Headers

HeaderNameRequiredValue
Content-TypeYapplication/json
MerchantIdYMerchantId
SignYSign

Async Webhook Notification

json
{
  "orderStatus": "SUCCESS",
  "amount": 10000.0,
  "fee": 0,
  "mchOrderNo": "2a6421c4-3758-4d1a-b47e-f7d0e7133f9e",
  "merchantId": "100001",
  "orderNo": "PAYDESKxxxxxxxxxxx",
  "payUrl": "xxxxxxxxxxxx",
  "completionTime": "2022-08-08 08:08:08",
  "nonceStr": "xxxxxxxxxx"
}
ParameterTypeDescription
merchantIdintMerchantId
mchOrderNostring(32)Merchant order number
orderNostring(32)Platform order number
payUrlstring(250)Payment QrCode , like QRIS
amountdecimal(20,0)Amount
feedecimal(20,4)fee
orderStatusstring(32)Order StatusPayin Order Status Enum
completionTimedateCompletion time

TIP

fee and completionTime only have a value if the order is successfully paid. The format of completionTime is yyyy-MM-dd HH:mm:ss.

TIP

Please respond with SUCCESS if the process is successful, otherwise we will consider the callback to have failed. After the callback fails, it will be in 1,2,4,8,16,32,64,128,256,512 minutes Retry, retry the callback 10 times in total.

Released under the MIT License.