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	`BRL`
`payType`	`Y`	`int`	Pay product type	Payin PayType Enum
`amount`	`Y`	`decimal(20,2)`	Amount	`[5,100000]`
`reusableStatus`	`Y`	`boolean`	Multiple payments	Currently it can only be false
`mchOrderNo`	`Y`	`string(32)`	Merchant order number
`expireTime`	`Y`	`long`	Expiration time	Default: 3600 seconds`Some payment products support`
`notifyUrl`	`Y`	`string(250)`	Webhooks url
`nonceStr`	`Y`	`string(32)`	Random string
`remark`	`Y`	`string(32)`	Remark	Please use English characters or unaccented Spanish
`realName`	`Y`	`string(64)`	User Name	`Maximum length is 64 characters`
`idType`	`Y`	`string(32)`	Payer ID Type	Only supports CPF Payin Payer ID Type
`idCard`	`Y`	`string(32)`	Payer CPF ID number
`redirectUrl`	`N`	`string(250)`	Redirect url	Redirect url after successful payment
`phone`	`N`	`string(32)`	User phone number
`email`	`N`	`string(64)`	User email

TIP

Please note:

Due to the regulatory requirements of the Central Bank of Brazil, from October 15, 2024, idType idCard realName will be required, and we will do basic CPF format verification. (23.456.789-09 / 12345678909) Both formats are supported.
Due to the regulatory requirements of the Central Bank of Brazil, from October 15, 2024, the collection order will verify the payer's CPF. Please be sure to pass the payer's real CPF certificate number when creating the order.

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":"43","expireTime":3600,"mchOrderNo":"1386556787811426305","notifyUrl":"https://merchant.com/webhooks/payin","currency":"IDR","remark":"Electronic Cigarettes","nonceStr":"16a5a70f43384134bfae33acc77132e0"}'

Response Parameters

Parameter	Type	Description
`merchantId`	`long`	MerchantId
`mchOrderNo`	`string(32)`	Merchant order number
`orderNo`	`string(32)`	Platform order number
`amount`	`decimal(20,2)`	Amount
`orderFee`	`decimal(20,2)`	fee
`payCode`	`string(32)`	Payment Code
`payUrl`	`string(250)`	Payment url
`payDeskUrl`	`string(250)`	Paydesk url

Response Example

SuccessSome Error

json

{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "1386556787811426305",
    "orderNo": "PAYIN8551844049125523456",
    "payCode": "",
    "payUrl": "https://m.dana.id/link/pay?bizNo=20241202111212800110166154827",
    "payDeskUrl": "https://m.dana.id/link/pay?bizNo=20241202111212800110166154827",
    "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)`	Payin Order Status Enum
`completionTime`	`yyyy-MM-dd HH:mm:ss`	Completion time

Response Example

PayingSuccess

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

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

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
`amount`	`decimal(20,2)`	Amount
`fee`	`decimal(20,4)`	Fee
`orderStatus`	`string(32)`	Order status
`payUrl`	`string(32)`	Payment url
`payCode`	`string(32)`	Payment VA/QRCODE
`payType`	`string(32)`	Pay product type
`completionTime`	`yyyy-MM-dd HH:mm:ss`	Completion time
`nonceStr`	`string(32)`	Random string

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":"1002001","nonceStr":"1733116026894","orderNo":"PAYIN8551790545658687488","orderStatus":"SUCCESS","payCode":"OR.GPNQR..INOPROID_BS","payType":"41","payUrl":"https://payurl.com"}'

Webhooks-SuccessWebhooks-Fail

json

{
  "amount": 20000.0,
  "completionTime": "2024-12-02 12:07:06",
  "fee": 2500.0,
  "mchOrderNo": "1386503284355244033",
  "merchantId": "1002001",
  "nonceStr": "1733116026894",
  "orderNo": "PAYIN8551790545658687488",
  "orderStatus": "SUCCESS",
  "payCode": "OR.GPNQR..INOPROID_BS",
  "payType": "41",
  "payUrl": "https://payurl.com"
}

json

{
  "amount": 20000.0,
  "completionTime": "2024-12-02 12:07:06",
  "fee": 2500.0,
  "mchOrderNo": "1386503284355244033",
  "merchantId": "1002001",
  "nonceStr": "1733116026894",
  "orderNo": "PAYIN8551790545658687488",
  "orderStatus": "FAIL",
  "payCode": "OR.GPNQR..INOPROID_BS",
  "payType": "41",
  "payUrl": "https://payurl.com"
}

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