# 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/ph/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":"100.11",
"channelType":"GCASH_WAKE",
"externalOrderId":"333333333333",
"notifyUrl":"https://www.123.com",
"remark":"test",
"returnUrl": "https://www.123.com"
}
Parameter description:
| Param | Desc | Require | Sample |
|---|---|---|---|
| amount | String | required | The receiving amount cannot exceed 2 decimal places. |
| channelType | String | required | Channel type, enumeration value: QRIS WALLET BANK GCASH_NATIVE MAYA GCASH_WAKE |
| externalOrderId | String(64) | required | Unique order number in the merchant system |
| notifyUrl | String | required | Callback address after payment completion (server) |
| remark | String | optional | Merchant customized note information |
| returnUrl | String | optional | After successful payment, the user will be redirected to the front-end address |
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": "成功",
"msgEn": "SUCCESS",
"data": {
"cashierCurrencyAmount": "111.11",
"cashierExpireTime": 1755226531144,
"cashierId": "OCURRPAID202508150225311755224731134-U0000000200002502",
"cashierUrl": "https://cashier-fiat.io/OCURRPAID202508150225311755224731134HAMBIT-U0000000200002502?data=JTdCJTIyY2FzaGllckN1cnJlbmN5QW1vdW50JTIyJTNBMTExLjExMCUyQyUyMmNhc2hpZXJFeHBpcmVUaW1lJTIyJTNBMTc1NTIyNjUzMTE0NCUyQyUyMmNhc2hpZXJJZCUyMiUzQSUyMk9DVVJSUEFJRDIwMjUwODE1MDIyNTMxMTc1NTIyNDczMTEzNEhBTUJJVC1VMDAwMDAwMDIwMDAwMjUwMiUyMiUyQyUyMmNhc2hpZXJVcmwlMjIlM0ElMjJodHRwcyUzQSUyRiUyRmNhc2hpZXItZmlhdC5oYW1iaXQuaW8lMkZPQ1VSUlBBSUQyMDI1MDgxNTAyMjUzMTE3NTUyMjQ3MzExMzRIQU1CSVQtVTAwMDAwMDAyMDAwMDI1MDIlMjIlMkMlMjJjdXJyZW5jeSUyMiUzQSUyMlBIUCUyMiUyQyUyMmN1cnJlbmN5T3JkZXJWbyUyMiUzQSU3QiUyMmFtb3VudCUyMiUzQTExMS4xMTAlMkMlMjJjaGFubmVsQmFua0FjY291bnROdW1iZXIlMjIlM0FudWxsJTJDJTIyY2hhbm5lbEJhbmtBY2NvdW50VHlwZSUyMiUzQW51bGwlMkMlMjJjaGFubmVsQmFua0NvZGUlMjIlM0FudWxsJTJDJTIyY2hhbm5lbEJhbmtOYW1lJTIyJTNBbnVsbCUyQyUyMmNoYW5uZWxJZCUyMiUzQTE5NTU1MzQ1ODI4MTU0MzI3MDUlMkMlMjJjdXJyZW5jeSUyMiUzQSUyMlBIUCUyMiUyQyUyMmV4dGVybmFsT3JkZXJJZCUyMiUzQSUyMllVUklURVNUMjAyNTA4MTUxMDI1MzE2OTEwNzMlMjIlMkMlMjJtZXJjaGFudEF2YXRhciUyMiUzQSUyMmh0dHBzJTNBJTJGJTJGc3RhdGljLmhhbWJpdC5pbyUyRnVwbG9hZCUyRjIwMjUlMkYwNSUyRmM4MDk2ZDNlLTc5MDQtNGI3Ny04NzE3LTVkMGFjNmVkOWM1Zi5wbmclMjIlMkMlMjJtZXJjaGFudE5hbWUlMjIlM0ElMjJ5dXJpMDA2JTIyJTJDJTIyb3JkZXJBY3R1YWxBbW91bnQlMjIlM0EwJTJDJTIyb3JkZXJJZCUyMiUzQSUyMk9DVVJSUEFJRDIwMjUwODE1MDIyNTMxMTc1NTIyNDczMTE5OEhBTUJJVC1VMDAwMDAwMDQwMDAwMjUwMyUyMiUyQyUyMm9yZGVyU3RhdHVzJTIyJTNBJTIyQXdhaXRpbmcrUGF5bWVudCUyMiUyQyUyMm9yZGVyU3RhdHVzQ29kZSUyMiUzQTElMkMlMjJvcmRlclRpbWUlMjIlM0ExNzU1MjI0NzMxMTc5JTJDJTIyb3JpZ2luYWxBbW91bnQlMjIlM0ExMTEuMTEwJTJDJTIycGF5UGFyYW0lMjIlM0ElMjJodHRwcyUzQSUyRiUyRnBheWVybWF4LmdpbHBheS5uZXQlMkZhcGklMkZwYXltZW50X2RpcmVjdCUyRnJlZGlyZWN0JTJGUzE3NTUyMjQ3MzJ2b3psaSUyMiUyQyUyMnBheVR5cGUlMjIlM0ExMjglMkMlMjJwYXlUeXBlTmFtZSUyMiUzQSUyMmNhdGVnb3J5K29uZStHQ0FTSCtuYXRpdmUlMjIlMkMlMjJwYXlVcmwlMjIlM0ElMjJodHRwcyUzQSUyRiUyRnBheWVybWF4LmdpbHBheS5uZXQlMkZhcGklMkZwYXltZW50X2RpcmVjdCUyRnJlZGlyZWN0JTJGUzE3NTUyMjQ3MzJ2b3psaSUyMiUyQyUyMnBheW1lbnRWb3VjaGVyJTIyJTNBbnVsbCUyQyUyMnJldHVyblVybCUyMiUzQW51bGwlMkMlMjJ0cmFkZU5vdGUlMjIlM0ElMjJ3c3h0ZXN0JTIyJTJDJTIydXNlckluZm9ObyUyMiUzQW51bGwlN0QlMkMlMjJpc0NyZWF0ZU9yZGVyJTIyJTNBdHJ1ZSUyQyUyMmlzSGlkZGVuTWVyY2hhbnRMb2dvJTIyJTNBbnVsbCUyQyUyMmlzSGlkZGVuTWVyY2hhbnROYW1lJTIyJTNBbnVsbCUyQyUyMm1lcmNoYW50QXZhdGFyJTIyJTNBbnVsbCUyQyUyMm1lcmNoYW50SWQlMjIlM0ExNzg1OTQ1ODExOTc2MTk2MDk3JTJDJTIybWVyY2hhbnROYW1lJTIyJTNBbnVsbCUyQyUyMnBheVR5cGUlMjIlM0ExMjglMkMlMjJyZXR1cm5VcmwlMjIlM0ElMjJodHRwcyUzQSUyRiUyRnd3dy5iYWlkdS5jb20lMjIlMkMlMjJ1c2VySW5mb05hbWUlMjIlM0FudWxsJTJDJTIydXNlckluZm9ObyUyMiUzQW51bGwlMkMlMjJ1c2VySW5mb1R5cGUlMjIlM0FudWxsJTJDJTIydmVyc2lvbiUyMiUzQSUyMnYxJTIyJTdE",
"currency": "PHP",
"currencyOrderVo": {
"originalAmount": "111.11",
"amount": "111.11",
"currency": "PHP",
"externalOrderId": "YURITEST20250815102531691073",
"orderId": "OCURRPAID202508150225311755224731198-U0000000400002503",
"orderStatus": "Awaiting Payment",
"orderStatusCode": 1,
"orderTime": 1755224731179,
"payParam": "https://payermax.gilpay.net/api/payment_direct/redirect/S1755224732vozli",
"payType": 128,
"tradeNote": "wsxtest"
},
"isCreateOrder": true,
"isHiddenMerchantLogo": null,
"isHiddenMerchantName": null,
"payType": 128,
"returnUrl": "https://www.123.com",
"userInfoName": null,
"userInfoNo": null,
"userInfoType": null,
"version": "v1",
"payTypeCode": null
}
}
Response parameter description
| Param | Type | Desc |
|---|---|---|
| cashierCurrencyAmount | String | Collection amount (for display purposes, consistent with the order amount) |
| cashierExpireTime | int64 | Cashier expiration time (timestamp) |
| cashierId | String | Cashier Order ID |
| cashierUrl | String | Jump to the checkout payment link |
| currency | String | Currency code |
| amount | String | The original amount of the order, the amount initiated when the order was created |
| externalOrderId | String | Merchant order number |
| orderId | String | System Order ID |
| orderStatus | String | Order status description (such as: Wait pay) |
| orderStatusCode | int64 | Order status code: 1=Pending payment; 2=Payment successful (final status) |
| orderTime | int64 | Order creation time (timestamp) |
| payParam | String | Payment parameters |
| tradeNote | String | Transaction remarks information |
| isCreateOrder | bool | Whether the order has been successfully created, true/false |
| payType | int64 | Payment type code |
| returnUrl | String | After payment is completed, redirect to the front-end address |
| userInfoName | String | User Name |
| userInfoNo | String | User information number |
| userInfoType | String | User information types |
| payTypeCode | String | Payment channel identification |
| isHiddenMerchantLogo | bool | Do you want to hide the merchant logo |
| isHiddenMerchantName | bool | Do you want to hide the merchant name |
| version | String | version |