Monitoring Status

Monitoring Status

GET https://api.orda.network/v1/onramp/status

This guide explains how to check the status of a fiat-to-crypto (on-ramp) transaction using the orda API. Monitoring transaction status allows you to track the progress from payment initiation through cryptocurrency delivery, provide users with updates, and handle different outcomes like completion or failure.

API Authentication

To check transaction status, all API requests must be authenticated using your project's Client ID and Client Secret.

Required headers:

  • x-client-id: Your project's Client ID

  • x-signature: HMAC-SHA256 signature derived from your Client Secret

Important Note: For GET requests like this status check, which do not have a request body, you must generate the x-signature using an empty string ("") as the content to be hashed.

For more details, refer to the main Authentication Guide.

Query Parameters

To check a specific on-ramp transaction's status, you must provide the following query parameter:

  • transactionId: The unique transaction ID returned when the on-ramp quote was initially created.

This ID allows the API to retrieve the current status and details of that specific transaction.

Common Issues

  • Missing transactionId: Ensure the transactionId query parameter is included and correct.

  • Incorrect HMAC Signature: Verify the signature is calculated correctly for a GET request (using an empty string) and uses the correct Client Secret. Refer to the Authentication Guide for troubleshooting.

  • Invalid transactionId: Double-check that the transactionId corresponds to a valid, previously initiated on-ramp transaction.

Transaction Statuses

The API will return the current status of the transaction. Common statuses include:

  • In_progress: Payment pending or being processed, crypto conversion in progress.

  • Completed: Cryptocurrency successfully delivered to recipient's wallet.

  • Failed: The transaction failed (e.g., due to payment timeout, expired quote, invalid recipient details).

When to Use This Endpoint

Use this endpoint to:

  • Periodically poll the status after the user initiates a PIX payment.

  • Confirm successful crypto delivery before updating your system or notifying the user.

  • Investigate the final state of transactions that are no longer pending.

Next Steps

Based on the status returned:

  • In_progress: Continue polling at reasonable intervals (e.g., every 5 seconds initially, then less frequently).

  • Completed: Update your records, notify the user of success, display transaction receipt.

  • Failed: Investigate the reason (check response details if available), inform the user, and potentially initiate corrective action or request a new quote.

For implementation specifics, such as sample code and detailed response formats, refer to the API reference.

PreviousExecuting a QuoteNextSDKs

Last updated