Debit Solutions

Overview

Our one-stop, centralised solution for Debit Card processing is designed to provide you with a seamless and secure payment experience. Whether you are a small business or a large enterprise, our solution is cost-effective, easily configurable and scalable to meet your specific needs.

With our Debit Card processing solution, you can easily accept payments from your customers and enjoy faster access to your funds. Our platform supports all major debit card networks, so you can accept payments from customers regardless of their bank.

Version

Card Create

Status:

Production

Version:

V2

Product:

Credit Solutions

Card Create

Overview

The Card Create API is used to cards for customers. It accepts various parameters such as customer information, account information, card type, and custom fields.

Create Client Create Card Create Card

How It Works

The Card Create API is used to create new cards for customers. The API accepts parameters such as customer ID, account number, card type, institution ID, cardholder name, product code, card role, card date open, currency, and custom fields. Once the required parameters are set, the API executes the creation of the new credit card and returns a response indicating the success or failure of the transaction.
If the card is related to multi-currency product, you have 2 options, either to provide the base wallet number in account_number, or to provide the top account number in the same field but to send key “contract_idt_scheme” with value “CN:WALLET_BASE” under custom_fields.

https://api-sandbox.network.global

Card Create

Status:

Production

Version:

V2

Product:

Credit Solutions
/SB/CardServices/Transaction/V2/CardCreate
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* 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 “TRANSACTION”
msg_function* requiredstring50Message functions: Should be “REQ_CARD_CREATE”
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”
bodycustomer_id* requiredstring20Customer ID: Customer Identification number This should be a unique number
account_number* requiredstring64Account number
card_type* requiredstring7Informative value to the request, does not have any functional impact, the value can be PREPAID/CREDIT/DEBIT
cardcustomer_id* requiredstring20Customer ID: Customer Identification number This should be a unique number
account_number* requiredstring64Account number
institution_id* requiredstring5institution id is the code that is created for each bank or FI(it is the same value as bank code), 982 value is just used as an example in Sandbox
card_identifier_typestring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
card_identifier_idstring32Clear card number generated by FI system. If it was not provided, CMS will generate it
card_expiry_datestring4Format YYMM. If it was not provided, CMS will generate it
cardholder_name* requiredstring21Cardholder name
product_code* requiredstring32Product code, this code is generated by CMS after creating the product, this code is FI spesific code 982_AED_002_P is just used as an example in Sandbox"
card_date_openstring10Date of card contract creation
currency* requiredstring3Informative value to the request, does not have any functional impact, the currency will be taken from the product
card_virtual_indicator* requiredstring1V - Virtual P - Physical
limittypestring32Credit limit, applicable only for credit cards, Type of limit: FIN_LIMIT, CR_LIMIT_PCNT (Supplementary card only)
currencystring3Credit limit currency
valuestring20Credit limit value
custom_fieldskeystring20Custom Tag. Example: contract_idt_scheme
valuestring128Tag value. Example: CONTRACT_NUMBER

{
    "NISrvRequest": {
        "request_card_create": {
            "header": {
                "msg_id": "1593093024",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_CARD_CREATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "customer_id": "100000027",
                "account_number": "0009821110000000008",
                "card_type": "CREDIT",
                "card": {
                    "customer_id": "100000027",
                    "account_number": "0009821110000000008",
                    "institution_id": "982",
                    "cardholder_name": "JOHN DOE",
                    "product_code": "982_AED_042_P",
                    "card_date_open": "2022-01-01",
                    "currency": "AED",
                    "card_virtual_indicator": "V",
                    "instant_issuance": {
                        "online_embossing": "Y",
                        "embossing_tags": [
                            {
                                "key": "EF.TAG1",
                                "value": "A1B2C3D4E5"
                            }
                        ]
                    },
                    "limit": {},
                    "custom_fields": [
                        {
                            "key": "contract_idt_scheme",
                            "value": "CONTRACT_NUMBER"
                        }
                    ]
                }
            }
        }
    }
}

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

Node TypeTypeLengthDescription
NISrvResponseresponse_card_createheadermsg_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 “TRANSACTION”
msg_function* requiredstring50Message functions: Should be “REP_CARD_CREATE”
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* requiredstring15Timestamp of the response - 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”
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* requiredstring32CardValue of card number, Token number, Ext_number
card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
masked_pan* requiredstring16Masked PAN
card_virtual_indicator* requiredstring1P- Physical V- Virtual
custom_fieldskeystring32Custom Tag e.g. contract_idt_scheme
valuestring128Custom Tag value

{
    "NISrvResponse": {
        "response_card_create": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_CARD_CREATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T06:49:02.366Z",
                "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": "99985101161390700708",
                "card_identifier_type": "EXID",
                "masked_pan": "999851XXXXXX8349",
                "card_virtual_indicator": "V",
                "custom_fields": [
                    {
                        "key": "contract_idt_scheme",
                        "value": "CONTRACT_NUMBER"
                    }
                ]
            }
        }
    }
}

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