• Register

Card Create

This service is used for creating the card record in the Way4 system. Card record is the third level or last level in the hierarchy and it will have information like cardholder name, expiry date, primary or supplementary details, Virtual card or physical card. Key information required to board the card record are account number, primary or supplementary card indicator, virtual card or physical card, etc.

Download

Request Parameters:

Node Child Node Type Length Description Remarks
header msg_id A/N 12 Unique Source Message ID Mandatory
msg_type String 12 Request Type Default: "TRANSACTION" Mandatory
msg_function String 50 Function name to be used Default: "REQ_CARD_CREATE" Mandatory
src_application String 10 Source requesting channel Ex: IVR. Mandatory
target_application String 10 Target application name Ex. PCMS Mandatory
timestamp String 30 Timestamp of the request Format  “DD/MM/YYYY HH:MM:SS” Mandatory
tracking_id String 15 Transaction Tracking Id Optional
bank_id String 4 Source Bank Id Ex. bankID Mandatory
body customer_id String 20 CIF ID Mandatory
account_number String 64 Account contract Mandatory 
card_type String 7

Values are restricted

PREPAID

CREDIT

DEBIT

 Mandatory
  card customer_id String 20 CIF ID Mandatory
account_number String 64 Account contract Mandatory 
institution_id String 5 Bank code Mandatory 
card_identifier_type String 20 CONTRACT_NUMBER/EXID
 Optional
card_identifier_id String 32 454545XXXXXX1234 Optional
card_expiry_date String 4 Format YYMM Optional
cardholder_name String 26 Cardholder name Mandatory
bin_number String 8 BIN Number Conditional (mandatory for Debit Card)
product_code String 32 Product code Mandatory
product_category String 4 Product Category (ISLAMIC,HNI,STAFF) Conditional (mandatory for Debit Card)
customer_category String 4 Customer Category (NOR, HNI) Conditional (mandatory for Debit Card)
card_role String 1 Card Role : Primary/Supplementary Mandatory
card_date_open String 10 Date of card contract creation Optional
currency String 3 Currency  Mandatory
card_virtual_indicator String 1

P- Physical

V- Virtual

 Mandatory
limit type String 32 Type of limit:FIN_LIMIT, CR_LIMIT_PCNT (Supplementary card only)
 Optional
currency String 3 Limit currency Optional
value String 20 Limit value Optional
custom_fields key String 32 Please Refer Appendix 4 Please Refer Appendix 4
value String 128 Please Refer Appendix 4 Please Refer Appendix 4


Response Parameters:

 Request JSON

{
   "NISrvRequest":{
      "xmlns":"http://www.ni.com/NISrvRequest.xsd",
      "request_card_create":{
         "header":{
            "msg_id":"nkcdjcknj",
            "msg_type":"TRANSACTION",
            "msg_function":"REQ_CARD_CREATE",
            "src_application":"SSP",
            "target_application":"WAY4",
            "timestamp":"2021-12-08 14:11:54.822+0400",
            "tracking_id":"20211208141152",
            "bank_id":"TIQMO"
         },
         "body":{
            "customer_id":"10XXXX020",
            "account_number":"000360XXXXXXX000097",
            "card_type":"PREPAID",
            "card":{
               "customer_id":"100XXXX020",
               "account_number":"000360XXXXXXXX00097",
               "institution_id":"360",
               "card_identifier_id":"",
               "card_identifier_type":"",
               "card_expiry_date":"",
               "cardholder_name":"CardHolder123",
               "bin_number":"",
               "product_code":"360_SAR_002_P",
               "product_category":"",
               "customer_category":"",
               "card_role":"SAR",
               "card_date_open":"2022-01-01",
               "currency":"",
               "card_virtual_indicator":"V",
               "custom_fields":[
                  {
                     "key":"contract_idt_scheme",
                     "value":"CONTRACT_NUMBER"
                  },
                  {
                     "key":"src_app_code",
                     "value":"TIB"
                  },
                  {
                     "key":"src_app_name",
                     "value":"TIB"
                  },
                  {
                     "key":"ext_user_id",
                     "value":"NI"
                  }
               ]
            }
         }
      }
   }
}
Node Child Node Type Length Description Remarks
header msg_id String 12 The msg_id sent in the request will be sent back in response in this field. Mandatory
Unique Source Message ID e.g. “ada123456fdsf”
msg_type String 12 msg_type sent in the request will be sent back in response in this field. Mandatory
msg_function String 50 Default: “REP_CARD_CREATE” Mandatory
src_application String 10 The src_application sent in the request will be sent back in response in this field. Mandatory
Source requesting channel 
target_application  String 10 The target_application sent in the request will be sent back in response in this field. Mandatory
timestamp String 30 Timestamp of the response Mandatory
Date & time. Format  “DD/MM/YYYY HH:MM:SS”
tracking_id String 15 The tracking_id sent in the request will be sent back in response in this field. Optional
bank_id String 4 The bank_id sent in the request will be sent back in response in this field. Mandatory
instance_id String 10 N/A Optional
Exception_details application_name String 20 Application Name Mandatory
date_time String 30 Format “DD/MM/YYYY HH:MM:SS” Mandatory
status String 1 Status of the request (S/F) Mandatory
error_code String 4 EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions) Mandatory
error_description String 100 Error Description (Check error codes section for the complete list of error codes and error code descriptions) Mandatory
transaction_ref_id String 20 The tracking_id sent in the request will be sent back in response in this field. Optional
body customer_id String 20 CIF ID Optional
institution_id String 5 Bank code Optional
card_identifier_type String
CONTRACT_NUMBER or
 Mandatory
20 EXID
 
card_identifier_id
 String 32 Value of card number, Token number, Ext_number ..
 Mandatory
masked_pan  String 16 Masked PAN  Mandatory
card_virtual_indicator String 1

P- Physical

V- Virtual

 Mandatory
card_expiry_date String 4 Card Expiry Date Optional
cardholder_name String 26 Cardholder name Optional
account_number String 50 Account number Optional
product_code String 32 Product code Optional
card_role String 1 Card Role : Primary/Supplementary Optional
last_statement_date String 10 Last billing date Optional
next_statement_date String 10 Next billing date Optional
due_date String 10 Due date Optional
card_date_open Date   Date of card contract creation Optional
card_activation_date String 10 Date of plastic creation Optional
currency String 3 Currency Optional
statuses type String 32 Code of status Optional
value String 32 Status value Optional
changed_date String 10 Date of change Optional
limits type String 32 Limit type Optional
currency String 3 Limit currency Optional
value String 20 Limit value Optional
balances type String 32 Type of the balance Optional
currency String 3 Currency Optional
amount String 20 Amount Optional
custom_fields key String 32 Refer to Appendix 4 Optional
value String 128 Refer to Appendix 4 Optional
Response JSON
{
   "NISrvResponse":{
      "response_card_create":{
         "header":{
            "msg_id":"1643620629",
            "msg_type":"TRANSACTION",
            "msg_function":"REP_CARD_CREATE",
            "src_application":"SSP",
            "target_application":"WAY4",
            "timestamp":"2021-12-08 14:11:54.822+0400",
            "tracking_id":"20211208141152",
            "bank_id":"TIQMO"
         },
         "exception_details":{
            "application_name":"NITIB_TCC_ADP_KSA",
            "date_time":"2022-01-31T12:17:16.206+03:00",
            "status":"S",
            "error_code":"000",
            "error_description":"Success",
            "transaction_ref_id":"20211208141152"
         },
         "body":{
            "card_identifier_id":"999851XXXXXXXX709811",
            "card_identifier_type":"EXID",
            "card_virtual_indicator":"V",
            "custom_fields":[
               {
                  "key":"CN-BC_C1",
                  "value":"N"
               },
               {
                  "key":"CN-CARD_DESIGN_FLAG",
                  "value":"00"
               },
               {
                  "key":"CN-DATE_OPEN",
                  "value":"2022-01-01"
               },
               {
                  "key":"CN-EMB_NAME_LAST",
                  "value":"K"
               },
               {
                  "key":"CN-NCONTROL_ENROLMENT",
                  "value":"Y"
               }
            ]
         }
      }
   }
}

version 6 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation