Skip to main content

Set up Webhook

The Notifications Webhook enables clients to automatically receive real-time updates on payment events processed through our platform. By integrating this webhook, you can stay informed about transactions without the need for manual polling.

Configuration​

To set up notifications for payment events, you must provide a URL where our platform can send HTTP POST requests. Ensure that the provided URL meets the following requirements:

  • Accessibility: The URL must be publicly accessible and capable of handling HTTP POST requests.
  • Data Handling: Your server must be prepared to process incoming requests containing event data in the specified format.

Request Details​

  • Method: POST

Relevant Data Sent in the Webhook​

The data will be sent in JSON format with the following structure:

{
    "transactionDate": "2025-01-21 08:16:58",
    "transactionStatus": "canceled",
    "transactionId": "fdb5e7bc-XXXX-XXXX-XXXX-97259408af0d",
    "totalAmount": 53.75,
    "paymentMethod": "cash",
    "email": "testuser@gmail.com",
    "numeroOrden": "n/a",
    "merchantId": ""
}

Expected Response from the Webhook

The client’s server must respond with a 200 OK status code to confirm the correct reception of the message. Any other status code will be considered a delivery failure, and the message will be retried.

Example of a POST Request​

The JSON structure above will be sent as the body of an HTTP POST request to the configured URL. Here's an example of how the request will look:

POST /webhook-endpoint HTTP/1.1
Host: your-website.com
Content-Type: application/json

{
    "transactionDate": "2025-01-21 08:16:58",
    "transactionStatus": "canceled",
    "transactionId": "fdb5e7bc-XXXX-XXXX-XXXX-97259408af0d",
    "totalAmount": 53.75,
    "paymentMethod": "cash",
    "email": "testuser@gmail.com",
    "numeroOrden": "n/a",
    "merchantId": ""
}

Frequently Asked Questions​

  • What happens if my server is not available to receive notifications? If our platform does not receive a successful response (200 OK) from your server, we will retry sending the notification up to three times. If all retries fail, the event will be marked as undeliverable, and an email notification will be sent to the designated contact email for your account.

We recommend implementing robust logging and monitoring on your server to identify and resolve potential issues quickly.