Create In-store QR Code Checkout Session

post

https://{environment}.tamara.co/checkout/in-store

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.

Please store the order_id and checkout_id received in response in your DBs as they might be needed later.

Body Params

amount

object

required

Total amount to be charged to consumer.

order_reference_id

string

Defaults to 1231234123-234a-fe21-1234-a324af2

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

order_number

string

Defaults to A1231234123

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.

platform

string

required

Defaults to PARTNERNAME_POS_QR

locale

string

enum

Defaults to ar_SA

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.

Allowed:

additional_data

object

Additional order data information from the merchant side

Headers

X-Device-Id

string

required

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

Responses

Language

Credentials

Bearer

URL

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Checkout Session Created

400Unsupported Country/Currency