Overview

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

Unique card number for every transaction

A new account number is generated for each transaction and used only once, which gives each purchase its own unique identifier.

Set Transaction Level Controls

Transaction-level authorization lets you define how, where, and when cards are used.

Get enhanced data

Information important to each individual payment is included in each transaction.

Automated reconciliation

VCN data is available for reconciliation reporting.

Workflow control

Approval routing for transactions follows the existing approval process - can also be used as a key tool to reinvent your requisition-to-pay process.

Get Companies(Post)

This API enables customers to Get the details of the companies

Status :Production

Get DataSource(Post)

This API enables customers to Get the details of the schema to use in submit purchase request API calls

Get Purchase Templates(Post)

This API enables customers to Gets a list of the purchase templates available to use to create a purchase request

Get Real Cards(Post)

This API enables customers to quickly and easily view any restrictions on their credit or debit cards, helping them to make informed decisions about their spending.

Get Suppliers(Post)

This API enables customers to Get a list of suppliers to whom payments can be made

Get VCNAuthsReport(Post)

This API enables customers to Get the authorization report for a VCN

GetVCNClearingsReport(Post)

This API enables customers to Get the clearing report for a VCN

GetPurchaseRequestDetails(Post)

This API enables customers to Get the purchase request Details

GetPurchaseTemplateDetails(Post)

This API enables customers to Get the purchase Request Template Details

CancelPurchaseRequests(Post)

This API enables customers to Cancel a virtual card that’s no longer valid or needed

CreateVCNAuthsReport(Post)

This API enables customers to create report for authorization transactions performed using a VCN for a specific date range

CreateVCNClearingsReport(Post)

This API enables customers to create report for clearing transactions performed using a VCN for a specific date range

EmailCardImage(Post)

This API enables customers to send the virtual card image in an email

SubmitPurchaseRequest(Post)

This API enables customers to Submit a purchase request to generate a Virtual Card Number

UpdatePurchaseRequest(Post)

This API enables customers to Update a purchase request to generate a Virtual Card Number

GetPurchaseTemplateDetails

Status:

Beta

Version:

V2

Product:

ICCP Solutions

GetPurchaseTemplateDetails

Overview

Get all details about a specific purchase template. The template details help you decide which template to use to create a purchase request. The details include custom data fields, spending controls and whether the purchase template is enabled to add invoice addenda data.

Node	Child Node	Type	Length	Description
Authorization* required	Bearer xxxx* required	string		Authorization Header (Bearer Token)
Unique-Reference-Code* required	a1v2n3dass* required	string	12	Request ID for identification of each request call, maximum 12 characters
Financial-Id* required	NSGB2* required	string	5	Organization/Financial institution ID
Channel-Id* required	Bank* required	string	5	Source requesting channel Ex: IVR
Template-Id* required	21680* required	string	10	ID of a template

Node	Child Node	Type	Length	Description
Content-Type	application/json	string		Content Type

Node Type								Type	Length	Description
header	msg_id* required							string	12	The msg_id sent in the request will be sent back in response in this field
	msg_type* required							string	12	msg_type sent in the request will be sent back in response in this field
	msg_function* required							string	50	Function name to be used default REP_GET_VCN_AUTHS_REPORT
	src_application* required							string	10	The src_application sent in the request will be sent back in response in this field
	target_application* required							string	10	The target_application sent in the request will be sent back in response in this field
	timestamp* required							string	30	Timestamp of the request Format DD/MM/YYYY HH:MM:SS
	bank_id* required							string	4	The bank_id sent in the request will be sent back in response in this field Eg ABCD
	instance_id							string	10	InstanceID
exception_details	application_name							string	20	Application Name
	date_time							string	30	Timestamp of the response
	status							string	1	Status of the request (S/F)
	error_code							string	4	EAI Internal Error Code
	error_description							string	100	Error Description
body	purchase_template_details	template* required						object
		template/id						string
		template/name						string
		template/type						string
		template/description						string
		purchase_types						Array
		purchase_types/MCC						string
		purchase_types/MCC_description						string
		template_rules						Array
		template_rules/name						string
		template_rules/type						string
		template_rules/template_control						Array
		template_rules/template_control/control_code						string
		template_rules/template_control/control_description						string
		template_rules/template_control/negate						string
		template_custom_fields						Array
		template_custom_fields/name						string
		template_custom_fields/value						string
		template_custom_fields/max_length						string
template_custom_fields/display_name						string
template_custom_fields/data_type						string
template_custom_fields/data_required						string
supported_addenda_types						Object
supported_addenda_types/addenda_type						Array
supported_addenda_types/addenda_type/code						string
supported_addenda_types/addenda_type/description						string

{"NISrvResponse":{"response_purchase_template_details":{"header":{"msg_id":"236001","msg_type":"ENQUIRY","msg_function":"REP_PURCHASE_TEMPLATE_DETAILS","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":{"purchase_template_details":{"template":{"id":"21680","name":"Sandbox Purchase Template","description":"Used in Sandbox Environment, with Velocity and Validity Period controls, with addenda data allowed","type":"PC"},"purchase_types":[{"MCC":"3000","MCC_description":"UNITED AIRLINES"}],"template_rules":[{"name":"Rule1","type":"Rule Type","template_control":[{"control_code":"VA","control_description":"Validity","negate":"negate"}]}],"template_custom_fields":[{"name":"Purchase Type","value":"Airlines","max_length":"69","display_name":"Text","data_type":"Alphanumeric","data_required":"Y"}],"supported_addenda_types":{"addenda_type":[{"code":"INVOICE","description":"Global Invoice"}]}}}}}}

{
    "NISrvResponse": {
        "response_purchase_template_details": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_PURCHASE_TEMPLATE_DETAILS",
                "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": {
                "purchase_template_details": {
                    "template": {
                        "id": "21680",
                        "name": "Sandbox Purchase Template",
                        "description": "Used in Sandbox Environment, with Velocity and Validity Period controls, with addenda data allowed",
                        "type": "PC"
                    },
                    "purchase_types": [
                        {
                            "MCC": "3000",
                            "MCC_description": "UNITED AIRLINES"
                        }
                    ],
                    "template_rules": [
                        {
                            "name": "Rule1",
                            "type": "Rule Type",
                            "template_control": [
                                {
                                    "control_code": "VA",
                                    "control_description": "Validity",
                                    "negate": "negate"
                                }
                            ]
                        }
                    ],
                    "template_custom_fields": [
                        {
                            "name": "Purchase Type",
                            "value": "Airlines",
                            "max_length": "69",
                            "display_name": "Text",
                            "data_type": "Alphanumeric",
                            "data_required": "Y"
                        }
                    ],
                    "supported_addenda_types": {
                        "addenda_type": [
                            {
                                "code": "INVOICE",
                                "description": "Global Invoice"
                            }
                        ]
                    }
                }
            }
        }
    }
}

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