The difference between Rapyd API responses and webhooks

An API response is immediately returned after a Rapyd API request. A Rapyd webhook is triggered only after a specific event that occurs in the workflow. This triggered event may not be immediate.

For example:

  1. A Create Payment by cash request is made.
  2. A successful API response is immediately received. It includes instructions for the payer to scan or show the transaction code at a specific point of sale and pay the full amount.
  3. The payer goes to the designated point of sale, shows the code to the cashier and pays the requested amount.
  4. The point of sale sends a confirmation to Rapyd that the payment has been received.
  5. Rapyd sends a ‘Payment Completed’ webhook to a predefined endpoint.

Both Rapyd API responses and webhooks are in JSON format.

Most API requests also generate a webhook at the same time as the response. It contains exactly the same information, but there is a difference: the webhook is sent with a signature, and the API response is not.

Some clients prefer using the webhooks instead of the API responses. The important thing is that you have a choice, and you can use whichever one fits your process model best.