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 Flat BT

Status:

Production

Version:

V2

Category:

Buy Now Pay Later

Get Flat BT

Overview

This API, designed to retrieve Flat balances for a specified card. It should be noted that this API can only be utilized when the balances are stored in Network Internationals systems. It is not applicable for debit cards or prepaid cards with external store of value or wallets.

https://api-sandbox.network.global

Get Flat BT

Status:

Production

Version:

V2

Category:

Buy Now Pay Later
/SB/BnplServices/Enquiry/V2/GetFlatBT
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_flat_btheadermsg_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* requiredstring50Static Value - REQ_FLAT_BT
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* requiredstring10The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call
timestamp* requiredstring30Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
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”
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_flat_bt": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_FLAT_BT",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "454545XXXXXX1234",
                "card_identifier_type": "EXID"
            }
        }
    }
}

Node Child Node Type Length Description
Content-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_flat_btheadermsg_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* requiredstring50Static Value - REP_FLAT_BT
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* requiredstring10The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call
timestamp* requiredstring30Timestamp of the response Date & time Format DD/MM/YYYY HH:MM:SS
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”
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.
bodycard_identifier_id* requiredstring32454545XXXXXX1234
card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
flat_bt_plansplan_number* requiredstring5Plan number
plan_typestring32Plan type
plan_groupstring32Plan Group
payment_creditedstring32Payment credited
outstanding_balancestring32OTB balance
minimum_amount_duestring32Minimum due amount
deferred_intereststring32deferred interest
accrued_intereststring32Accured interest
perdiem_intereststring32Per diem interest
plan_open_datestring32Plan open date

{
    "NISrvResponse": {
        "response_flat_bt": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_FLAT_BT",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "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": {
                "card_identifier_id": "454545XXXXXX1234",
                "card_identifier_type": "CONTRACT_NUMBER\/EXID",
                "flat_bt_plans": {
                    "plan_number": "60006",
                    "plan_type": "FP",
                    "plan_group": "FP_BT",
                    "payment_credited": "0",
                    "outstanding_balance": "500",
                    "minimum_amount_due": "0",
                    "deferred_interest": "0",
                    "accrued_interest": "0",
                    "perdiem_interest": "0",
                    "plan_open_date": "2025-09-11T00:00:00.000Z"
                }
            }
        }
    }
}

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.