Tamara

Tamara Pre-Checkout Eligibility API

Check whether Tamara considers a customer eligible for a BNPL purchase before exposing Tamara as a payment method on the merchant's checkout page. The endpoint accepts an order amount/currency and a customer phone number and returns a boolean eligibility indicator.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://docs.tamara.co/reference/pre-checkout-eligibility

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/tamara/refs/heads/main/openapi/tamara-eligibility-api-openapi.yml

OpenAPI Specification

openapi: 3.0.3
info:
  title: Tamara Channel Partners Captures Eligibility API
  description: 'Allow payment service providers, platforms, and aggregators to onboard merchants onto

    Tamara on their behalf. Submit merchant KYB/KYC information, retrieve onboarding

    status and merchant API keys, and register onboarding event webhooks.

    '
  version: 1.0.0
  contact:
    name: Tamara Partner Support
    url: https://docs.tamara.co/
servers:
- url: https://partner-api.tamara.co
  description: Production
- url: https://partner-api-sandbox.tamara.co
  description: Sandbox
tags:
- name: Eligibility
paths:
  /pre-checkout/v1/eligibility:
    post:
      operationId: preCheckoutEligibility
      summary: Pre-Checkout Eligibility
      description: 'Check whether the supplied customer (identified by phone number) is treated as

        eligible by Tamara for the order amount. If the phone number is not passed the

        customer is treated as eligible.

        '
      tags:
      - Eligibility
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EligibilityRequest'
      responses:
        '200':
          description: Eligibility decision.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EligibilityResponse'
        '400':
          description: Validation error.
components:
  schemas:
    EligibilityRequest:
      type: object
      required:
      - order
      properties:
        order:
          type: object
          required:
          - amount
          - currency
          properties:
            amount:
              type: number
              example: 300
            currency:
              type: string
              enum:
              - SAR
              - AED
              - BHD
              - KWD
              - OMR
        customer:
          type: object
          properties:
            phone:
              type: string
              description: E.164 phone number (omit to treat customer as eligible).
              example: '966501234567'
    EligibilityResponse:
      type: object
      properties:
        is_eligible:
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer