---
title: "Create session with Jeelpay parameters"
method: POST
path: "/order.json (COPY-1)"
---

# Create session with Jeelpay parameters

`POST /order.json (COPY-1)`

## Request

- Base URL: `https://secure.telr.com/gateway`
- URL: `https://secure.telr.com/gateway/order.json (COPY-1)`
- Auth: none required

Retrieve URL for hosted payment page with Jeelpay parameters

## Headers

- `Content-Type` string, required

## Request body

- object
  - `method` string, required: The request method being used. Set to ‘create’ to generate a new transaction.
  - `store` integer, required: Your store ID. Numeric value only.
  - `authkey` string, required: Your authentication key
  - `framed` integer: Framed display. 0 - Standard full screen payment page, 1 - Framed payment page, 2 - Framed payment page as the initial display, but the process can break out of the frame to a full page display if required by any payment method
  - `order` object, required: Order details.
    - `cartid` string, required: Cart ID / Order ID. Your reference for the transaction. For example, this could be a cart ID or order ID generated by your shopping system. This must be unique for each request. Maximum length is 63 characters.
    - `test` string: Test mode indicator: 0 = Live, 1 = Test
    - `amount` string, required: Transaction amount. In major units, for example 9 dollars 50 cents must be sent as 9.50 not 950.
    - `currency` string, required: Currency the transaction is in. 3 character ISO code. For reference: https://www.iban.com/country-codes
    - `description` string, required: Purchase description. Maximum length is 63 characters.
    - `trantype` string: Transaction Type. Optional. Configured default in merchant admin is used if not set.
  - `return` object, required: These are URLs within your site, where the shopper will be directed to once the transaction process is complete.
    - `authorised` string, required: URL for authorized transactions
    - `declined` string, required: URL for declined transactions
    - `cancelled` string, required: URL for cancelled transactions
  - `jeelpay` object
    - `schoolName` string: School Name - length between 2 and 50
    - `customer` object
      - `nationalId` string: Jeelpay customer national ID - 10 digit
      - `phone` string: Jeelpay customer phone number must be valid KSA number starting with 5
    - `students` object[]: Students : Only one student object is supported
      - `nationalId` string: Jeelpay student national Id - 10 digit
      - `name` string: Jeelpay student name - Max length 50
      - `academicYear` string: Jeelpay student academic year: YYYY or YYYY-YYYY Eg: "2025" or "2024-2025"

## Response `200`

200

- union
  - object
    - `method` string
    - `order` object
      - `ref` string
      - `url` string
  - object
    - `method` string
    - `error` object
      - `message` string
      - `note` string

---

[API](https://skmtc.dev/telr/apis/payment-page.md) - [All operations](https://skmtc.dev/telr/apis/payment-page/llms.txt) - [OpenAPI document](https://skmtc.dev/telr/apis/payment-page/revisions/266cd8a9748a?raw)