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/generate
Request Parameters
X-NetPay-Token0c562a59b42e31db535ba4508b4e3a5734b07d06
X-NetPay-CodeNetPay_TEST_BILLER
Header Parameters
FieldTypeIs RequiredDescription
amountDoubleYesAmount of the service
txnidStringYesThe transaction ID generated by the biller
callback_urlURLYesThe biller URL that will be communicated for every transaction
digestStringYesThe computed hash of the transaction that includes the token.

sha1($amount$txnid$token)
nameStringNoThe name of the transaction
mobileStringNoMobile number of the customer (for ereceipt)
expires_atDate Time

(YYYY-MM-DD HH:MM:SS)
NoThe expiration of the transaction. E.g format
descriptionJSON ObjectNoAdditional information of the transaction

GET
Search Transaction
Request URL:
https://pgi-stg-ws.netpay.ph/api/v1/transactions/:refno
Request Parameters
X-NetPay-Token0c562a59b42e31db535ba4508b4e3a5734b07d06
X-NetPay-CodeNetPay_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
FieldTypeDescription
amountDoubleAmount of the service
txnidStringThe transaction ID generated by the biller
statusStringThe status of the transaction. See Appendix B for the list of status
refnoStringThe reference number generated by the e-payment gateway
digestStringThe computed hash for the generated transaction
payment_channelStringThe payment channel code where the transaction has been processed
payment_channel_branchStringThe 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
CodeMessage
200OK
422Unprocessable Entity
400Bad Request
401Unauthorized Access
403Forbidden
405Method Not Allowed
500Internal Server Error
503Web Service Unavailable

Appendix B: List of Transaction Status
CodeDescription
PPending
SSuccess / Paid
FFailed
VVoid