Crypto Ramp API
Retrieve all orders
api
get
/orders

Retrieve all orders

Retrieve all orders by date range.

The results are sorted chronologically by the created_at date (i.e. oldest first).

For more information, see the guides: Leverage the Crypto Ramp API -> Get all orders.

X-API-KEY​

Each Crypto Ramp API request must contain an authorization header in the following format to make a call: X-API-KEY: {your_API_key}.

Before you start, make sure that you have the correct API key. For more information, see the Get started guides: Integrate with Revolut Ramp -> 2. Get Partner keys.

Request​

Query Parameters
Query Parameters

The earliest date for the order creation date range (inclusive) in ISO 8601 format.

In other words, the "oldest" order creation date you are interested in.

The latest date for the order creation date range (inclusive) in ISO 8601 format.

In other words, the "most recent" order creation date you are interested in.

The number of orders to skip at the beginning of the range when fetching orders (sorted by creation date, oldest first).

This means that if you set skip=3, the first three orders are skipped, and the list of orders that you get as a result will start with the order that would normally be 4th on the list.

Possible values: >= 1 and <= 1000

Default value: 100

The maximum number of orders to fetch from the given range. Must be between 1 and 1000 (inclusive). Default value is 100.

Header Parameters
Header Parameters

Your API key that you received during integration setup. For more information, see the Authorization section above.

Response​

OK

Response body
Body array of objects

The external UUID of the order.

Example: {"amount":100,"currency":"USD"}

The fiat amount that the customer paid for the crypto (excluding fees).

The amount.

Example: "GBP"

The fiat currency ISO 4217 code.

Example: {"amount":100,"currencyId":"USDT-ETH"}

The crypto amount that the customer received.

The amount.

Example: "USDT-ETH"

The ID of the currency, obtained from the /config endpoint.

The fees for the order.

Example: {"amount":100,"currency":"USD"}

Revolut Ramp fee.

The amount.

Example: "GBP"

The fiat currency ISO 4217 code.

Example: {"amount":100,"currency":"USD"}

Partner fee.

The amount.

Example: "GBP"

The fiat currency ISO 4217 code.

Example: {"amount":100,"currency":"USD"}

Crypto network fee.

The amount.

Example: "GBP"

The fiat currency ISO 4217 code.

The exchange rate for the order.

Possible values: [card, revolut, apple-pay, google-pay]

The payment method used for the purchase.

The UTC date and time of order creation in ISO 8601 format.

The UTC date and time of order update in the ISO 8601 format.

Possible values: [AWAITING_PAYMENT, PROCESSING, COMPLETED, FAILED]

The state of order processing.

Possible values: [PAYMENT_NOT_RECEIVED, PAYMENT_DECLINED, CRYPTO_WITHDRAWAL_FAILED, OTHER]

The reason why the order failed.

The address of the crypto wallet into which the crypto transfer was ordered.

The blockchain transaction hash. Absent if no crypto transaction has been created yet. Always present if order is in the COMPLETED state.

The additional properties passed in the call to the /buy endpoint under the additionalProperties.* query parameter(s), if such properties were provided.

The fees converted to the partner's currency.

Example: {"amount":100,"currency":"USD"}

Revolut Ramp fee.

The amount.

Example: "GBP"

The fiat currency ISO 4217 code.

Example: {"amount":100,"currency":"USD"}

Partner fee.

The amount.

Example: "GBP"

The fiat currency ISO 4217 code.

Example: {"amount":100,"currency":"USD"}

Crypto network fee.

The amount.

Example: "GBP"

The fiat currency ISO 4217 code.

Was this page helpful?
Loading...