Overview

In Control for Commercial Payments (ICCP) streamlines business transactions using configurable spending controls and enhanced data:

Version

Get Purchase Templates

Status:

Beta

Version:

V2

Product:

ICCP Solutions

GetPurchaseTemplates

Overview

Gets a list of the purchase templates available to use to create a purchase request.

https://api-sandbox.network.global

Get Purchase Templates

Status:

Beta

Version:

V2

Product:

ICCP Solutions
/V2/cardservices/GetPurchaseTemplates
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)
Unique-Reference-Code* requireda1v2n3dass* requiredstring12Request ID for identification of each request call, maximum 12 characters
Financial-Id* requiredNSGB2* requiredstring5Organization/Financial institution ID
Channel-Id* requiredBank* requiredstring5Source requesting channel Ex: IVR

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

Node TypeTypeLengthDescription
headermsg_id* requiredstring12The msg_id sent in the request will be sent back in response in this field
msg_type* requiredstring12msg_type sent in the request will be sent back in response in this field
msg_function* requiredstring50Function name to be used default REP_GET_PURCHASE_TEMPLATES
src_application* requiredstring10The src_application sent in the request will be sent back in response in this field
target_application* requiredstring10The target_application sent in the request will be sent back in response in this field
timestamp* requiredstring30Timestamp of the request Format DD/MM/YYYY HH:MM:SS
bank_id* requiredstring4The bank_id sent in the request will be sent back in response in this field Eg ABCD
instance_idstring10InstanceID
exception_detailsapplication_namestring20Application Name
date_timestring30Timestamp of the response
statusstring1Status of the request (S/F)
error_codestring4EAI Internal Error Code
error_descriptionstring100Error Description
bodytemplateidinteger0ID of a purchase template
namestring0Name of the template
descriptionstring0Additional details on the template

{
    "NISrvResponse": {
        "response_get_purchase_templates": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_GET_PURCHASE_TEMPLATES",
                "src_application": "IVR",
                "target_application": "CMS",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC",
                "instance_id": "InstanceID"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-02-01T16:39:47.314+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            },
            "body": {
                "template": [
                    {
                        "id": 21680,
                        "name": "Sandbox Purchase Template",
                        "description": "Used in Sandbox Environment, with Velocity and Validity Period controls, with addenda data allowed"
                    }
                ]
            }
        }
    }
}

Code Description
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found