---
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 of source currency to target currency for the quote. e.g 1 BTC = 5000000.23 NGN
      - `usdToTargetCurrencyRate` number — The USD to target currency rate for the quote
      - `sourceCurrency` 'BTCSAT' | 'NGNKOBO' | 'KESCENT' | 'ZARCENT', string — The source currency for the quote
      - `targetCurrency` 'NGNKOBO' | 'KESCENT' | 'ZARCENT', 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
      - `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
    - `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', string — The currency of the transaction
      - `type` 'WITHDRAWAL' | 'DEPOSIT' | 'TRANSFER', 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

## Changes

- **2025-02-01** `7b7e4fa5fe46` — 1 warning, 1 info
  - removed the optional property `data/transactions/items/transactionMetadata` from the response with the `200` status
  - added the optional property `data/transactions/items/metadata` to the response with the `200` status
- **2025-02-01** `c220a3435512` — 1 warning, 2 info
  - removed the optional property `data/quote` from the response with the `200` status
  - added the optional property `data/quotes` to the response with the `200` status
  - added the optional property `data/transactions` to the response with the `200` status
- **2024-06-15** `2830f1e470da` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/stealthmoney/apis/mavapay-api/changes/order/get.md)

---

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