# 1、Create Pay in
Enables merchants to initiate payment requests, which return a payment link or QR code for end-users to complete the payment.
Request Method
- POST
URL:
/api/v3/mex/bankTransfers/createCollectingOrder
- Content-Type:
Content-Type: application/json; charset=utf-8
Header Parameters(Header)
Param | Type | Description | Sample |
---|---|---|---|
access_key | String | Access key obtained from the merchant backend | pFqV75X3 |
timestamp | int64 | Unix timestamp in milliseconds (13-digit) | 1679724896223 |
nonce | String | UUID v4 random string | 794c26b0-d33c-4394-b2bb-c485eca16d9e |
sign | String | Signature calculated through signature algorithm | kAXyh+eerqrefyaF8dyFB0M4FVo= |
All the above parameters are passed as HTTP headers
Example of requesting body data
{
"amount": "40.20",
"channelType": "CASH",
"externalOrderId": "354997490558818072",
"notifyUrl": "http://192.168.1.135:30001/",
"remark": "123",
"returnUrl": "http://192.168.1.135:30001",
"dynamicAmountNotify":1
}
Parameter description:
Param | Desc | Require | Sample |
---|---|---|---|
amount | String | Yes | The amount to collect. The decimal point cannot exceed 2 places |
channelType | String | Yes | Payment type: CASH,PAYCASHRECURRENT,QRIS |
externalOrderId | String | Yes | The unique order ID in the merchant system |
dynamicAmountNotify | Int64 | No | Whether to enable dynamic amount callback: 1 for enable, 2 for disable. Default is 1 |
notifyUrl | String | Yes | The callback URL after the payment is completed (server-side) |
remark | String | No | Merchant's custom remark |
returnUrl | String | No | The URL to redirect to after the user successfully pays (frontend) |
response type:
Header: { 'Content-Type': 'application/json;charset=utf-8'}
Create payment response instructions:
Example of Normal Response Data (HTTP 200)
{
"code": "200",
"success": true,
"msg": "Success",
"msgEn": "SUCCESS",
"data": {
"cashierUrl": "https://cashier-fiat.io/OCURRPAID202506040723051749021785698HAMBIT-U0000000201299921?data=JTdCJTIyY2FzaGllckN1cnJlbmN5QW1vdW50JTIyJTNBNS4wMTAlMkMlMjJjYXNoaWVyRXhwaXJlVGltZSUyMiUzQTE3NDkwMjM1ODU3MTAlMkMlMjJjYXNoaWVySWQlMjIlM0ElMjJPQ1VSUlBBSUQyMDI1MDYwNDA3MjMwNTE3NDkwMjE3ODU2OThIQU1CSVQtVTAwMDAwMDAyMDEyOTk5MjElMjIlMkMlMjJjYXNoaWVyVXJsJTIyJTNBJTIyaHR0cHMlM0ElMkYlMkZjYXNoaWVyLWZpYXQuaGFtYml0LmlvJTJGT0NVUlJQQUlEMjAyNTA2MDQwNzIzMDUxNzQ5MDIxNzg1Njk4SEFNQklULVUwMDAwMDAwMjAxMjk5OTIxJTIyJTJDJTIyY3VycmVuY3klMjIlM0ElMjJNWE4lMjIlMkMlMjJjdXJyZW5jeU9yZGVyVm8lMjIlM0ElN0IlMjJhbW91bnQlMjIlM0E1LjAxMCUyQyUyMmNoYW5uZWxCYW5rQWNjb3VudE51bWJlciUyMiUzQW51bGwlMkMlMjJjaGFubmVsQmFua0FjY291bnRUeXBlJTIyJTNBbnVsbCUyQyUyMmNoYW5uZWxCYW5rQ29kZSUyMiUzQW51bGwlMkMlMjJjaGFubmVsQmFua05hbWUlMjIlM0FudWxsJTJDJTIyY2hhbm5lbElkJTIyJTNBMTg0NzEwNjc0MjMyNDA4ODgzNCUyQyUyMmN1cnJlbmN5JTIyJTNBJTIyTVhOJTIyJTJDJTIyZXh0ZXJuYWxPcmRlcklkJTIyJTNBJTIyMjAyNTA2MDQxNTIzMDQ4MTE5MDAlMjIlMkMlMjJtZXJjaGFudEF2YXRhciUyMiUzQSUyMmh0dHBzJTNBJTJGJTJGc3RhdGljLmhhbWJpdC5pbyUyRnVwbG9hZCUyRjIwMjUlMkYwNSUyRmM4MDk2ZDNlLTc5MDQtNGI3Ny04NzE3LTVkMGFjNmVkOWM1Zi5wbmclMjIlMkMlMjJtZXJjaGFudE5hbWUlMjIlM0ElMjJ5dXJpMDA2JTIyJTJDJTIyb3JkZXJBY3R1YWxBbW91bnQlMjIlM0EwJTJDJTIyb3JkZXJJZCUyMiUzQSUyMk9DVVJSUEFJRDIwMjUwNjA0MDcyMzA1MTc0OTAyMTc4NTc1OUhBTUJJVC1VMDAwMDAwMDQwMTI5OTkyMiUyMiUyQyUyMm9yZGVyU3RhdHVzJTIyJTNBJTIyQXdhaXRpbmcrUGF5bWVudCUyMiUyQyUyMm9yZGVyU3RhdHVzQ29kZSUyMiUzQTElMkMlMjJvcmRlclRpbWUlMjIlM0ExNzQ5MDIxNzg1NzQ1JTJDJTIycGF5UGFyYW0lMjIlM0ElMjJodHRwcyUzQSUyRiUyRnd3dy5wYXljYXNoZ2xvYmFsLmNvbSUyRmZvcm1hdG8ucGhwJTNGcmVmZXJlbmNiaWFuYXMlM0QxJTIyJTJDJTIycGF5VHlwZSUyMiUzQTExMSUyQyUyMnBheVR5cGVOYW1lJTIyJTNBJTIyQ2FzaCUyMiUyQyUyMnBheVVybCUyMiUzQSUyMmh0dHBzJTNBJTJGJTJGd3d3LnBheWNhc2hnbG9iYWwuY29tJTJGZm9ybWF0by5waHAlM0ZyZWZlcmVuY2lhJTNETVRReU1Ea3dNakUzT0RjeE13JTNEJTNEJTI2aW50ZXJubyUzRDElMjIlMkMlMjJwYXltZW50Vm91Y2hlciUyMiUzQW51bGwlMkMlMjJyZXR1cm5VcmwlMjIlM0FudWxsJTJDJTIydHJhZGVOb3RlJTIyJTNBJTIyd3N4MTIzMTIlMjIlMkMlMjJ1c2VySW5mb05vJTIyJTNBbnVsbCU3RCUyQyUyMmlzQ3JlYXRlT3JkZXIlMjIlM0F0cnVlJTJDJTIyaXNIaWRkZW5NZXJjaGFudExvZ28lMjIlM0FudWxsJTJDJTIyaXNIaWRkZW5NZXJjaGFudE5hbWUlMjIlM0FudWxsJTJDJTIybWVyY2hhbnRBdmF0YXIlMjIlM0FudWxsJTJDJTIybWVyY2hhbnRJZCUyMiUzQTE3ODU5NDU4MTE5NzYxOTYwOTclMkMlMjJtZXJjaGFudE5hbWUlMjIlM0FudWxsJTJDJTIycGF5VHlwZSUyMiUzQTExMSUyQyUyMnJldHVyblVybCUyMiUzQW51bGwlMkMlMjJ1c2VySW5mb05hbWUlMjIlM0FudWxsJTJDJTIydXNlckluZm9ObyUyMiUzQW51bGwlMkMlMjJ1c2VySW5mb1R5cGUlMjIlM0FudWxsJTJDJTIydmVyc2lvbiUyMiUzQSUyMnYxJTIyJTdE",
"currency": "MXN",
"currencyOrderVo": {
"orderId": "OCURRPAID202506040723051749021785759U0000000401299922",
"externalOrderId": "20250604152304811900",
"currency": "MXN",
"amount": "5.01",
"tradeNote": "wsx12312"
}
}
}
Response parameter description
Param | Type | Desc |
---|---|---|
cashierUrl | String | Payment link |
currency | String | Currency code |
amount | String | Collected amount |
externalOrderId | String | Merchant order ID |
orderId | String | System order ID |
tradeNote | String | Remarks |