---
title: "Get ramp by ID"
url: https://docs.truemarkets.co/api/gateway/get-ramp
description: "Returns the current state of a ramp"
---

Docs index: https://docs.truemarkets.co/llms.txt

# Get ramp by ID

Returns the current state of a ramp

## Request

```
GET https://api.truemarkets.co/v1/gateway/ramps/{id}
```

### Authentication

Bearer token in `Authorization`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `TM-On-Behalf-Of` | header | string (uuid) | no | Act as one of your organization's users. The value is the `user_id` returned when the user was created; the request then reads and writes that user's account. Requires an organization token and a user your organization created: `400` for a personal token, a repeated header or a non-UUID, `403` for a user outside your organization. Not accepted on organization-scoped routes. |
| `id` | path | string (uuid) | yes | Ramp ID (UUID) |

## Responses

Every error status returns the same body, described in [Errors](https://docs.truemarkets.co/developer-resources/errors.md).

### 200

Ramp retrieved successfully

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | yes |  |
| `payment_method` | string, one of `COINBASE`, `PAYPAL`, `APPLE_PAY`, `GOOGLE_PAY` | yes | Rail the ramp is funded or paid out through. DeFi routes the provider from it, so it is the caller's only choice of venue. `APPLE_PAY` and `GOOGLE_PAY` are onramp-only and require a `channel`. |
| `direction` | string, one of `onramp`, `offramp` | yes |  |
| `status` | string, one of `created`, `pending`, `completed`, `failed`, `expired` | yes | Ramp lifecycle: `created` until funds move, `pending` while the provider settles, then `completed`, `failed`, or `expired` if it was abandoned before any funds moved. |
| `amount` | string | yes | Amount requested at creation, in the settlement asset |
| `chain` | string | yes | Chain the ramp settles on |
| `asset_symbol` | string | no |  |
| `asset_amount` | string | no | Amount actually settled |
| `fiat_currency` | string | no |  |
| `fiat_amount` | string | no |  |
| `fee_amount` | string | no |  |
| `fee_currency` | string | no |  |
| `exchange_rate` | string | no |  |
| `wallet_address` | string | no | Address the ramp settles against |
| `provider_wallet_address` | string | no | Provider deposit address the offramp transfer sends to |
| `tx_hash` | string | no |  |
| `redirect_url` | string | no |  |
| `failure_reason` | string | no |  |
| `created_at` | string (date-time) | yes |  |
| `updated_at` | string (date-time) | yes |  |
| `completed_at` | string (date-time) | no |  |

### 400

Bad request

### 401

Unauthorized

### 403

Forbidden. On order creation this also covers an asset that is not available to trade from the country the request came from.

### 404

Not found

### 500

Internal server error
