Sign in

v1

latestOpenAPI 3.0.32026-07-2418074.2 KB
In-Store Checkout

Create In-store QR Code Checkout Session

This endpoint facilitates the creation of an In-Store checkout link that can be converted to a QR code, enabling customer payments via Tamara customer app using the Scan to Pay function. <br /> <br /> Please store the order_id and checkout_id received in response in your DBs as they might be needed later.

post/checkout/in-store

Headers

X-Device-Idstring number required

This is an identifier of your POS devices, e.g. 123456

Request body

order_reference_idstring

The unique order id from merchant side, this will be used with the settlement and reports

order_numberstring

Unique order ID from the merchant's side, which will be used for settlement and reporting purposes. Can be modified after the checkout session is created.

platformstring required
locale'ar_SA' | 'en_US'

Display language for Tamara checkout page. Language to be defined by the merchant following RFC 1766, e.g en_US or ar_SA. Default is set to Arabic if value not passed and customer is new. If customer already exists and locale is not passed then customer's preference will be taken into account.

Example request

{
  "amount": {
    "amount": 300,
    "currency": "SAR"
  },
  "order_reference_id": "1231234123-234a-fe21-1234-a324af2",
  "order_number": "A1231234123",
  "platform": "PARTNERNAME_POS_QR",
  "additional_data": {
    "store_code": "Branch A"
  }
}

Response

Checkout Session Created

checkout_idstring uuid
order_idstring uuid
checkout_deeplinkstring