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: The unique identifier for the transaction provided by the gateway.
• Trackid: The merchant's transaction identifier.
• Result: The result of the transaction (e.g., "Successful").
• Responsecode: The response code indicating the transaction's outcome.

Blocks of code

Successful sale response

JSON

{
  "transactionid": "1025531",
  "transactiondate": "2024-09-09 06:23:35Z",
  "cardholder": "TEST",
  "merchantcustomerid": null,
  "trackid": "test",
  "currencycode": "USD",
  "amount": "2000.00",
  "card": "20000000****0008",
  "cardtype": "VISA",
  "action": "PURCHASE",
  "result": "Successful",
  "authcode": "",
  "responsecode": "0",
  "error_code_tag": "",
  "udf1": null,
  "udf2": null,
  "udf3": null,
  "udf4": null,
  "udf5": null,
  "avs": "",
   "ExtendedResponse": "Payment Successful.",
  "descriptor": "test",
  "message": null,
  "merchantcode": "test",
  "responsedescription": " Transaction"
}

Unsuccessful sale response

JSON

{
  "transactionid": "1025531",
  "transactiondate": "2024-09-09 06:23:35Z",
  "cardholder": "TEST",
  "merchantcustomerid": null,
  "trackid": "test",
  "currencycode": "USD",
  "amount": "2000.00",
  "card": "20000000****0008",
  "cardtype": "VISA",
  "action": "PURCHASE",
  "result": "Not Successful",
  "authcode": "",
  "responsecode": "6",
  "error_code_tag": "",
  "udf1": null,
  "udf2": null,
  "udf3": null,
  "udf4": null,
  "udf5": null,
  "avs": "",
  "extendedresponse": "transaction declined for unknown reason",
  "descriptor": "test",
  "message": null,
  "merchantcode": "test",
  "responsedescription": "Error Transaction"
}

Processing sale response

JSON

{
  "transactionid": "1025531",
  "transactiondate": "2024-09-09 06:23:35Z",
  "cardholder": "TEST",
  "merchantcustomerid": null,
  "trackid": "test",
  "currencycode": "USD",
  "amount": "2000.00",
  "card": "20000000****0008",
  "cardtype": "VISA",
  "action": "PURCHASE",
  "result": "Processing",
  "authcode": "",
  "responsecode": "9",
  "error_code_tag": "",
  "udf1": null,
  "udf2": null,
  "udf3": null,
  "udf4": null,
  "udf5": null,
  "avs": "",
  "extendedresponse": "Request in progresss",
  "descriptor": "test",
  "message": null,
  "merchantcode": "test",
  "responsedescription": "Request in progress"
}