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.


Transaction StatusStatus Desc
initiatedWhen an end-user initiates a withdrawal, this is the first status that appears on the transaction.
pendingThe funds have been sent but there is at least one blockchain confirmation that is not in a final state (complete/failed).
debitedThis status is only relevant for merchants who have chosen to include an FX contract. Their fiat account has been debited for the pay out funds on the Orbital platform.
confirmedThe pay out funds have at least one blockchain confirmation in a complete state.
failedThe pay out has failed due to low balance or KYT. In a latter case funds will be returned to the merchant.
Language
Authorization
Header
URL
Click Try It! to start a request and see the response here!