Integration Checkout

Create a new items checkout

post

This endpoint creates a new items checkout without creating an installment request. If the group has multiple entities, each item must specify an entity ID. The customer will be redirected to a checkout page where they can register/login and review the items information.

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

reference_idstring · max: 255Optional

The reference ID for the checkout

Example: order_12345

Responses

200

The checkout is created successfully

*/*

checkout_idstring · uuidOptional

The checkout ID

redirect_urlstring · uriOptional

The URL to redirect the user to

creation_datestring · date-timeOptional

The creation date of the checkout

reference_idstringOptional

The reference ID associated with the checkout

400

Validation errors, group type mismatch (schooling groups), or missing entity IDs for multi-entity groups

*/*

401

Access is denied or invalid token

*/*

500

Unexpected Technical Runtime Error

*/*

post

/v3/checkout

HTTPcURLJavaScriptPython

POST /v3/checkout HTTP/1.1
Host: api.sandbox.jeel.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 506

{
  "reference_id": "order_12345",
  "buyer": {
    "first_name": "أحمد",
    "last_name": "محمد",
    "mobile_number": "501234567",
    "email": "[email protected]",
    "national_id": "1234567890"
  },
  "items": [
    {
      "item_name": "دورة تدريبية",
      "quantity": 1,
      "unit_price": 25000,
      "total_cost": 25000,
      "reference_id": "text",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "urls": {
    "redirect_url": "https://website.com/jeel/confirm",
    "notification_url": "https://website.com/webhook/jeel"
  },
  "metadata": {
    "key 1": "value 1",
    "key 2": "value 2"
  }
}

{
  "checkout_id": "123e4567-e89b-12d3-a456-426614174000",
  "redirect_url": "https://example.com",
  "creation_date": "2026-03-20T11:49:40.002Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "reference_id": "text"
}

Create a new schooling checkout

post

This endpoint creates a new schooling checkout without creating an installment request. The customer will be redirected to a checkout page where they can register/login and review the student information.

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

reference_idstring · max: 255Optional

The reference ID for the checkout

Example: order_12345

Responses

200

The checkout is created successfully

*/*

checkout_idstring · uuidOptional

The checkout ID

redirect_urlstring · uriOptional

The URL to redirect the user to

creation_datestring · date-timeOptional

The creation date of the checkout

reference_idstringOptional

The reference ID associated with the checkout

400

Validation errors or group type mismatch (non-schooling groups)

*/*

401

Access is denied or invalid token

*/*

404

Group not found

*/*

500

Unexpected Technical Runtime Error

*/*

post

/v3/checkout/schooling

HTTPcURLJavaScriptPython

POST /v3/checkout/schooling HTTP/1.1
Host: api.sandbox.jeel.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 537

{
  "reference_id": "order_12345",
  "buyer": {
    "first_name": "أحمد",
    "last_name": "محمد",
    "mobile_number": "501234567",
    "email": "[email protected]",
    "national_id": "1234567890"
  },
  "students": [
    {
      "national_id": "1104448787",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "educational_year_id": "123e4567-e89b-12d3-a456-426614174000",
      "reference_id": "text",
      "name": "فهد",
      "cost": 25000
    }
  ],
  "urls": {
    "redirect_url": "https://website.com/jeel/confirm",
    "notification_url": "https://website.com/webhook/jeel"
  },
  "metadata": {
    "key 1": "value 1",
    "key 2": "value 2"
  }
}

{
  "checkout_id": "123e4567-e89b-12d3-a456-426614174000",
  "redirect_url": "https://example.com",
  "creation_date": "2026-03-20T11:49:40.002Z",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "reference_id": "text"
}

Get checkout details

get

This endpoint returns the checkout details for the given checkout ID.

Authorizations

JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Responses

200

Checkout details retrieved successfully

*/*

checkout_idstring · uuidOptional

The checkout ID

checkout_typestring · enumOptional

The type of checkout

Possible values:

reference_idstringOptional

The reference ID associated with the checkout

statusstring · enumOptional

The status of the checkout

Possible values:

401

Access is denied or invalid token

*/*

404

Checkout not found with the provided ID

*/*

500

Unexpected Technical Runtime Error

*/*

get

/v3/checkout/{id}

HTTPcURLJavaScriptPython

GET /v3/checkout/{id} HTTP/1.1
Host: api.sandbox.jeel.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "checkout_id": "123e4567-e89b-12d3-a456-426614174000",
  "checkout_type": "SCHOOLING",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "reference_id": "text",
  "status": "PENDING"
}