Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

🪝Web Hooks

For foundational information on webhooks, including key concepts and verification methods, please refer to the Webhook Basics page.

Checkout webhooks notify merchants of any status changes in real time. As checkout changes its statuses, webhook are being sent if configured. Webhook body contains same model as POST /checkouts response.

  • Your business account with Inqud is set up, complete with API tokens configured.

  • The On-Ramp Project has been established and configured within the Inqud platform.

  • The On-Ramp Project is active.

Setting up Web Hook

  1. Open the app and sign in.

  2. From the left menu bar, choose "Onramp".

  3. Select the desired project.

  4. Open "Webhooks"

  5. Locate the "Checkout webhook" option and click on "Add".

  6. Enter the required details:

    • Webhook link: Provide the URL of your webserver that will handle the callbacks.

    • Webhook secret: Enter a secret key for signature calculation (optional).

  7. Click on "Save" to finalize your settings.

Examples

2. Receive a webhook when a checkout changes status

Notification

The Checkout Webhook triggers on every payment status change. Your server must respond with a 200 status code; otherwise, retries will be attempted using an exponential backoff strategy.

For detailed request specifications, refer to the following page:

Payment Web Hook Specification

PreviousCheckout flowNextOverview

Last updated