Overview

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

Version

EmailCardImage

Status:

Beta

Version:

V2

Product:

ICCP Solutions

EmailCardImage

Overview

Use the emailCardImage request to send the virtual card image in an email to the recipient specified.

https://api-sandbox.network.global

EmailCardImage

Status:

Beta

Version:

V2

Product:

ICCP Solutions
/V2/cardservices/EmailCardImage
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
headermsg_id* requiredstring12Unique Source Message ID
msg_type* requiredstring12Request Type Default TRANSACTION
msg_function* requiredstring50Function name to be used Default REQ_EMAIL_CARD_IMAGE
src_application* requiredstring10Source requesting channel Ex IVR
target_application* requiredstring10Target application name Ex MC
timestamp* requiredstring30Timestamp of the request Format DD/MM/YYYY HH:MM:SS
bank_id* requiredstring4Source Bank Id Ex bankID
bodypurchase_request_id* requiredstring
email* requiredarray

{
    "NISrvRequest": {
        "request_email_card_image": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_EMAIL_CARD_IMAGE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "purchase_request_id": "14546",
                "email": [
                    "abc@example.com",
                    "def@example.com"
                ]
            }
        }
    }
}

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_EMAIL_CARD_IMAGE
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
bodycard_imagestring
error_messagestring

{
    "NISrvResponse": {
        "response_email_card_image": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_EMAIL_CARD_IMAGE",
                "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": {
                "card_image": "Card Image has been Emailed Successfully",
                "error_message": ""
            }
        }
    }
}

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