> For the complete documentation index, see [llms.txt](https://apidocs.onekeypayments.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/notifications.md).

# Notifications

Every time a deposit changes its status, we will send you an asynchronous notification containing the ID of the deposit.\
The webhooks are sent to:

1. the **`notification_url`**  you sent in the request, or&#x20;
2. to the one you have configured under the section: ***Settings***  :arrow\_right:  ***API Access*** :arrow\_right: ***Confirm URL.***

**Once received the notification, you should check its new status with the** <a href="/spaces/0lbPmhFPUb55BAkK3G6F/pages/MnOupu9QK2t0rd0FElSw" class="button primary" data-icon="magnifying-glass">Get deposit status</a> **endpoint** **and update it on your end accordingly.**

{% hint style="success" %}

### Firewall configurations

Bear in mind we will only connect through ports 80 and 443. \
Make sure your **`notification_url`** has one of those ports open accepting connections from us.
{% endhint %}

#### Example notification

```javascript
{
    "deposit_id": 3000000001
}
```

<table><thead><tr><th width="148.98567708333331">Field</th><th width="155.37109375">Format</th><th>Description</th></tr></thead><tbody><tr><td><strong><code>deposit_id</code></strong></td><td>Number</td><td>ID of the deposit. Use this ID to <a href="/spaces/VNE8t2FopKfzgQzTjlBb/pages/MnOupu9QK2t0rd0FElSw">check the status of the deposit.</a></td></tr></tbody></table>

### Testing notification in Staging

Receiving notifications accordingly is part of our [integration requirements checklist](/guides/getting-started/start-testing.md#integration-checklist).

In the <mark style="color:$danger;background-color:red;">**Staging**</mark> environment, in order to test the full flow you can manually set a deposit to **COMPLETED** or **CANCELLED** status by: Logging in into the [STG Merchant Panel](https://merchants-stg.onekeypayments.com/login)  :arrow\_right:  Transactions :arrow\_right:  Deposits.

Those options will change the status of the deposit, therefore **sending the respective notification to your `notification_url` after a few minutes**.

![Approve/Cancel from the Deposits view.](/files/ESWimfxIdLWPNInIXp63) ![You can also Approve/Cancel deposits from the Transaction details](/files/NzGzcNntO2ShXIX5D1z3)

## Retry logic

Every time a deposit changes its status, we will send you a notification so you can check its status back.

In case that for some reason your server was unable to handle our notification and you returned an HTTP code different than **2XX**, we will retry the notification **up to 5 more times** **or until you respond with HTTP 2XX**, whatever comes first.

{% hint style="success" %}
In case of errors while handling the notification, make sure you will answer with an HTTP code distinct than 2XX, that way we will retry the notification.
{% endhint %}

The time between each of the 5 notifications attempts will be exponential: **5, 25, 125 and 625  minutes** accordingly.

When a notification failed to be sent, it will be shown like this in our Merchant Panel:

![](/files/-M9_UqvQBGblaqYL1-oD)

If you see the errors from the screenshot above, it means the payment was successfully completed and the money was credited to your account but suddenly **were not properly received**. Keep reading to know how to resend the notifications.

#### Resend Notifications

In case your system was unable to handle the notification in any of the 5 attempts, you can always check its status with the  <a href="/spaces/0lbPmhFPUb55BAkK3G6F/pages/MnOupu9QK2t0rd0FElSw" class="button primary" data-icon="magnifying-glass">Get deposit status</a> endpoint.

If you need to trigger the check status by receiving our notification, once the issue preventing you from receiving our notifications was fixed, you can go to the Merchant Panel, locate the deposit (Transactions  :arrow\_right: Deposits) and click on the three dotted button under the <img src="/files/OFTK38OfNWn7MKEKdQYS" alt="" data-size="line"> section and then "**Resend notification**"  to force a new notification to be sent.

![](/files/-M9zU27QNwGCCPG-JJEq)

{% hint style="success" %}
:clock1: **It can take up to 1 minute for the notification to be resent.**
{% endhint %}


---

# 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, and the optional `goal` query parameter:

```
GET https://apidocs.onekeypayments.com/guides/deposits/create-deposits/notifications.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
