---
title: "Get Order Details"
method: GET
path: "/api/v1/orders/{ref}"
tags: ["Order"]
---

# Get Order Details

`GET /api/v1/orders/{ref}`

## Request

- Base URL: `https://secure.telr.com`
- URL: `https://secure.telr.com/api/v1/orders/{ref}`
- Auth: HTTP basic

Retrieve details of a specific order.

## Path parameters

- `ref` string, required

## Response `200`

Order details retrieved successfully.

- object
  - `ref` string, required
  - `status` 'PENDING' | 'AUTHORISED' | 'PAID' | 'CANCELLED' | 'DECLINED', required
  - `cartId` string
  - `amount` Amount
    - `value` number, float
    - `currency` string
  - `customer` Billing
    - `ref` string
    - `email` string, email, required
    - `name` object, required
      - `title` string
      - `firstName` string
      - `lastName` string
    - `address` object, required
      - `line1` string
      - `line2` string
      - `line3` string
      - `city` string
      - `country` string, required: 2-letter ISO country code
    - `phone` string
  - `payment` PaymentBase
    - `type` 'CARD' | 'APPLE_PAY' | 'SAMSUNG_PAY' | 'STC_PAY' | 'TABBY', required
    - `scheme` 'VISA' | 'MASTERCARD' | 'AMEX' | 'MADA' | 'JCB'
    - `status` 'P' | 'A' | 'D' | 'H' | 'E', required: Status of a payment: - **P** = Pending - **A** = Authorised - **D** = Declined - **H** = On Hold - **E** = Error Status other pending can be treated as final response for a payment
    - `message` string
    - `reference` string
    - `code` string: authorisation code or error code

## Other responses

- `400`: Bad request
- `401`: Forbidden
- `403`: Forbidden
- `500`: Internal server error

---

[API](https://skmtc.dev/telr/apis/telr-payments-api.md) - [All operations](https://skmtc.dev/telr/apis/telr-payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/telr/apis/telr-payments-api/revisions/2dfc3debc932?raw)