Buy Now Pay Later

Buy Now Pay Later

Overview

Our Buy Now Pay Later services provide an easy and flexible payment option for your customers, allowing them to make purchases now and pay for them at a later date. This can help to increase sales by making it easier for customers to make larger purchases, or to buy more frequently.

Our Buy Now Pay Later services also include the ability to set up recurring payments, which can help to increase customer loyalty by making it easy for customers to make regular payments for their purchases. Our platform also allows customers to track and manage their payments, which can help to improve their experience and satisfaction.

Version

Get Plan List

Status:

Production

Version:

V2

Category:

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.

https://api-sandbox.network.global

Get Plan List

Status:

Production

Version:

V2

Category:

Buy Now Pay Later
/BnplServices/Enquiry/V2/GetPlanList
curl --location --request POST '#{PARAM_URL}' --header 'Authorization: Bearer {{ access_token }}' {custom_headers} --data-raw '#{JSON_PAYLOAD}'
curl --location --request GET 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'
curl --location --request POST 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'

Node Child Node Type Length Description
Authorization* requiredBearer xxxx* requiredstringAuthorization Header (Bearer Token)
Content-Type* requiredapplication/json* requiredstringContent Type

Node TypeTypeLengthDescription
NISrvRequestrequest_get_plan_listheadermsg_id* requiredstring12Message 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* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”
msg_function* requiredstring50name to be used Default REQ_GET_PLAN_LIST
src_application* requiredstring10Source 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* requiredstring10Target application name Ex WAY4 or DCMS or PCMS
timestamp* requiredstring30Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
tracking_idstring15Transaction Tracking Id
bank_id* requiredstring4Bank 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_idstring10instance_id
bodycard_identifier_id* requiredstring32card identifier
card_identifier_type* requiredstring20CONTRACT_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-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_get_plan_listheadermsg_id* requiredstring12Unique Source Message ID eg ada123456fdsf
msg_type* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”
msg_function* requiredstring50Default RES_GET_PLAN_LIST
src_application* requiredstring10Source 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_idstring15Transaction Tracking Id
bank_id* requiredstring4Bank 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_idstring10instance_id
exception_detailsapplication_name* requiredstring20Application Name
date_time* requiredstring30Timestamp of the response Format “YYYY-MM-DD HH:MM:SS”
status* requiredstring1Status of the request (S/F)
error_code* requiredstring4EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
error_description* requiredstring100Error Description (Check error codes section for the complete list of error codes and error code descriptions)
transaction_ref_idstring20The tracking_id sent in the request will be sent back in response in this field.
bodyinstalmentsplan_idstring
descriptionstring
plan_numberstring
creation_datestring
first_payment_datestring
close_datestring
currencystring
total_amountstring
principalstring
feestring
paid_amountstring
due_amountstring
overdue_amountstring
written_off_amountstring
portion_totalstring
portion_principalstring
portion_feestring

{
    "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
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found

How It Works

Follow the steps below. For more details, read the Quick Start Guide.

1- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

2- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

3- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

4- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

5- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.