---
title: "Get off-ramp order"
method: GET
path: "/api/offramp/order/{id}"
tags: ["off-ramp"]
---

# Get off-ramp order

`GET /api/offramp/order/{id}`

Returns a single order by its ID.

## Path parameters

- `id` string, required

## Response `200`

Successful response

- OfframpOrder
  - `_id` string
  - `offerId` string
  - `paymentType` 'CRYPTO_WALLET' | 'VIRTUAL_WALLET' — - CRYPTO_WALLET: User will pay with a crypto wallet - VIRTUAL_WALLET: Order will be paid from a merchant's virtual wallet
  - `network` 'AVALANCHE' | 'POLYGON' | 'CELO' | 'ETHEREUM'
  - `asset` 'USDC' | 'USDT' | 'CUSD' | 'CKES'
  - `exchangeRate` number
  - `cashout` object
    - `localCurrencyAmount` number
    - `usdAmount` number
    - `feeAmountUsd` number
    - `feeAmountUsdFonbnk` number
    - `feeAmountUsdPartner` number
    - `feeAmountLocalCurrency` number
    - `feeAmountLocalCurrencyFonbnk` number
    - `feeAmountLocalCurrencyPartner` number
    - `cryptoAmount` number
    - `feeAmountCrypto` number
    - `feeAmountCryptoFonbnk` number
    - `feeAmountCryptoPartner` number
  - `fromAddress` string
  - `toAddress` string
  - `status` 'initiated' | 'awaiting_transaction_confirmation' | 'transaction_confirmed' | 'transaction_failed' | 'offramp_success' | 'offramp_pending' | 'offramp_failed' | 'offramp_retry' | 'refunding' | 'refunded' | 'refund_failed' | 'expired' | 'cancelled' | 'validating_transaction' | 'transaction_invalid' — - initiated: The offramp order has been initiated - awaiting_transaction_confirmation: User sent the transaction hash and system is awaiting confirmation - transaction_confirmed: User transaction has been confirmed - transaction_failed: User transaction has failed - offramp_success: The offramp transaction has been successful - offramp_pending: The offramp transaction is pending - offramp_failed: The offramp transaction has failed - offramp_retry: The offramp transaction is being retried - refunding: The offramp transaction is being refunded - refunded: The offramp transaction has been refunded - refund_failed: The offramp transaction refund has failed - expired: The offramp order has expired - cancelled: The offramp order has been cancelled by the user - validating_transaction: The offramp transaction is being validated - transaction_invalid: The offramp transaction is invalid
  - `createdAt` string, date-time
  - `expiresAt` string, date-time
  - `hash` string
  - `statusHistory` object[]
    - `status` 'initiated' | 'awaiting_transaction_confirmation' | 'transaction_confirmed' | 'transaction_failed' | 'offramp_success' | 'offramp_pending' | 'offramp_failed' | 'offramp_retry' | 'refunding' | 'refunded' | 'refund_failed' | 'expired' | 'cancelled' | 'validating_transaction' | 'transaction_invalid' — - initiated: The offramp order has been initiated - awaiting_transaction_confirmation: User sent the transaction hash and system is awaiting confirmation - transaction_confirmed: User transaction has been confirmed - transaction_failed: User transaction has failed - offramp_success: The offramp transaction has been successful - offramp_pending: The offramp transaction is pending - offramp_failed: The offramp transaction has failed - offramp_retry: The offramp transaction is being retried - refunding: The offramp transaction is being refunded - refunded: The offramp transaction has been refunded - refund_failed: The offramp transaction refund has failed - expired: The offramp order has expired - cancelled: The offramp order has been cancelled by the user - validating_transaction: The offramp transaction is being validated - transaction_invalid: The offramp transaction is invalid
    - `changedAt` string, date-time
  - `requiredFields` object — Fields that was required to be filled by the user
  - `countryIsoCode` string
  - `userPhoneNumber` string
  - `userEmail` string
  - `currencyIsoCode` string
  - `offerRequiredFields` object[]
    - `label` string
    - `type` string
    - `value` string
  - `orderParams` string

---

[API](https://skmtc.net/fonbnk/apis/fonbnk-on-ramp-api.md) · [All operations](https://skmtc.net/fonbnk/apis/fonbnk-on-ramp-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fonbnk/fonbnk-on-ramp-api/versions/bae5de6fca88/schema)