---
title: "Get order details"
method: GET
path: "/order"
tags: ["Order"]
---

# Get order details

`GET /order`

Returns the order details for a given order ID

## Query parameters

- `id` string, string, required

## Response `200`

Order response

- object
  - `status` string, string
  - `data` Order
    - `orderId` string, string
    - `quoteId` string, string
    - `status` 'PAID' | 'PENDING' | 'EXPIRED' | 'FAILED', string
    - `currency` 'NGN' | 'KES', string
    - `paymentCollectionMethod` 'LIGHTNING' | 'ONCHAIN' | 'USDT', string
    - `isValid` boolean
    - `displayAmount` string, string
    - `paymentBtcDetail` string, string
    - `createdAt` string, date-time
    - `quotes` Quote[]
      - `id` string, uuid
      - `exchangeRate` number — The exchange rate is the rate of 1 BTC to the targetCurrency. So if you generated a quote for NGN->BTC (targetCurrency is BTC), the rate will be 1 because the exchange rate of 1 BTC to BTC is 1. If it's a quote of BTC->NGN (targetCurrency is NGN), the rate will likely be 103830225.71866913 i.e., 1 BTC to NGN
      - `usdToTargetCurrencyRate` number — The USD to target currency rate for the quote
      - `sourceCurrency` 'BTCSAT' | 'NGNKOBO', string — The source currency for the quote
      - `targetCurrency` 'NGNKOBO' | 'KESCENT' | 'ZARCENT' | 'GHSPESEWA', string — The target currency for the quote
      - `transactionFeesInSourceCurrency` number — The transaction fees in the source currency in its lowest denomination
      - `transactionFeesInTargetCurrency` string, string — The transaction fees in the target currency in its lowest denomination
      - `amountInSourceCurrency` number — The amount in the source currency in its lowest denomination
      - `amountInTargetCurrency` string, string — The amount in the target currency in its lowest denomination
      - `paymentMethod` 'LIGHTNING', string
      - `expiry` string, date-time
      - `isValid` boolean
      - `invoice` string, string — The lightning invoice to pay for the quote
      - `hash` string, string — The payment hash for the lightning invoice attached to the quote
      - `customerReference` string, string — Your unique identifier for the quote
      - `totalAmountInSourceCurrency` number — The total amount in the source currency in its lowest denomination
      - `customerInternalFee` number — An internal fee you can set to charge the customer. This fee is in the source currency in its lowest denomination
      - `createdAt` string, date-time — The date and time the quote was created
      - `updatedAt` string, date-time — The date and time the quote was last updated
      - `bankName` string, string — Bank name for NGN bank transfer (when paymentMethod is BANKTRANSFER)
      - `ngnBankAccountNumber` string, string — Bank account number for NGN payment (when paymentMethod is BANKTRANSFER)
      - `ngnAccountName` string, string — Account name for NGN payment (when paymentMethod is BANKTRANSFER)
      - `ngnBankCode` string, string — NIP bank code for NGN payment (when paymentMethod is BANKTRANSFER)
      - `orderId` string, string — Unique order identifier for tracking
      - `estimatedRoutingFee` number — Estimated routing fee for Lightning Network payments in satoshis
    - `transactions` Transaction[]
      - `id` string, uuid — The unique identifier for the transaction
      - `walletId` string, uuid — The unique identifier for the wallet
      - `ref` string, string — The reference for the transaction
      - `hash` string, string — The payment hash for the lightning invoice attached to the quote related to the transaction
      - `amount` number — The amount of the transaction in its lowest denomination
      - `fees` number — The fees for the transaction in its lowest denomination
      - `currency` 'NGN' | 'KES' | 'BTC' | 'ZAR' | 'GHS', string — The currency of the transaction
      - `type` 'WITHDRAWAL' | 'DEPOSIT', string — The type of the transaction
      - `status` 'SUCCESS' | 'PENDING' | 'FAILED', string — The status of the transaction
      - `autopayout` boolean — Whether the transaction is an instant payout
      - `createdAt` string, date-time — The date and time the transaction was created
      - `updatedAt` string, date-time — The date and time the transaction was last updated
      - `metadata` TransactionMetadata
        - `id` string, uuid
        - `orderId` string, string
        - `bankCode` string, string
        - `bankAccountName` string, string
        - `bankAccountNumber` string, string
        - `customerInternalFee` number
        - `createdAt` string, date-time
        - `updatedAt` string, date-time

## Other responses

- `400` — Unexpected error

---

[API](https://skmtc.net/stealthmoney/apis/mavapay-api.md) · [All operations](https://skmtc.net/stealthmoney/apis/mavapay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stealthmoney/mavapay-api/revisions/94cb0ddffad0/schema)