> For the complete documentation index, see [llms.txt](https://docs.orda.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.orda.network/developers/api/on-ramps/monitoring-status.md).

# Monitoring Status

## Monitoring Status <a href="#monitoring-status" id="monitoring-status"></a>

```
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 the string "{}" (canonical empty object) as the content to be hashed.

For more details, refer to the main [Authentication Guide](/developers/authentication.md).

**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 the string "{}" (canonical empty object) and uses the correct Client Secret. Refer to the [Authentication Guide](/developers/authentication.md) 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](broken://spaces/Pej4zM9TIFz5NZwMgGdT).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.orda.network/developers/api/on-ramps/monitoring-status.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
