Overview
Our Buy Now Pay Later (BNPL) services offer flexible payment options that empower customers to make purchases immediately while paying over time. By removing financial barriers at checkout, merchants can increase conversion rates, boost average order values, and enhance customer loyalty. Our seamless integration delivers a frictionless shopping experience across both online and in-store environments, with simple eligibility checks and transparent terms. This win-win solution helps businesses grow revenue while giving customers the purchasing power they need with manageable payment schedules.
Get Eligible Plans
Instantly shows payment options a customer qualifies for, with personalized terms and rates based on their profile.
Balance Transfer
Moves debt from accounts to your platform, typically offering lower interest rates and consolidated payments.
LoanOnCall QuickCash
Provides instant cash loans to pre-approved customers, with funds deposited directly to their bank accounts.
Financial Posting
Automatically records and reconciles payment transactions across accounting systems, ensuring accurate financial tracking and regulatory compliance with detailed audit trails.
Balance Conversion
Transforms credit purchases into fixed installment plans with structured payment terms.
Get Plan List
Status:
Production
Version:
V2
Product:
Buy Now Pay Later
Overview
This API allows fetching the list of active instalment plans that a customer has already converted from their purchases. It allows customers to view all ongoing payment plans, including details such as plan id, due amount, overdue amount, and paid amount. By giving an overview of active plans, the details helps cardholders easily track their financial commitments and manage their Buy Now, Pay Later (BNPL) arrangements effectively. This ensures cardholders stay informed about their current financial obligations and enabling smoother financial management.
How It Works
When a customer converts transactions or balances into an instalment plan, they typically want to view their active plans along with important details for each one. This API is designed to provide those details, giving customers full visibility into their active instalment plans. TAPI helps ensure customers stay informed and manage their instalment plans more effectively. This level of transparency enhances the customer experience and promotes financial clarity.
Status:
Production
Version:
V2
Product:
Buy Now Pay Later
Node | Child Node | Type | Length | Description |
---|---|---|---|---|
Authorization | Bearer xxxx | string | Authorization Header (Bearer Token) | |
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvRequest | request_get_plan_list | header | msg_id | string | 12 | Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID” | ||||
msg_type | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY” | |||||||
msg_function | string | 50 | name to be used Default REQ_GET_PLAN_LIST | |||||||
src_application | string | 10 | Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems | |||||||
target_application | string | 10 | Target application name Ex WAY4 or DCMS or PCMS | |||||||
timestamp | string | 30 | Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00 | |||||||
tracking_id | string | 15 | Transaction Tracking Id | |||||||
bank_id | string | 4 | Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC” | |||||||
instance_id | string | 10 | instance_id | |||||||
body | card_identifier_id | string | 32 | card identifier | ||||||
card_identifier_type | string | 20 | CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS |
{
"NISrvRequest": {
"request_get_plan_list": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "REQ_GET_PLAN_LIST",
"src_application": "IVR",
"target_application": "WAY4",
"timestamp": "2020-07-20T10:49:02.366+04:00",
"tracking_id": "236001",
"bank_id": "NIC",
"instance_id": "236001"
},
"body": {
"card_identifier_id": "99984100148297467162",
"card_identifier_type": "EXID"
}
}
}
}
Node | Child Node | Type | Length | Description | |
---|---|---|---|---|---|
Content-Type | application/json | string | Content Type |
Node Type | Type | Length | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
NISrvResponse | response_get_plan_list | header | msg_id | string | 12 | Unique Source Message ID eg ada123456fdsf | ||||
msg_type | string | 12 | Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY” | |||||||
msg_function | string | 50 | Default RES_GET_PLAN_LIST | |||||||
src_application | string | 10 | Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems | |||||||
tracking_id | string | 15 | Transaction Tracking Id | |||||||
bank_id | string | 4 | Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC” | |||||||
instance_id | string | 10 | instance_id | |||||||
exception_details | application_name | string | 20 | Application Name | ||||||
date_time | string | 30 | Timestamp of the response Format “YYYY-MM-DD HH:MM:SS” | |||||||
status | string | 1 | Status of the request (S/F) | |||||||
error_code | string | 4 | EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) | |||||||
error_description | string | 100 | Error Description (Check error codes section for the complete list of error codes and error code descriptions) | |||||||
transaction_ref_id | string | 20 | The tracking_id sent in the request will be sent back in response in this field. | |||||||
body | instalments | plan_id | string | |||||||
description | string | |||||||||
plan_number | string | |||||||||
creation_date | string | |||||||||
first_payment_date | string | |||||||||
close_date | string | |||||||||
currency | string | |||||||||
total_amount | string | |||||||||
principal | string | |||||||||
fee | string | |||||||||
paid_amount | string | |||||||||
due_amount | string | |||||||||
overdue_amount | string | |||||||||
written_off_amount | string | |||||||||
portion_total | string | |||||||||
portion_principal | string | |||||||||
portion_fee | string |
{
"NISrvResponse": {
"response_get_plan_list": {
"header": {
"msg_id": "236001",
"msg_type": "ENQUIRY",
"msg_function": "RES_GET_PLAN_LIST",
"src_application": "IVR",
"tracking_id": "236001",
"bank_id": "NIC",
"instance_id": "236001"
},
"exception_details": {
"application_name": "TCC-ADP",
"date_time": "2023-02-01T16:39:47.314+04:00",
"status": "S",
"error_code": "000",
"error_description": "Success",
"transaction_ref_id": "236001"
},
"body": {
"instalments": [
{
"plan_id": "string",
"description": "string",
"plan_number": "string",
"creation_date": "string",
"first_payment_date": "string",
"close_date": "string",
"currency": "string",
"total_amount": "string",
"principal": "string",
"fee": "string",
"paid_amount": "string",
"due_amount": "string",
"overdue_amount": "string",
"written_off_amount": "string",
"portion_total": "string",
"portion_principal": "string",
"portion_fee": "string"
}
]
}
}
}
}
Code | Description |
---|---|
200 | Sample Description |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
500 | Internal Server Error |
502 | Bad gateway |
503 | Scheduled Maintenance |
504 | Gateway Timeout |
596 | Service Not Found |