v1

latestOpenAPI 3.0.32026-07-2418074.2 KB

Pre-Qualification Session

This endpoint helps you to initiate a pre-qual session for your customers, so they can know exactly how much they can spend with Tamara.

post/prequal/v1/session

Request body

country_code'SA' | 'AE' required

The two-character ISO 3166-1 country code

redirect_urlstring required

Post-flow return URL. Must be a valid HTTPS URL (scheme

  • host).
is_webviewboolean required

true for merchant webview; false for browser.

locale'en_US' | 'ar_SA'

Display language for the prequal UI (RFC 1766). Allowed: ar_SA, en_US. Same as Create Checkout Session.

phone_numberstring

Customer phone number. Same field name as checkout consumer.phone_number. Example: 566027755.

Response

Created

prequal_session_idstring required

UUID of the created session.

urlstring required

Customer UI URL. When locale is provided, it is included as a query parameter. phone_number is stored on the session and is not placed in the URL