post https://api.getorbital.io/hpp-api-webhook-notification-url
Event Notifications
Recipes
🐿️
Verify Webhook Notification
Open Recipe
🔔 Webhook Notification Endpoint Clarification
Please note that the webhook endpoint for receiving real-time notifications is the URL specified in the
notifyUrlfield included in the request body for the particular transaction. Ensure this URL is correctly set to receive timely updates about your transaction status.
Event Status Definition
| Transaction Status | Status Desc |
|---|---|
| initiated | When an end-user initiates an invoice, this is the first status that appears on the transaction. |
| pending | The end-user has deposited the funds but there is at least one blockchain confirmation that is not in a final state (complete/failed). |
| confirmed | The deposited funds have at least one blockchain confirmation in a complete state. This status only appears when the end-user has made a deposit after the invoice has expired. It will only appears for merchants who have chosen not to include an FX contract and accept the funds in the original cryptocurrency. How much is credited in cashierCurrency is updated to match the current market rate. |
| credited | The deposited funds have at least one blockchain confirmation in complete state. The end-user has accurately deposited the invoiced amount. This status, only appears for merchants who have chosen to include an FX contract, and can now see their funds in their fiat account on the Orbital platform. |
| paid | The deposited funds have at least one blockchain confirmation in a complete state. The end-user has accurately deposited the invoiced amount. It will only appear for merchants who have chosen not to include an FX contract and accept the funds in the original cryptocurrency. |
| underpaid | The deposited funds have at least one blockchain confirmation in a complete state. The end-user has deposited less funds than the invoiced amount. This is irrespective to whether the merchant has chosen to include an FX contract or not. |
| overpaid | The deposited funds have at least one blockchain confirmation in a complete state. The end-user has deposited more funds than the invoiced amount. This is irrespective to whether the merchant has chosen to include an FX contract or not. |
| failed | The end-user's deposit has failed due to blockchain failures or KYT. The funds will be returned to the user. |
| expired | The invoice has expired as the user has not completed the deposit. |