Payment Gateway API Documentation v1.1
Project Background
We automatically route payments through the most optimal channels, ensuring the highest transaction success rates in the market.
Developers love our thorough, well-documented APIs that let you to build everything from simple weekend projects, to complex financial products serving hundreds of thousands of customers.
POST
Initialize Transaction
Request URL:
https://pgi-stg-ws.netpay.ph/api/v1/transactions/generateRequest Parameters
| X-NetPay-Token | 0c562a59b42e31db535ba4508b4e3a5734b07d06 |
| X-NetPay-Code | NetPay_TEST_BILLER |
Header Parameters
| Field | Type | Is Required | Description |
|---|---|---|---|
| amount | Double | Yes | Amount of the service |
| txnid | String | Yes | The transaction ID generated by the biller |
| callback_url | URL | Yes | The biller URL that will be communicated for every transaction |
| digest | String | Yes | The computed hash of the transaction that includes the token. sha1($amount$txnid$token) |
| name | String | No | The name of the transaction |
| mobile | String | No | Mobile number of the customer (for ereceipt) |
| expires_at | Date Time (YYYY-MM-DD HH:MM:SS) | No | The expiration of the transaction. E.g format |
| description | JSON Object | No | Additional information of the transaction |
GET
Search Transaction
Request URL:
https://pgi-stg-ws.netpay.ph/api/v1/transactions/:refnoRequest Parameters
| X-NetPay-Token | 0c562a59b42e31db535ba4508b4e3a5734b07d06 |
| X-NetPay-Code | NetPay_TEST_BILLER |
POST
Realtime Payment Notification
Realtime Payment Notification (RPN) is a message queue service that automatically notifies the callback url of the biller. This service automatically resend the transaction until the biller callback url acknowledges it.
Request Parameters
| Field | Type | Description |
|---|---|---|
| amount | Double | Amount of the service |
| txnid | String | The transaction ID generated by the biller |
| status | String | The status of the transaction. See Appendix B for the list of status |
| refno | String | The reference number generated by the e-payment gateway |
| digest | String | The computed hash for the generated transaction |
| payment_channel | String | The payment channel code where the transaction has been processed |
| payment_channel_branch | String | The payment channel branch code where the transaction has been processed |
NOTE:
If you have an additional authentication in the callback URL that you provided. Kindly advise the e-payment gateway provider.
Appendix A: API Response Code
| Code | Message |
|---|---|
| 200 | OK |
| 422 | Unprocessable Entity |
| 400 | Bad Request |
| 401 | Unauthorized Access |
| 403 | Forbidden |
| 405 | Method Not Allowed |
| 500 | Internal Server Error |
| 503 | Web Service Unavailable |
Appendix B: List of Transaction Status
| Code | Description |
|---|---|
| P | Pending |
| S | Success / Paid |
| F | Failed |
| V | Void |