Documentation

Teya, all rights reserved. 2022 ©

Updated 16.03.2026

POS Loans
REST API Integration

Introduction

This document describes Teya's POS loan integration using the Consumer Loans API v3 (REST). It enables merchants to offer consumer loans through point of sale systems.

The POS system selects Teya consumer loan as payment. The customer receives an SMS with a URL to self-service a loan application on their mobile device. The POS system polls for status updates until the loan is approved or canceled.

Online Loan Flow

Image 1 - Overview of POS loan process from merchant to customer mobile device.

POS loan process

  1. Customer products have been scanned into POS system and consumer loan is selected as payment. GET /online/payment (List Payment Methods) is called to display available payment options. Merchant selects the payment option the customer prefers.
  2. Merchant enters customer phone number and presses Send SMS. POS system calls POST /online/token/sms (Create Token (SMS)). Loan status is set to CREATED and customer receives SMS with URL granting temporary access to Teya's loan application.
  3. POS system goes into waiting for payment mode and calls GET /online/status (Check Loan Status) every 3-5 seconds to monitor loan progress.
  4. Customer opens the URL and loan status is set to INPROGRESS. Customer applies for a loan confirming their identity with electronic identification.
  5. a) Customer starts loan evaluation and status updates to PENDING. Loan is successfully created and status updates to SUCCESS.
    b) Customer is not approved or presses Cancel. Loan status updates to CANCELED.
  6. a) POS system receives SUCCESS status from GET /online/status. The system calls PUT /online/validate (Validate Loan) to validate the loan and receive contract details (e.g., ContractNumber) to store as a reference ID.
    b) POS system receives CANCELED status. Merchant can choose another payment option or try again.

Process deviations

  • POS system calls PUT /online/cancel (Cancel Loan) to cancel the process. Loan status updates to CANCELED.
  • Status is set to TOKENEXPIRED when the SMS URL has not been opened within the time set by TokenValidMinutes (set when calling POST /online/token/sms). The POS system must issue a new SMS and restart the process.
  • Status is set to PROGRESSEXPIRED if the customer opened the URL but did not finish or cancel within ProgressValidMinutes. The POS system must issue a new SMS and restart.
  • Status is set to FAILED if PUT /online/validate (Validate Loan) is not successful. The response will provide failure details.