> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Interactive on-ramp walkthrough with a pull deposit

> Navigate through a card → crypto address on-ramp order, paid with a pull deposit. Click each step to see the matching API call and visual representation side by side.

**/on-off-ramp/rails?rampType=on-ramp\&type=crypto**

```bash cURL theme={null}
curl -X GET "https://api.enterprise.uphold.com/on-off-ramp/rails?rampType=on-ramp&type=crypto" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"
```

```js JavaScript theme={null}
const response = await fetch("https://api.enterprise.uphold.com/on-off-ramp/rails?rampType=on-ramp&type=crypto", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <ACCESS_TOKEN>",
  },
});

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.request(
  "GET",
  "https://api.enterprise.uphold.com/on-off-ramp/rails",
  headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
  },
  params={"rampType": "on-ramp", "type": "crypto"}
)

data = response.json()
```

```java Java theme={null}
import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();
var req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.enterprise.uphold.com/on-off-ramp/rails?rampType=on-ramp&type=crypto"))
    .header("Authorization", "Bearer <ACCESS_TOKEN>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(req, HttpResponse.BodyHandlers.ofString());
var body = response.body();
```

```json Response theme={null}
{
  "rails": [
    {
      "rampType": "on-ramp",
      "type": "crypto",
      "network": "xrp-ledger",
      "method": "crypto-transaction",
      "asset": "XRP",
      "decimals": 6,
      "features": ["withdraw"]
    },
    {
      "rampType": "on-ramp",
      "type": "crypto",
      "network": "bitcoin",
      "method": "crypto-transaction",
      "asset": "BTC",
      "decimals": 8,
      "features": ["withdraw"]
    },
    {
      "rampType": "on-ramp",
      "type": "crypto",
      "network": "ethereum",
      "method": "crypto-transaction",
      "asset": "ETH",
      "decimals": 18,
      "features": ["withdraw"]
    }
  ]
}
```

Only offer the crypto rails whose `features` include `withdraw`: those are the assets and networks an on-ramp order can deliver to. The asset the user selects (`XRP` in this walkthrough) and its `network` (`xrp-ledger`) become the destination of the order.

**/core/networks/xrp-ledger/validate-address**

```bash cURL theme={null}
curl -X POST "https://api.enterprise.uphold.com/core/networks/xrp-ledger/validate-address" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY",
  "reference": "67809592"
}'
```

```js JavaScript theme={null}
const response = await fetch("https://api.enterprise.uphold.com/core/networks/xrp-ledger/validate-address", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    address: "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY",
    reference: "67809592",
  }),
});

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.request(
  "POST",
  "https://api.enterprise.uphold.com/core/networks/xrp-ledger/validate-address",
  headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "Content-Type": "application/json",
  },
  json={
    "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY",
    "reference": "67809592",
  }
)

data = response.json()
```

```java Java theme={null}
import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();
var req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.enterprise.uphold.com/core/networks/xrp-ledger/validate-address"))
    .header("Authorization", "Bearer <ACCESS_TOKEN>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
        {
          "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY",
          "reference": "67809592"
        }"""))
    .build();

var response = client.send(req, HttpResponse.BodyHandlers.ofString());
var body = response.body();
```

```json Response theme={null}
{
  "isValid": true
}
```

Validate the `address` and the `reference` (the destination tag on the XRP Ledger) before creating the quote, so an invalid address is caught before the order is placed. When `isValid` is `false`, the `error.code` (`address_invalid`, `reference_invalid` or `reference_missing`) tells you what to ask the user to fix.

Instead of a crypto address, the destination can be a saved [crypto external account](https://developer.uphold.com/developer-guides/crypto-transfers/withdrawal/via-rest-api.md), referenced by its `id`.

**/core/external-accounts**

```bash cURL theme={null}
curl -X GET "https://api.enterprise.uphold.com/core/external-accounts" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-On-Behalf-Of: user <user-id>"
```

```js JavaScript theme={null}
const response = await fetch("https://api.enterprise.uphold.com/core/external-accounts", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "X-On-Behalf-Of": "user <user-id>",
  },
});

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.request(
  "GET",
  "https://api.enterprise.uphold.com/core/external-accounts",
  headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "X-On-Behalf-Of": "user <user-id>",
  }
)

data = response.json()
```

```java Java theme={null}
import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();
var req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.enterprise.uphold.com/core/external-accounts"))
    .header("Authorization", "Bearer <ACCESS_TOKEN>")
    .header("X-On-Behalf-Of", "user <user-id>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(req, HttpResponse.BodyHandlers.ofString());
var body = response.body();
```

```jsonc Response theme={null}
{
  "externalAccounts": [
    {
      "id": "7dc5c846-5ac2-4853-b67f-005cb83d4017",
      "ownerId": "cd21b26d-35d2-408a-9201-b8fdbef7a604",
      "type": "card",
      "status": "ok",
      "label": "My Visa Card",
      "asset": "USD",
      "network": "visa",
      "features": ["deposit", "withdraw"],
      "details": {
        "type": "debit",
        "last4Digits": "4242",
        "expiryDate": { "month": 12, "year": 2028 }
        // ...
      }
      // ...
    }
  ]
}
```

Before offering card payments, call [List rails](https://developer.uphold.com/rest-apis/on-off-ramp-api/assets/list-rails.md) with `rampType=on-ramp` and `type=card` to check that a card rail with the `deposit` feature is available. Then let the user pick a card with `status: "ok"` and `deposit` in its `features`. Its `id` becomes the origin of the quote. If the user has no card yet, have them [link a new card](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md#link-or-select-the-card) first.

When the user pays with an alternative payment method (APM) instead, such as Apple Pay or PayPal, the Payment Widget authorizes the payment and creates the order. See [Pay with an APM](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md#pay-with-an-apm).

> [!NOTE]
>
> This call and the quote and order calls that follow are made on behalf of the user. With an organization-wide client, send the `X-On-Behalf-Of: user <user-id>` header. A single-user client can leave it out. See [Subjects](https://developer.uphold.com/rest-apis/authentication.md#subjects).

**/on-off-ramp/orders/quote**

```bash cURL theme={null}
curl -X POST "https://api.enterprise.uphold.com/on-off-ramp/orders/quote" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-On-Behalf-Of: user <user-id>" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "on-ramp",
  "origin": {
    "type": "external-account",
    "id": "7dc5c846-5ac2-4853-b67f-005cb83d4017"
  },
  "destination": {
    "type": "crypto-address",
    "asset": "XRP",
    "network": "xrp-ledger",
    "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY",
    "reference": "67809592"
  },
  "denomination": {
    "asset": "USD",
    "amount": "100.00",
    "target": "origin"
  }
}'
```

```js JavaScript theme={null}
const response = await fetch("https://api.enterprise.uphold.com/on-off-ramp/orders/quote", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "X-On-Behalf-Of": "user <user-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    type: "on-ramp",
    origin: { type: "external-account", id: "7dc5c846-5ac2-4853-b67f-005cb83d4017" },
    destination: {
      type: "crypto-address",
      asset: "XRP",
      network: "xrp-ledger",
      address: "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY",
      reference: "67809592",
    },
    denomination: { asset: "USD", amount: "100.00", target: "origin" },
  }),
});

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.request(
  "POST",
  "https://api.enterprise.uphold.com/on-off-ramp/orders/quote",
  headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "X-On-Behalf-Of": "user <user-id>",
    "Content-Type": "application/json",
  },
  json={
    "type": "on-ramp",
    "origin": {"type": "external-account", "id": "7dc5c846-5ac2-4853-b67f-005cb83d4017"},
    "destination": {
      "type": "crypto-address",
      "asset": "XRP",
      "network": "xrp-ledger",
      "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY",
      "reference": "67809592",
    },
    "denomination": {"asset": "USD", "amount": "100.00", "target": "origin"},
  }
)

data = response.json()
```

```java Java theme={null}
import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();
var req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.enterprise.uphold.com/on-off-ramp/orders/quote"))
    .header("Authorization", "Bearer <ACCESS_TOKEN>")
    .header("X-On-Behalf-Of", "user <user-id>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
        {
          "type": "on-ramp",
          "origin": {
            "type": "external-account",
            "id": "7dc5c846-5ac2-4853-b67f-005cb83d4017"
          },
          "destination": {
            "type": "crypto-address",
            "asset": "XRP",
            "network": "xrp-ledger",
            "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY",
            "reference": "67809592"
          },
          "denomination": {
            "asset": "USD",
            "amount": "100.00",
            "target": "origin"
          }
        }"""))
    .build();

var response = client.send(req, HttpResponse.BodyHandlers.ofString());
var body = response.body();
```

```jsonc Response theme={null}
{
  "quote": {
    "id": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
    "type": "on-ramp",
    "pricing": "locked",
    "origin": {
      "asset": "USD",
      "amount": "100.00",
      "node": { "type": "external-account", "id": "7dc5c846-5ac2-4853-b67f-005cb83d4017", "via": "card", "network": "visa" }
      // ...
    },
    "destination": {
      "asset": "XRP",
      "amount": "46.125658",
      "node": { "type": "crypto-address", "network": "xrp-ledger", "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY", "reference": "67809592" }
      // ...
    },
    "fees": [
      { "type": "deposit", "code": "on-ramp-deposit", "asset": "USD", "amount": "1.00", "percentage": "1", "beneficiary": "uphold" },
      { "type": "network", "code": "crypto-network", "asset": "USD", "amount": "3.51" }
    ],
    "requirements": [
      { "name": "authorize:3ds", "quoteId": "b0a0e8d4-3c4e-4f3a-9d1e-6f5b2c7a8e91" }
    ],
    "refreshAt": "2024-07-24T15:22:39.000Z",
    "expiresAt": "2024-07-24T15:22:39.000Z"
    // ...
  }
}
```

Show the user `origin.amount`, `destination.amount` and the `fees`. Quotes are short-lived: if the user hasn't confirmed by `refreshAt`, create a new quote and show the updated amounts.

You resolve the `authorize:3ds` requirement when you create the order, in the next step. If the quote also lists `travel-rule`, resolve it before creating the order, as described in [Travel rule](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md#travel-rule).

**/on-off-ramp/orders**

```bash cURL theme={null}
curl -X POST "https://api.enterprise.uphold.com/on-off-ramp/orders" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-On-Behalf-Of: user <user-id>" \
  -H "Content-Type: application/json" \
  -H "X-Uphold-User-Ip: <user-ip>" \
  -H "X-Uphold-User-Agent: <user-agent>" \
  -d '{
  "quoteId": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
  "params": {
    "requirements": [
      { "name": "authorize:3ds", "returnUrl": "https://example.com/redirect?quoteId=623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0" }
    ]
  }
}'
```

```js JavaScript theme={null}
const response = await fetch("https://api.enterprise.uphold.com/on-off-ramp/orders", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "X-On-Behalf-Of": "user <user-id>",
    "Content-Type": "application/json",
    "X-Uphold-User-Ip": "<user-ip>",
    "X-Uphold-User-Agent": "<user-agent>",
  },
  body: JSON.stringify({
    quoteId: "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
    params: {
      requirements: [{ name: "authorize:3ds", returnUrl: "https://example.com/redirect?quoteId=623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0" }],
    },
  }),
});

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.request(
  "POST",
  "https://api.enterprise.uphold.com/on-off-ramp/orders",
  headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "X-On-Behalf-Of": "user <user-id>",
    "Content-Type": "application/json",
    "X-Uphold-User-Ip": "<user-ip>",
    "X-Uphold-User-Agent": "<user-agent>",
  },
  json={
    "quoteId": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
    "params": {
      "requirements": [{"name": "authorize:3ds", "returnUrl": "https://example.com/redirect?quoteId=623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0"}],
    },
  }
)

data = response.json()
```

```java Java theme={null}
import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();
var req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.enterprise.uphold.com/on-off-ramp/orders"))
    .header("Authorization", "Bearer <ACCESS_TOKEN>")
    .header("X-On-Behalf-Of", "user <user-id>")
    .header("Content-Type", "application/json")
    .header("X-Uphold-User-Ip", "<user-ip>")
    .header("X-Uphold-User-Agent", "<user-agent>")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
        {
          "quoteId": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
          "params": {
            "requirements": [
              { "name": "authorize:3ds", "returnUrl": "https://example.com/redirect?quoteId=623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0" }
            ]
          }
        }"""))
    .build();

var response = client.send(req, HttpResponse.BodyHandlers.ofString());
var body = response.body();
```

```jsonc Response theme={null}
{
  "order": {
    "id": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
    "type": "on-ramp",
    "pricing": "locked",
    "origin": {
      "asset": "USD",
      "amount": "100.00",
      "node": {
        "type": "external-account",
        "id": "7dc5c846-5ac2-4853-b67f-005cb83d4017",
        "via": "card",
        "network": "visa",
        "confirmationUrl": "https://authentication-devices.sandbox.checkout.com/sessions-interceptor/sid_zrih63pnk6ietkpuerqiyd5zga"
      }
      // ...
    },
    "destination": {
      "asset": "XRP",
      "amount": "46.125658",
      "node": { "type": "crypto-address", "network": "xrp-ledger", "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY", "reference": "67809592" }
      // ...
    },
    "status": "processing",
    "timeline": [],
    "createdAt": "2024-07-24T15:03:39.000Z"
    // ...
  }
}
```

Always send the `authorize:3ds` requirement with a `returnUrl`, since the card issuer may require a 3DS challenge. The `X-Uphold-User-Ip` and `X-Uphold-User-Agent` headers are required with it: leaving them out fails with a `409` `operation_not_allowed` error.

Optionally, attach your own `metadata` to the order, such as an `externalId`.

If the request is rejected, no order is created. See [Request errors](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md#request-errors) for how to handle each error.

### Redirect to `confirmationUrl`

When the order has `origin.node.confirmationUrl`, the card issuer requires a 3DS challenge. Redirect the user to that URL, where they approve the payment:

```js JavaScript theme={null}
// `data` is the Create order response from the previous step.
const { confirmationUrl } = data.order.origin.node;

if (confirmationUrl) {
  window.location.assign(confirmationUrl);
}
```

After the challenge, the issuer redirects the user back to the `returnUrl` you sent when creating the order. To resume the flow, add state to its query parameters when you create the order, such as the `quoteId` or your own reference:

```
https://example.com/redirect?quoteId=623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0
```

The redirect doesn't tell you whether the payment succeeded. When the user is back, show them that the order was placed, then follow the order to learn the outcome, as shown in the next steps.

> [!NOTE]
>
> When `confirmationUrl` is absent, no challenge is needed and the order continues without any action from the user. If the challenge fails or isn't completed in time, the order becomes `failed` with the reason `card-declined` or `card-declined-by-bank`. See [Failure reasons](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md#failure-reasons).

**/on-off-ramp/orders/623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0**

```bash cURL theme={null}
curl -X GET "https://api.enterprise.uphold.com/on-off-ramp/orders/623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-On-Behalf-Of: user <user-id>"
```

```js JavaScript theme={null}
const response = await fetch("https://api.enterprise.uphold.com/on-off-ramp/orders/623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "X-On-Behalf-Of": "user <user-id>",
  },
});

const data = await response.json();
```

```python Python theme={null}
import requests

response = requests.request(
  "GET",
  "https://api.enterprise.uphold.com/on-off-ramp/orders/623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
  headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "X-On-Behalf-Of": "user <user-id>",
  }
)

data = response.json()
```

```java Java theme={null}
import java.net.http.*;
import java.net.URI;

var client = HttpClient.newHttpClient();
var req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.enterprise.uphold.com/on-off-ramp/orders/623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0"))
    .header("Authorization", "Bearer <ACCESS_TOKEN>")
    .header("X-On-Behalf-Of", "user <user-id>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(req, HttpResponse.BodyHandlers.ofString());
var body = response.body();
```

```jsonc Response theme={null}
{
  "order": {
    "id": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
    "type": "on-ramp",
    "pricing": "locked",
    "status": "processing",
    "origin": {
      "asset": "USD",
      "amount": "100.00",
      "node": { "type": "external-account", "id": "7dc5c846-5ac2-4853-b67f-005cb83d4017", "via": "card", "network": "visa" }
      // ...
    },
    "destination": {
      "asset": "XRP",
      "amount": "46.125658",
      "node": { "type": "crypto-address", "network": "xrp-ledger", "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY", "reference": "67809592" }
      // ...
    },
    "timeline": [
      { "event": "deposit-processing", "timestamp": "2024-07-24T15:03:39.000Z" }
    ],
    "createdAt": "2024-07-24T15:03:39.000Z",
    "updatedAt": "2024-07-24T15:03:39.000Z"
    // ...
  }
}
```

When the user is back on your `returnUrl`, find the order you created for the `quoteId` in its query, and call [Get order](https://developer.uphold.com/rest-apis/on-off-ramp-api/orders/get-order.md) to show its current state. If there was no 3DS challenge, show this right after creating the order.

The order is `processing`: Uphold is collecting the payment. Show the user that the order was placed, with the amount they pay, the crypto they receive and the destination address, but don't present it as complete, since the crypto hasn't been sent yet.

> [!NOTE]
>
> **Webhook event:** `on-off-ramp.order.timeline-updated`

```jsonc Webhook payload theme={null}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "on-off-ramp.order.timeline-updated",
  "createdAt": "2024-07-24T15:04:39.000Z",
  "data": {
    "order": {
      "id": "623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0",
      "type": "on-ramp",
      "status": "processing",
      "origin": {
        "asset": "USD",
        "amount": "100.00",
        "node": { "type": "external-account", "id": "7dc5c846-5ac2-4853-b67f-005cb83d4017", "via": "card", "network": "visa" }
        // ...
      },
      "destination": {
        "asset": "XRP",
        "amount": "46.125658",
        "node": { "type": "crypto-address", "network": "xrp-ledger", "address": "rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY", "reference": "67809592" }
        // ...
      },
      "timeline": [
        { "event": "deposit-processing", "timestamp": "2024-07-24T15:03:39.000Z" },
        { "event": "deposit-completed", "timestamp": "2024-07-24T15:04:39.000Z" }
      ],
      "updatedAt": "2024-07-24T15:04:39.000Z"
      // ...
    }
  }
}
```

The order stays `processing` while Uphold collects the payment, converts it and sends the crypto. Each stage is added to the `timeline` as an event, such as `deposit-completed` once the card payment succeeds and `withdrawal-sent` once the crypto is on its way, and each new event sends an [Order timeline updated](https://developer.uphold.com/rest-apis/on-off-ramp-api/orders/webhooks/order-timeline-updated.md) webhook.

Use the events to show the user how far along their order is. In this walkthrough, each row of the order status screen shows one event of the `timeline`, with the time of its `timestamp`:

| Timeline event | What it means |
| - | - |
| `deposit-processing` | Uphold is collecting the card payment. |
| `deposit-completed` | The card payment succeeded. |
| `withdrawal-processing` | Uphold is sending the crypto. |
| `withdrawal-sent` | The crypto is on its way. |
| `withdrawal-completed` | The crypto was delivered to the destination address. |

If webhook delivery cannot be guaranteed, poll [Get order](https://developer.uphold.com/rest-apis/on-off-ramp-api/orders/get-order.md) as a fallback, with the same request as in the previous step.

When the crypto is delivered, the order becomes `completed`, which the [Order status changed](https://developer.uphold.com/rest-apis/on-off-ramp-api/orders/webhooks/order-status-changed.md) webhook tells you. Show the user a final confirmation, and send an email if applicable.

An order can also become `on-hold` while a leg is under review, or `failed`. See [Handle failures](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md#handle-failures) and [Handle on-hold orders](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md#handle-on-hold-orders).

***

For the full prose walkthrough, including prerequisites, paying with an alternative payment method (APM), the travel rule, request errors and failure reasons, see the [On-ramp with a pull deposit via the REST API](https://developer.uphold.com/developer-guides/on-off-ramp/on-ramp/via-rest-api/pull-deposit.md) guide.
