Cashy Docs Center

Create Payin Order

API EndPoint

POST baseUrl + /api/payIn

Request Parameters

Parameter	Required	Type	Description	Example
`currency`	`Y`	`string(32)`	Currency code	`USD`
`payType`	`Y`	`int`	Pay product type	Payin PayType Enum
`amount`	`Y`	`decimal(20,2)`	Amount	[1,500]
`reusableStatus`	`Y`	`boolean`	是否多次支付	目前只能是false
`mchOrderNo`	`Y`	`string(32)`	Merchant order number	不允许重复
`expireTime`	`Y`	`long`	expireTime	实际上游没有固定过期时间，Default: 3600 seconds `不一定有效,部分通道支持`
`notifyUrl`	`Y`	`string(250)`	webhooks (callback) address	`https://merchant.com/webhooks`
`nonceStr`	`Y`	`string(32)`	Random string	1863484722378907648
`remark`	`Y`	`string(32)`	Remark	Please use English characters or unaccented Spanish
`realName`	`Y`	`string(64)`	User name	请传递全名
`phone`	`Y`	`string(32)`	代收付款人手机号	请勿使用重复的手机号
`email`	`Y`	`string(64)`	代收付款人邮箱 ,	请勿使用重复的邮箱
`idType`	`Y`	`string(32)`	代收付款人证件类型	代收付款人证件类型
`idCard`	`Y`	`string(32)`	付款人证件号	(身份证1=CC 长度10位)

Request Example

bash

curl -L 'baseUrl/api/payIn' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"realName":"Reza Wijaya","amount":"20000.00","reusableStatus":false,"payType":"200","expireTime":3600,"mchOrderNo":"1386556787811426305","notifyUrl":"https://merchant.com/webhooks/payin","currency":"IDR","remark":"Electronic Cigarettes","nonceStr":"16a5a70f43384134bfae33acc77132e0"}'

Response Parameters

Parameter	Type	Description
`merchantId`	`long`	Merchant id
`mchOrderNo`	`string(32)`	Merchant order number
`orderNo`	`string(32)`	Platform order number
`amount`	`decimal(20,0)`	Amount
`orderFee`	`decimal(20,0)`	Fee
`payCode`	`string(32)`	payCode
`payUrl`	`string(250)`	Payment information display page/payment jump URL

Response Example

SuccessSome Error

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "1386556787811426305",
    "orderNo": "PAYIN8551844049125523456",
    "payCode": "RN123456",
    "payUrl": "https://gcash.com/pay?bizNo=20241202111212800110166154827",
    "biller": "Gcash",
    "amount": "20000",
    "orderFee": "1700"
  }
}

json

{
  "msg": "Payin_Order_Error",
  "code": 500
}

Query Payin Order

API EndPoint

POST baseUrl + /api/payInQuery

Request Parameters

Parameter	Required	Type	Example	Description
`mchOrderNo`	`N`	`string(32)`	1386556575370063873	Merchant order number
`orderNo`	`N`	`string(32)`	PAYIN8551843837024997376	Platform order number
`nonceStr`	`Y`	`string(32)`	9459931608	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

bash

curl -L 'baseUrl/api/payInQuery' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"mchOrderNo":"1386556575370063873","nonceStr":"9459931608","orderNo":"PAYIN8551843837024997376"}'

Response Parameters

Parameter	Type	Description
`merchantId`	`int`	Merchant id
`mchOrderNo`	`string(32)`	Merchant order number
`orderNo`	`string(32)`	Platform order number
`channelOrderNo`	`string(32)`	Channel order number
`payType`	`string(32)`	Payin PayType Enum
`payCode`	`string(32)`	Payment Code
`payUrl`	`string(250)`	Payment url
`amount`	`decimal(20,0)`	Amount
`fee`	`decimal(20,4)`	Fee
`orderStatus`	`string(32)`	Order StatusPayin Order Status Enum
`completionTime`	`yyyy-MM-dd HH:mm:ss`	Complete time

Response Example

SuccessPayment in progress

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "1386556575370063873",
    "orderNo": "PAYIN8551843837024997376",
    "payType": "43",
    "payCode": "",
    "payUrl": "https://m.dana.id/link/pay?bizNo=202412021112128001101660361270",
    "payDeskUrl": "https://idpaydesk2.brcashypro.com/views/pay.html?PAYIN8551843837024997376",
    "amount": "20000",
    "fee": "1700",
    "orderStatus": "SUCCESS",
    "completionTime": "2024-12-02 15:40:50",
    "nonceStr": null
  }
}

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "1386556575370063873",
    "orderNo": "PAYIN8551843837024997376",
    "payType": "43",
    "payCode": "",
    "payUrl": "https://m.dana.id/link/pay?bizNo=202412021112128001101660361270",
    "payDeskUrl": "https://idpaydesk2.brcashypro.com/views/pay.html?PAYIN8551843837024997376",
    "amount": "20000",
    "fee": "1700",
    "orderStatus": "PAYING",
    "completionTime": null,
    "nonceStr": null
  }
}

Supplementary instructions when orderType is PATCH

If the user does not pay according to the order amount or pays repeatedly, a supplementary order will appear. In this case, the orderType of the supplementary order is PATCH:

orderNo is the platform order number newly generated for this order.
patchOrderNo is the platform order number of the associated original order,
patchMchOrderNo is the merchant order number of the associated original order.
mchOrderNo is the merchant order number of the associated original order (with a serial number identifier). Note that at this time, the serial number identifier will be added to the end of the mchOrderNo returned by the callback to distinguish multiple partial repayment orders.

For example, if your merchant order number is MCH20230088, when the first partial payment is generated, we will add the serial number 00001 to the end of the merchant order number mchOrderNo of the original order.

The mchOrderNo you receive in the callback is MCH2023008800001, and so on.

When a patch order occurs, our robot will also notify the corresponding merchant group, and the notification will contain all the information you need.

When the orderType of the order is API:

patchOrderNo is the same as orderNo
patchMchOrderNo is the same as mchOrderNo

At this time, the above parameters have no additional meaning.

Async Webhook Notification

The webhooks url is provided by the merchant

POST Merchant NotifyUrl

Webhook Request Parameters

Parameter	Type	Description
`merchantId`	`int`	Merchant id
`mchOrderNo`	`string(32)`	Merchant order number
`orderNo`	`string(32)`	Platform order number
`referencia`	`string(32)`	Payment referencia
`amount`	`decimal(20,2)`	Amount
`fee`	`decimal(20,4)`	Fee
`payUrl`	`string(32)`	Payment url
`payDeskUrl`	`string(250)`	Paydesk url
`payType`	`string(32)`	Payin PayType Enum
`orderStatus`	`string(32)`	Payin Order Status Enum
`completionTime`	`date`	Completion time
`nonceStr`	`string(32)`	Random string
`patchOrderNo`	`string(32)`	The platform order number of the associated original order
`patchMchOrderNo`	`string(32)`	The merchant order number of the associated original order
`orderType`	`string(32)`	API=API order MCH=Merchant dashboard DESK=Paydesk order PATCH=PATCH order

TIP

referencia is the payment voucher number. This value will be present on the payment voucher of some payment products, but not all orders have this field. If your signature is not verified based on the original HTTP request body, please pay attention to the processing of the signature verification logic.

Webhook Request Example

bash

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

Supplementary instructions when orderType is PATCH

If the user does not pay according to the order amount or pays repeatedly, a supplementary order will appear. In this case, the orderType of the supplementary order is PATCH:

orderNo is the platform order number newly generated for this order.
patchOrderNo is the platform order number of the associated original order,
patchMchOrderNo is the merchant order number of the associated original order.
mchOrderNo is the merchant order number of the associated original order (with a serial number identifier). Note that at this time, the serial number identifier will be added to the end of the mchOrderNo returned by the callback to distinguish multiple partial repayment orders.

The mchOrderNo you receive in the callback is MCH2023008800001, and so on.

When a patch order occurs, our robot will also notify the corresponding merchant group, and the notification will contain all the information you need.

When the orderType of the order is API:

patchOrderNo is the same as orderNo
patchMchOrderNo is the same as mchOrderNo

At this time, the above parameters have no additional meaning.

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

Create Payin Order ​

Query Payin Order ​

Async Webhook Notification ​

Create Payin Order

Query Payin Order

Async Webhook Notification