Overview

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

Version

GetPurchaseRequestDetails

Status:

Beta

Version:

V2

Product:

ICCP Solutions

GetPurchaseRequestDetails

Overview

Get the details of a purchase request using its ID.

https://api-sandbox.network.global

GetPurchaseRequestDetails

Status:

Beta

Version:

V2

Product:

ICCP Solutions
/V2/cardservices/GetPurchaseRequestDetails
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_PURCHASE_REQUEST_DETAILS
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
bodypurchase_request_detailspurchase_request_idstring
request_statusstring
template_detailsobject
template_details/template_idstring
template_details/template_rule_detailsobject
template_details/template_rule_details/rule_namestring
template_details/template_rule_details/rule_typestring
template_details/template_rule_details/template_controlArray
template_details/template_rule_details/template_control/max_transstring
template_details/template_rule_details/template_control/cumulative_limitstring
template_details/template_rule_details/template_control/periodstring
template_details/template_rule_details/template_control/currency_typestring
template_details/template_rule_details/template_control/currency_codestring
template_details/template_rule_details/template_control/end_datestring
template_details/template_custom_fieldsArray
template_details/template_custom_fields/Purchase Typestring
vcn_informationobject
vcn_information/idstring
vcn_information/panstring
vcn_information/expirystring
vcn_information/AVVstring
vcn_information/statusstring
vcn_information/evcn_indicatorstring
addendaArray
addenda/trip_legstring
addenda/rail_detailstring
addenda/travel_agencystring
card_imagestring
supplier_detailsobject
supplier_details/disable_card_imagestring

{
    "NISrvResponse": {
        "response_purchase_request_details": {
            "header": {
                "msg_id": "236001",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_PURCHASE_REQUEST_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_request_details": {
                    "purchase_request_id": "1243255",
                    "request_status": "Approved",
                    "template_details": {
                        "template_id": "55024",
                        "template_rule_details": {
                            "rule_name": "B",
                            "rule_type": "A",
                            "template_control": [
                                {
                                    "max_trans": "4567",
                                    "cumulative_limit": "567.0",
                                    "period": "D",
                                    "currency_type": "B",
                                    "currency_code": "USD",
                                    "end_date": "2023-07-29"
                                }
                            ]
                        },
                        "template_custom_fields": [
                            {
                                "name": "Purchase Type",
                                "value": "1"
                            }
                        ]
                    },
                    "vcn_information": {
                        "id": "1124960",
                        "pan": "541275XXXXXX9999",
                        "expiry": "2111",
                        "AVV": "435",
                        "status": "S",
                        "evcn_indicator": "false"
                    },
                    "addenda": [
                        {
                            "trip_leg": " ",
                            "rail_detail": " ",
                            "travel_agency": " "
                        }
                    ],
                    "card_image": " ",
                    "supplier_details": {
                        "supplier_id": "227613",
                        "notify_supplier": "false"
                    },
                    "disable_card_image": "N"
                }
            }
        }
    }
}

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