> For the complete documentation index, see [llms.txt](https://docs.inqud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.inqud.com/on-ramp/integration/web-hooks.md).

# Web Hooks

{% hint style="info" %}
For foundational information on webhooks, including key concepts and verification methods, please refer to the [Webhook Basics](/developer/web-hooks.md) page.
{% endhint %}

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.  &#x20;

* 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](https://app.inqud.com/) 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.

<figure><img src="/files/kRsOQA6h15lPxs0IndL9" alt=""><figcaption></figcaption></figure>

### Examples

{% tabs %}
{% tab title="Success webhook" %}

```json
{
  "id": "ORCO-699baffe-e163-40e3-b5fb-21e956fd6299",
  "type": "FIXED_PRICE",
  "status": "SUCCESS", // Checkout status
  "sourceAmount": 100,  // User pay amount
  "sourceCurrency": "USD",  // User pay currency
  "targetAmount": 99.5,  // Merchant receive amount
  "targetCurrency": "USDC", // Merchant receive currency
  "deposit": {
    "id": "PMT-1e5bd925-9c35-442e-a657-2691107498d4",
    "status": "SUCCESS",
    "currency": "EUR",
    "amount": 100.00,
    "payUrl": "https://api.gateway.payment.com/pay/f1e3a2e1-38f4-433f-b7c4-3c261de7dadc",
    "createdAt": "2026-02-13T04:58:06.815365Z"
  },
  "payUrl": "https://api.gateway.payment.com/pay/f1e3a2e1-38f4-433f-b7c4-3c261de7dadc",
  "returnUrl": "https://merchant-site.com",
  "feeCypher": "DDP8EsQ4hcp9+6WRfqntdRmD0q1WuPm+7b1N6T03CvHroS4yBOerrXX5+x+eIRfzslBzdhelqdZc8eKDBKixibu3QHMW4lMrrOjck1DWWgHKUKs9xR03VV5zmIos/20dzPUK4zZz+AvlrF4ImG0/4zfd/6H0tgeyuB/b+JAxcMPxsmauW8b6IdfXC3OwAaEFZyIrOopqEbP4wPCN6z9PVU7iWCyQ7oVny0FpZDuf++3eeuVmm00IW6YmbGHFPm3NzdgX3Jdw43Cw76CcHQ0dzf/JcCCMonxEnrscyewbR3bS318uvWifwt2f8HksxaL6Lw77j6LqR9J/NkElMbFW6o3/DNKgd9OEFGJ6MYvyr/B9BHyraHocShGVU+a64EwdTJ2Qrk/074FhG+gF5iYBXrBF1sDWBdkwEUKdcLBe2ICYzt17EZYnzvX7gSoMcad50czdWvphJ7uTbR5n5uek7dHYJEaoMa341K2TWeUmFVJrw3A/+7Er2Z+gv8df70/4OM9vt90Pfot84IaI5Xv6T4aZ0JZT0mEPZzhGU91hsyk6pgAhLuKQvOaldrWwTAFhtwOzbNFW6sSJYl6tb79tBazdxlkvZIgzJrpvU/GxFsK0YEW3FR9Mj0aY+WLrfWTENtbSdLxv0QSwDRpsp5zU7zkleHZp8A1Wqat01jeHr1bMHeHw4EMdtcmtqe/qI8ksGkw8algxoMGLhcUYuaSDb31UIyBKwzGaf6Pci5RgZFD58Y1iydE+FbKPLOwjZ9V/Prtyvo2gCY8qKvjAooNKTp5MsQrA2IpL65vRUUZxxIeBze7r4QzyAdc4WJC+0H9vz9i1Axjj8IkK40/N4gCN6RUCW0kYpMEjLuatfVfBSwZzaxLPP95v1Gj7G20Q3vdBq6uZDLN0tXn65qIaZCoLKHBval+hdZpOUiVPpch+qfYl3pdi17I75y1nU+r5J9NaEpFtfP+zEDSDvDMuVn2H/iu+V2JQoWJBOFxRw4I2QhiIpqS2H0EG2Hq0E0i2gpbBEfmOAvymOf7E9w9UTcRljoCe59pulVA0/cbSK7g1eWhCH+Xb53xjbK47W4+bqzRPRjVkzX/h0d0BPXWbTnV7N7qVFntjgbMzMlgs9WvOot8Y1qlawM+USfFloadjy2ojxgmjTLqnbE+ZyeiQ9uBcCLOFEuAc735Ih/I49mQaNGsMprplOb0h75L4yw03ikKLQfzavmqm5Ky91bGcmKJC9UP0zouQSYWp3r3S6M1LNtyQvtvHdMKGGEocFrWeMyKLrYi21v7eHcHS0CVBu68R0vz6f/KKQm0JOkL6qjx7N2PAllQ/u2oKPhr4gw1VaprBXlfWYZB/tTbPO9pMoC1ZDxQiZZ5fr+GJnsR6PnvgYcKa7qhfbvIK/KYqjQr4k24538yuNOez67mI9UfNx91PeLolY8yUrjvDkBlDIE1yGTopVN9ZB5RLjpll50aBrTxA3JOQGP4fOZfjLFp/FbSG/LojdppEIFBQwvE2WmFDMC/PB/htoCQGTEtncpkFh42KmQS7k+uzRGfvBd5k4xBbRKyKdWxckGZPj+hJJcF0kEBBZWBrf80qQuO7aVslWa21v+DnMyXC75BBoRvXIO/z2wozYDcGEoIkg8TsqfOsoghBAFVoLtUSQYdg48HvtfOka5xDOMXTpYfoZpVXq37mqQcmlv7tD5dmypXLNwiEpjVO8tLTcKATgMafeX/ygFczsx7mze25bjuOJuZie8zS9diyVZWxiygTJiYZfZO1Q7LCeX7C3SF8u34njPI95MlbDRRHZIHcHx2ddRwkift7aKP9CgO6dbde/onrSj6Hz2BItQamD3oAXYMPiB0IrDsKKQEEPaReFv+lVU92bAnm2LtenQJDed96myZ0+pWkwBP+Li4C0EqTdE4Pv+6tz+aS78CtaPZ3uCUPuwT1Y6LXdIdUzF0WmGkGlQSaVca7H3dcTZkE2Cd6O6c6Y3WQSQcoDXU6NtIXtMA3DbV42SxYJQ\u003d\u003d",
  "exchange": {
    "id": "PMT-41717f75-478f-45ea-afd4-f27962c5e42b",
    "status": "SUCCESS",
    "creditCurrency": "EUR",
    "creditAmount": 100.00,
    "debitCurrency": "USDC",
    "debitAmount": 99.5,
    "createdAt": "2026-02-13T04:58:14.088947Z"
  },
  "transfer": {
    "id": "PMT-e003b12f-a372-439e-a898-bd15233a92e5",
    "status": "SUCCESS",
    "currency": "USDC",
    "amount": 99.5,
    "createdAt": "2026-02-13T04:58:18.428225Z"
  }
}
```

{% endtab %}

{% tab title="Failed webhook " %}

```json
{
  "id": "ORCO-b852e29c-7bfc-4d64-ac90-6329d8392d42",
  "type": "NO_PRICE",
  "status": "FAILED",
  "sourceCurrency": "EUR",
  "sourceAmount": 10.0000000000,
  "targetAmount": 11.842800,
  "targetCurrency": "USDC",
  "deposit": {
    "id": "PMT-3c1cca39-e4c6-4c2f-9576-9c43645007d8",
    "status": "FAILED",
    "currency": "EUR",
    "amount": 100.00,
    "payUrl": "https://api.gateway.payment.com/pay/4863f6ad-a8ac-4cc3-91c5-01b05aac27a2",
    "createdAt": "2026-02-13T04:45:26.055384Z"
  },
  "payUrl": "https://api.gateway.payment.com/pay/4863f6ad-a8ac-4cc3-91c5-01b05aac27a2",
  "returnUrl": "https://merchant-site.com",
  "feeCypher": "XCAnNp7kJ549nofcrZYJNwjzpz0mSY85Wp7ozDERVpSSD4W6wNbkw/hUAHfno4m3i4f6RmEI2FfqlkaF6Ai6TFkXSL1t6Ve5T1njJFlu4aoafpgBho9LWwxbTF44vqRx1Wjfy1oqXssM1NUGMOfD0Ua+O8b81VRDSoTwqZwwgNF+Dwcia9lTYGMSVEGDo6w9g1HBKX4VD+ur0ucGSmJDNsM6RWwcznFVm9R3pK0hl8NsHGfGS7CoCVKLm+a/2x7Xzi9HUX61IS2AMccP6wTwV9eKb8itEvc4t9x01E7IquR/7cisROViFxb8jN0lOX0TAwrL9fItzCCcsQyjV0wxupLjkylo1d8c67KdRw+89WrAyhmZ/yaOc5lDK1VNdqh9BoSQOX4Srlyvr8nYqGhMMzEiD9vp1i3oldiXIl30JM5d46LSLcWVDxT6JB2t3re2mELapSgBt4Qrm4QKxVu3lnlAxFopt3mSgzASCQCE+DkEGnGSiu4Izer8GZZ+mrnoDFiTH73qmzlz1yQzswhmXoJUGRYlCzsJyzU/cYoZRbiJHG1Zc3Hq3jS2srZ9G4+ZkZY5p3PJN/2X0NurkIuk1Piw8svHxC2LWChSl+N4MJEgoC2Xlh5hxctec1Zcc4pXqfx+jS4cwCin7kZPBpg1e4ZSXo8cx2j39QBpqJeLnzv70UqdVUcXVgBedAjSpDb1JNCJYnQtleTdFweKAPaO5NsGKYDtG3mG3uikD2+e/9OoTajrcQC2kYDOzpjfpIxK/TqUzTYKuxkDoXUkMjfsUSC8oCTTyMn+pKi7nIjTbhHKehA08Tejm4/uWNP9iK9D74bbPexwi5eQweWK9Exm5aHFvQZGOanwQkyXbFTka5SKKjZBTUe1tLweTISw1eot/3zfLtWNAeasMWm0kNoSjc62CXCuy82Fcq3qGm+7t1Enmnz9bO1Z9fHvmkc84xzw9thgQkoAkf75hVftQrFXW5jpZ6af9DGBDMkKBHJvNZ7kY6qscW8XXc1RV4mR+Oer2DJWHDB0b+mwdr7Vx1fyp7BtGgKlxRmmZOHIf4NPzbaFmYBNA0XEi4wlOJbd78RuK6Lzz/JLub280+dBgbXGE1KNFaomdhBcxNuWf104sKaMP5nAkiUS4ONKESFD0NtJhMBbOiEBkuSaFa9kyw6jn+l4OZO/5l+DYy7R3CqUqNptCoLqZZY8RVgoJtw5sclgVrRJi0i1aNiJSo+5ZuGxTVGH24Ra/eyhB0EtKgA2emXMgd0mWGXW/s0Am+P1xmP6x58O0OXrCKnbwhnn4e6u3W5Nb1MqD0buLJ4lfpHNUpHbUVfd/434k/v6UC1meBh2lAzIlEL4lKM4FAeqbIwvL7QscxqUQJkN4Xa5nT8yM2908WnwYLjRqAiPV3tQOXpLjE9jDCyMLMcxkjTCu2fYV/28cfUyWHeUVNX4kSJF8bwHgMZtotVQyEy6f9LPptzfqGIyCvFX3b22kT3XkTsnk+7H/zf5jriGp7XW+jqpTLeNBUiyfAMqEmTJrXn/NmyN/ZN74EXnjzQGYqzenQbr/z6iZ8HHTOyshNYY1QDH4JkfJJsEusQi4eGsIvgFRvrgHgwNLq3itKsO/T9fxk7z4kNd8xupSHvlvvw4qTHb9OOqdhC0UkwarQJr9e4pu7g0VsoFAL36zEM5eiwqvs5BStAFWFoabwT18Jb6f7flrO+DywiuPb34I14OEdTUp29acvSVTUl4HJlSxlZftsz9u8XqpsHxZ65kka0589kebUDFVM7qIqDhZ2eyGTCzIx4c2vlWdDb0vQX60S0DX7BvFgwLo+0+8VmUkn+qVqvXh16ngZvO6SQyIfijE05AB4SrcTTu3dv9uX+09dAejat6J1u0z1gZYAvgHzcNifwwz2VnEyK6/XlZggkQ1UNJ2KsKfAzoTWB5MTfDUy7nbBRncHMFzcXxvvCMHpIGt2uPbcRNfZphmFsR52kIxY7Oq5x4"
}
```

{% endtab %}

{% tab title="Pending webhook" %}

```json
{
  "id": "ORCO-84aab8ce-0536-40ad-a934-a1647f1d9987",
  "type": "NO_PRICE",
  "status": "PENDING",
  "sourceCurrency": "EUR",
  "sourceAmount": 10.00,
  "targetAmount": 11.840420,
  "targetCurrency": "USDC",
  "deposit": {
    "id": "PMT-db9b5d22-a4ce-4795-8ea2-99ebb420e679",
    "status": "SUCCESS",
    "currency": "EUR",
    "amount": 10.00,
    "payUrl": "https://api.gateway.payment.com/pay/b930e61f-bca7-4570-9bb7-eaa26cc861ab",
    "createdAt": "2026-02-13T04:56:15.598922Z"
  },
  "payUrl": "https://api.gateway.payment.com/pay/b930e61f-bca7-4570-9bb7-eaa26cc861ab",
  "returnUrl": "https://merchant-site.com",
  "feeCypher": "god6ZFKEMlF3Ujj9hX7PO0DEDiD+8lHXQssJroXkMPgQDgVsdGKp8jnElvgxy24VtUEpiH+pbRl3auIbMKq834CJPtAQKMe6CkgjILk4lT/NAunfSBxJbor5OPVJh23i5H/OnqsM0s3YMs2lISTny6vF6vIkqGldQQq2upJ4Jm4VANFysMHEwjZq6a45WITeWbdoie/zzYrQjsY499S6QZ7KxLyMwGARMkjFVh1aHNVVNGYu42szip7Lj2HHAQ2SyhoWQq/C8ChW9LgdM8zEPFulT9rYb0kKG9HDtuioOdgN8IHCLG1nSG1icLbJSlxry/FqbFA1PkzWLHMXkwyW14X+bM/aQtct12ZfrI5bhYgOXC5p4cZ4x0nU+Rt1dfDlmIQ3RVB4ljhulV5uTG4F/HcDWbK5irFUu0rg83eLjDIASN8xrZqdlPpYinyjbLLT9abe25Lbaf3zEUw3fN39+P9NnPHmz18ja/PTnCOAhZ7Ror8rz0prjoRc811pRO2/9Dt/irWbIKHln7+3kpVxZvPE2S1br1WEhnegGuXySaNoDW1EiXV0CzaOKTVmpV8IRv7eb4jqlRuYsEkNamS5AoJ0CRpeKwv//DEWYGskpqMchRdiWWuQBDqVyOGhcisXi6iA+wiMwMfEIwgDjNYnxnTCOVO2cdGD1IVtv+4jGRMcwM9Xt8c7JhOx8wkLVPUcz7hN5mwKtDgfuEqrWf5y7E/TEv1NxZELssW6oe+hTzODQA0hXlbrnBAJasP3D/QrCCpONuLJbolon9u5uOTwRu5r5agsnDHHFKZw66u3iqpXsS5nWO48LEfgXCfp0nBK9/KIOfUsixRJsDZY9Sfdt/7oIFCyfFPw1xIS2pXhYb4CdNNVMttIuPaYnoIzv/Bpcm1ZhmoWuCd3l/2HEfber/AolYQp4somx3ThtZoGC4skLN72U3epTKtJVBj7TvUiVcFbyNR4iUTg+MaGEz88VxyhIZiOuBbICj+gLBzlWSz1KLIrD1KfZgwGibJyyVqlZQYSe0Chnv9wnslHn/Uu+dJ63dZf95t0Z/avwPA8SbWcXLCfB15cHDVGXfTqCmLORzQbAQzI25O1rGvudOuaUugzUzRYsx/XrKtMJb/YtUiDdQzOp6xC3wd7sagk5ovLzosC+HmBufV/TOvc4vwncKjRy0IwP+PSLurpA+NiMAzla1Eg1e6hOJYf0yk8+tUJ9lPJ9wBZa7W6f/CDQdrjf9LgmgLr+hUr32Gwi5Nd1R7cbn9Jq9+hQLc1wdNwmeKGOSDf3Lg2obVmi1EaxzBwfj22iaXJQaGo+qrL6iLZFF5PEFI5pTU8fbC25heJxyIvzta+ZRmL1M6lWUgb8KDYtrowiRivpC2VdBLy8XTr4QFggByNZynzdQmNC86oJHvc/82K+ldvosyFTkxhWkjEDz+hTvRXxBnJgNM1VCVLdnWnqgeSyCebFip3ifYBrv28GdPGumjB91d/ziQ2oapC2Y4xXfWqX4e/yfeAR4lg9KBY1F6/C0hPPXEUWKycmHpNMitOtSwe/csqqZ8f6pkKhXBZAAdwftudZPv2VBK4beRMraVzruLKjoaBHZSXA0MgSnHsAv6TfF2oJ5M9/Ifapuhfbhmp0bMkkh4wIsDzXHPt/eT+A1E5uIEf9Hc8ygW+SL/VLmya5OltQV8QSk6OxPgbOgh0FrclthRGUYbIBHksA5KkV8/MU7zoDs9h9NK4Mtb8QgeVQrA8RJYAdfOZxrWw7wVJYLnb39DkdjMtvvbJAYKHP2HWn66AGwbuhnjenUb7YhitP+vfUUqEDij2QcWnPPcAax/cLryTEfR/43oVR93D9QTWL1XJbcFf0Rc5rhFoLtQW8sKYZKs/uuuKzwrrYtUyAlmkV/g2NjZ4+6ruIFOwMa4v3U37YxGpU1z6S1dC+PoH5n79MryNMeUVBFsrkoFh9cKS0jK6Yr/TSktsFUmJ+JtkKlwOYjy9TSiAZAMjEwb6i5tSLF7lSMRHBQ\u003d\u003d",
  "exchange": {
    "id": "PMT-bd2a1857-83d1-4f3c-bdf2-b37fa6782e7b",
    "status": "SUCCESS",
    "creditCurrency": "EUR",
    "creditAmount": 10.00,
    "debitCurrency": "USDC",
    "debitAmount": 11.84042,
    "createdAt": "2026-02-13T04:56:23.294287Z"
  },
  "transfer": null //not yet completed
}
```

{% endtab %}
{% endtabs %}

#### 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](https://apireference.inqud.com/#tag/crypto-acquiring-webhooks/operation/user_crypto-acquiring_set-crypto-acquiring-static-address-payments-webhook)&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.inqud.com/on-ramp/integration/web-hooks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
