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.

Pre-qualification session flow

Merchants should call the Pre-qual session API for their customers to assess their max spending limit and available payment plans.

Integration sequence

Merchants may implement the Tamara pre-qual session flow across existing and custom merchant assets, similar to widgets:

  1. Customer clicks on the respective button to start the pre-qual session.
  2. Merchant calls the Pre-qual session API from backend.
  3. Merchant opens the returned URL for the customer (HTTP redirect or webview).
  4. Customer inputs the phone number and amount, completes the pre-qual check.
  5. Customer is redirected to the specified merchant page.

Timeout

Merchants should configure a 1s timeout for the Pre-qual session API.

If Tamara API does not respond within 1s, then no Pre-qual session will be generated.

📘

Each successful request creates a new
session (no idempotency key). Sessions expire after a short TTL (typically 30 minutes).

Testing

Currently, this API is only available for production mode, so please enter real phone numbers for simulating the flow.

Currently, the user needs to input the phone number manually in the session.


Body Params
string
enum
required
Defaults to SA

The two-character ISO 3166-1 country code

Allowed:
string
required
Defaults to https://testsite.com

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

  • host).
boolean
required
Defaults to true

true for merchant webview; false for browser.

string
enum
Defaults to en_US

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

Allowed:
string
Defaults to 566027755

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

prequal_amount
object

Optional preset amount for the session.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json