Create Paydesk Order

• Collection (cashier) aggregates all available payment methods.

HTTP Request

API EndPoint

POST baseUrl + /api/payDesk

Request Parameters

Parameter	Required	Type	Description	Example
mobileMoneyPhone	Y	string(32)	Mobile Wallet Number	721323213
currency	Y	string(32)	Currency code(TZS)	TZS
amount	Y	decimal(20,0)	Integer, amount 500-5000000	1000
reusableStatus	Y	boolean	（false=Not allowed true=allow）	false
mchOrderNo	Y	string(32)	Merchant order number	1386556787811426305
expireTime	Y	long	Expiration time, default 3600 seconds	3600
notifyUrl	Y	string(250)	webhooks (callback) address	https://merchant.com/webhooks
nonceStr	Y	string(32)	Random string	1863484722378907648
realName	Y	string(32)	Payer NameMaximum length is 64 characters	Jeck
phone	Y	string(32)	Payer phonenumber	255xxxxxxx
email	Y	string(64)	Payer email	example@maildomain.com
idType	N	pls refer toPayin Payer ID Type	Payer ID number	Payer ID type
idCard	N	string(32)	idCard Number
returnUrl	N	string(250)	Product subject	https://merchant.com/jump
remark	Y	string(32)	Order remarks

Request Example

curl -L 'baseUrl/api/payDesk' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"nonceStr":"1733129817080","currency":"PHP","amount":1064800,"reusableStatus":false,"mchOrderNo":"1313066365288624128","expireTime":28982,"notifyUrl":"https://merchant.com/payIn/callback","remark":"payin order","realName":"HAMZAN WADI  ","phone":"87761734941","idType":"1","idCard":"5203092009900005"}'

Response Parameters

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

Response Example

{
  "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"
  }
}

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)	1386556787811426305	Merchant order number
orderNo	N	string(32)	PAYDESKxxxxxxxxxx	Platform order number
nonceStr	Y	string(32)	1863484722378907648	Random string

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
  }
}

PayDesk Order Query

API EndPoint

POST baseUrl + /api/payDeskQuery

Request Parameters

Parameter	Required	Type	Example	Description
mchOrderNo	N	string(32)	1386556787811426305	Merchant order number
orderNo	N	string(32)	PAYIN8551844049125523456	Platform order number
nonceStr	Y	string(32)	1863484722378907648	Random string

TIP

We recommend using orderNo (platform order number) first. At least one of the platform order number and the Merchant order number must be passed.

Request Example

curl -L 'baseUrl/api/payDeskQuery' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d ' {"mchOrderNo":"202411301909131862936942783582208","nonceStr":"1138688daof9gnay3dt9j4wktxt1z99ww"}'

Response Parameters

Parameter	Type	Description
merchantId	int	Merchant id
mchOrderNo	string(32)	Merchant order number
orderNo	string(32)	Platform order number
amount	decimal(20,0)	Amount
fee	decimal(20,4)	Fee
orderStatus	string(32)	Payin Order Status Enum
completionTime	yyyy-MM-dd HH:mm:ss	Completion time
payCode	string(32)	Payment account VA
payUrl	string(250)	Payment QR code, some ways have QR code ,like QRIS
payDeskUrl	string(250)	Payment Url

Response Example

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "3002112",
    "mchOrderNo": "202411301909131862936942783582208",
    "orderNo": "PAYDESK39568551277959484616704",
    "payUrl": "https://idpaydesk2.brcashypro.com/index.html?PAYDESK39568551277959484616704",
    "amount": "1000000",
    "fee": "0",
    "orderStatus": "PAYING",
    "completionTime": null,
    "nonceStr": null
  }
}

Async Webhook Notification

The webhooks url is provided by the merchant

POST Merchant NotifyUrl

Webhook Request Parameters

Parameter	Type	Description
mchOrderNo	string(32)	Merchant order number
orderNo	string(32)	Platform order number
amount	decimal(20,2)	Amount
fee	decimal(20,4)	Fee
payUrl	string(250)	Payment QR code, some ways have QR code ,like QRIS
orderStatus	string(32)	Payin Order Status Enum
completionTime	yyyy-MM-dd HH:mm:ss	Completion time
nonceStr	string(32)	Random string

Webhook Request Example

curl -L 'merchant.com/webhooks/paydesk' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"amount":358320.00,"completionTime":"2024-12-02 12:07:06","fee":2500.0000,"mchOrderNo":"1313068703462109184","merchantId":"1002001","nonceStr":"1733116026894","orderNo":"PAYDESK27618551850988355260416","orderStatus":"SUCCESS","payCode":"OR.GPNQR..INOPROID_BS","payType":"41","payUrl":"https://payurl.com"}'

Webhooks-Success

{
  "amount": 358320.0,
  "completionTime": "2024-12-02 16:08:32",
  "fee": 9083.0,
  "mchOrderNo": "1313068703462109184",
  "merchantId": "1002001",
  "nonceStr": "1733130512894",
  "orderNo": "PAYDESK27618551850988355260416",
  "orderStatus": "SUCCESS",
  "payUrl": "https://idpaydesk2.brcashypro.com/index.html?PAYDESK27618551850988355260416"
}

Webhooks-Fail

{
  "amount": 358320.0,
  "completionTime": "2024-12-02 16:08:32",
  "fee": 9083.0,
  "mchOrderNo": "1313068703462109184",
  "merchantId": "1002001",
  "nonceStr": "1733130512894",
  "orderNo": "PAYDESK27618551850988355260416",
  "orderStatus": "FAIL",
  "payUrl": "https://idpaydesk2.brcashypro.com/index.html?PAYDESK27618551850988355260416"
}

TIP

When the webhooks response HTTP status code is 200, 301 or 302, we believe that the merchant has successfully received and processed the callback. For other statuses, we believe that the merchant has failed to process the callback.

After the webhooks fails, it will be retried in 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 minutes, and the webhooks will be retried 10 times in total