LET'S ROCK!

Webhooks

Owned by Tim Werner
Last updated: Jul 30, 2018

Webhooks help you to get notified for certain events such as a paid Boleto, Oxxo or a chargeback.


Availability

DelayNear real-time. What does near real-time mean?
Request timeoutIf we don't receive a response within 30 seconds, the message is considered timed out. It will then be scheduled for retry.
RetriesIn case of a failed delivery we store a failed notification for a limited period of time and try sending it again later.
Retries are sent at increasing time intervals until either the message is accepted or the maximum retry period of 30 days has been exceeded. After this time the transaction still can be looked up via the reporting endpoints or the BIP.

Retry-intervals:
  • 1 minute
  • 2 minutes
  • 4 minutes
  • 8 minutes
  • 15 minutes
  • 30 minutes
  • 1 hour
  • every hour until 30 days have passed since the first attempt.
Beyond the retry periodEvery day you would receive an summarized email with the newest 100 failed notifications sent to the list of emails configured for this listener.
The notifications that were queuing up for the last thirty days will be deleted. You still can get these contents by using the other reporting tools of the platform.
Guarantee on message orderThere is no guarantee on the order of messages. If you first send request A and then request B, you might retrieve a notification first on B then on A, especially if...
  • The time difference between the messages is smaller than the time it takes us to process them
  • The receiving server was unavailable for a time. Once the server is up again new notifications will arrive in real time, old notifications however would only be resent once they are retried in the rhythm as specified above.
Required Client server power

Please make sure that your server for receiving notifications is able to properly receive the peak-loads that can be caused by the transaction processing on entities you're listening to.
Example: If there is a transaction processing peak of 30 transactions/second then you would receive around 30 notifications/second on your webhook URL as well. We recommend asynchronous processing and a receiver cache for scenarios like this.

Setup

To setup the webhook for you, please provide your Account Manager or Sales Representative with the following information:


URL


The URL that receives the notifications. It has to be https


Notification types


The notification types you want to subscribe to. E.g. by selecting PAYMENT the registered URL will receive all payment events happening on this entity and its descendants. You can choose any subset of the available options.


Fields to include

The fields you want to receive in payload. E.g. by selecting ALL, payload will include every fields the transaction generates.


  • ALL Payload includes all fields the transaction generates
  • NON_CUSTOMER_DATA Payload includes only fields which are not customer data
WrapperIf you need to get specific content type for webhooks, you can choose wrapper for it.
  • None No wrapper for webhook body. Content-Type will be text/plain and body will be (encrypted) hexadecimal string.
  • JSON Json wrapper for webhook body. Content-Type will be application/json and body will be wrapped by json
    example: {"encryptedBody":"[(encrypted) hexadecimal string]"}