Webhooks
Callback messages from Rapyd to the client, triggered by internal or external events.
A webhook contains all relevant information about the event that triggers it.
To receive webhooks, you must configure your account with the URL you want the webhooks to go to. See Defining a Webhook Endpoint. Use the type field in the webhooks to filter them or route them for further processing.
Synchronous and Asynchronous Trigger Events
A synchronous trigger event occurs at the same time as the HTTP request and response. The synchronous webhook contains exactly the same information as the response. You can use synchronous webhooks to confirm the content of the response.
An asynchronous trigger event occurs outside the request-response cycle. For example, payment by cash requires the end-user customer to physically transfer cash into the Rapyd system at a point-of-sale (POS) location. The payment is created in the system and the response is sent, but the payment is not complete until the cash is received and registered. That trigger event causes Rapyd to send a webhook with the appropriate notification.
Note
In this reference document, individual asynchronous webhooks appear together with the features they relate to. Synchronous webhooks are not documented because they contain the same information as the responses.
Uses of Webhooks
The merchant can use the webhook notifications for any purpose, including the following:
Finalizing a transaction.
An audit trail.
A secondary method for tracking or synchronizing transactions.
Fraud detection and prevention.
List of Webhooks
For a complete list of the webhooks in the platform, use the Client Portal.