Statuses
The status is the state of an entity, the webhook event type is the reason for the notification. Final statuses do not change.
Invoice
| Status | Final | Meaning |
|---|---|---|
pending | no | The invoice is created and awaits payment. |
confirming | no | Payment received, confirmations are not complete yet. |
underpaid | no | Less than the required amount was received. |
success | yes | The invoice is paid. |
expired | yes | The invoice has expired. |
cancelled | yes | The invoice is cancelled. |
Deposit
| Status | Final | Meaning |
|---|---|---|
pending | no | The deposit is detected but not confirmed yet. |
confirmed | yes | The deposit is confirmed. |
reorged | yes | A blockchain reorganization happened. |
failed | yes | Deposit processing failed. |
deposit.detected— the deposit is detected.deposit.confirmed— the deposit reached the required confirmations.deposit.reorged— a blockchain reorganization happened.deposit.failed— deposit processing failed.
For confirmed, the deposit state is final in terms of confirmation.
Withdrawal
| Status | Final | Event | Meaning |
|---|---|---|---|
requested | no | payout.requested | The withdrawal is created and awaits processing. |
awaiting_liquidity | no | — | Waiting for funds on the sender wallet or resources to pay the network fee. |
queued | no | payout.queued | The withdrawal is queued. |
processing | no | — | Signing, preparing or sending is in progress. |
broadcast_unknown | no | — | The broadcast result is unknown, for example due to an RPC error. This is not a failure and not a reason to create a second withdrawal. |
broadcasted | no | payout.broadcasted | The transaction is broadcast. |
confirmed | yes | payout.confirmed | The transaction is confirmed. |
failed | yes | payout.failed | The withdrawal failed. |
cancelled | yes | payout.cancelled | The withdrawal is cancelled. |
Using statuses
When handling webhooks, look at status, eventType, isFinal and revision together. isFinal: true means the state is final. If several events arrive for one object, never replace a newer state with an older one.