API Reference

Webhooks

This endpoint listens for incoming webhook events from external systems or services, specifically to receive transaction status updates. When a transaction is processed, the external system sends a notification to this endpoint, including details about the transaction's status, response code, and identifiers.

Using Webhooks

Webhooks will be sent to the Server URL provided when creating a payment request. A webhook notification will be sent via HTTP POST in the below format.


Payload: The payload structure for transaction status updates includes the following fields:

  • TransactionId: (Required) The unique identifier for the transaction provided by the gateway.
  • trackId: (Required) The merchant's transaction identifier.
  • result: (Required) The result of the transaction (e.g., "Successful").
  • responsecode: (Required) The response code indicating the transaction's outcome.

Blocks of code

QR Success

{
  "transactionid": "1049766",
  "transactiondate": "2024-09-27 11:35:47Z",
  "cardholder": "INSTAPAY",
  "merchantcustomerid": null,
  "trackid": "Test001",
  "currencycode": "PHP",
  "amount": "2000.00",
  "card": "20000000****0008",
  "cardtype": "PHQR",
  "action": "AUTHORIZATION",
  "result": "Successful",
  "authcode": "",
  "responsecode": "0",
  "error_code_tag": "",
  "avs": "",
  "extendedresponse": "GET VCN - True-00-Success-Success",
  "descriptor": "test",
  "message": null,
  "merchantcode": "INSTAPAYTEST001",
  "responsedescription": "Approved or completed available successfully"
}

Complete


{
  "transactionid": "10497676",
  "transactiondate": "2024-09-27 11:40:47Z",
  "cardholder": "INSTAPAY",
  "merchantcustomerid": null,
  "trackid": "Test001",
  "currencycode": "PHP",
  "amount": "2000.00",
  "card": "20000000****0008",
  "cardtype": "PHQR",
  "action": "CAPTURE",
  "result": "Successful",
  "authcode": "",
  "responsecode": "0",
  "error_code_tag": "",
  "avs": "",
	"extendedresponse":"SweepForCollection - True - Success. VCN swept and closed. - ",
  "descriptor": "test",
  "message": null,
  "merchantcode": "INSTAPAYTEST001",
  "responsedescription": "Approved or completed available successfully"
}