---
title: "Create a new order"
method: POST
path: "/api/v1/orders"
tags: ["Order"]
---

# Create a new order

`POST /api/v1/orders`

## Request body

- CreateOrderRequest
  - `transactionType` 'SALE' | 'AUTH' | 'VERIFY'
  - `cartId` string, required
  - `amount` Amount, required
    - `value` number, float
    - `currency` string
  - `description` string
  - `customer` Billing, required
    - `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
  - `test` boolean
  - `filter` object
    - `cards` string[] — Allow List of card BINs or masked card numbers (e.g., "411111" for BIN, "412535-7256" for masked card).
  - `webhooks` object[] — list of webhook objects
    - `url` string — url of webhook

## Response `201`

Order created successfully

- object
  - `ref` string, required
  - `status` 'PENDING' | 'AUTHORISED' | 'PAID' | 'CANCELLED' | 'DECLINED', required
  - `cartId` string
  - `amount` Amount
    - `value` number, float
    - `currency` string
  - `_links` object — Hypermedia links related to the payment operation.
    - `self` object — Link to get Order.
      - `method` 'GET' — HTTP method.
      - `href` string — Endpoint for retrieving order details. This is the OrderUrl that should be passed to the SDK.
    - `auth` object — Endpoint to obtain the auth token for this specific order. It returns success only on the first call with the order reference. The resulting tokenUrl must be passed to the SDK.
      - `method` 'GET' — HTTP method.
      - `href` string — Endpoint to get auth token.

## Other responses

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

---

[API](https://skmtc.dev/telr/apis/remote-json-api-1-0.md) · [All operations](https://skmtc.dev/telr/apis/remote-json-api-1-0/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/telr/remote-json-api-1-0/revisions/7a1969c709ba/schema)