API Reference

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 notifyUrl field 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 StatusStatus Desc
pendingThe end-user has deposited the funds but there is at least one blockchain confirmation that is not in a final state (complete/failed).
confirmedThe deposited funds have at least one blockchain confirmation in a complete state. It will only appear for merchants who have chosen not to include an FX contract and accept the funds in the original cryptocurrency.
creditedThe deposited funds have at least one blockchain confirmation in a complete state. 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.
failedThe end-user's deposit has failed due to blockchain failures or KYT. The funds will be returned to the user.
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!