NI Functionality - API V 1.0
NI Functionality - API V 1.0
5/11/2014
1 API – Introduction
API (Application Programming Interface) is the middleware between NI Card Management System and
TIBCO providing Credit Card Information from NI Card Management System back to various interfaces
and external third party systems via TIBCO. API communicates through request and response messages
using TCP connection.
Data Queue: Data queue is being used to log the request & response message. Incoming data queue is
populated by TIBCO system whereas outgoing data queue is populated by NI Card Management System.
Incoming message is forwarded to API processor, which is linked to respective API service based on
message type. The API service performs the necessary functional processing associated with it and
returns the response back to API Processor which in turn writes the response message back to Outgoing
Data Queue.
API Listener: API listener Acts as a server which constantly tries to listens or wait for any request
message arriving on the incoming Data Queue from TIBCO end & forwards the retrieved message to API
Processor.
API processor: API processer receives message from Listener and validates below mandatory checks on
header information:
API system parameter should not indicate API SYSTEM UNVAVAILABLE.
If NI Card Management System is in batch mode then the maintenance indicator should not be
switched ON. (API System will be in Inquiry Mode due to maintenance activity happening in NI
Card Management System database during EOD batch)
API Service should be switched ON at System, bank or product Level
1.1 API Services
Various API services are available in NI system which can be activated at product level. The valid values
for the flags are:
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N N N Y Y Y Y Y
Y Y Y Y Y Y
AUB/BBY/DF/FGB/FGI/EIB/ENBD haves a credit card payment service to post payment to the accounts
through various channels using valid card number. Below operations are performed as part of credit
card payment service:
AUB:
Memo credit at account level is directly updated by adding the payment amount.
The number of memo credits is increased by one.
Memo debit at account level is directly updated by adding the payment reversal amount.
The number of memo debit is increased by one.
Payment record file is updated after doing TIBCO payment which is fed as input into the EOD
batch.
Payment log file is updated after doing TIBCO payment. Report gets generated for the same.
BBY/DF/FGB/FGI/EIB/ENBD
Memo credit at account level is directly updated by adding the payment amount.
The number of memo credits is increased by one.
Payment record file is getting updated after doing TIBCO payment which will be feed into the
batch.
Payment log file is getting updated after doing TIBCO payment. Report gets generated for the
same.
Refer to the 1.2 Reports and extracts for request & response message layout & report layout.
Refer to the 1.2 Reports and extracts for further information on the file & report layouts.
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N Y N Y Y Y Y Y
Y Y Y Y Y N
AUB and /NBF/BBY/DF/FGB/FGI/QIIB/ENBD have a status change service to activate a card, block a card
or update the pin offset. These services are selected based on the TYPE (sub service) provided by TIBCO
which is specified as follows:
Type :
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N N N N Y Y Y Y
Y Y Y Y Y Y
Note : Currently AUB is not using the CIF ID Concept. Therfore maintenance can be carried out using
the card number only.
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N N N N Y N N Y
Y Y Y Y Y N
The customer card list can be extracted based on the Card Number or the CIF ID.
If CIF is provided, all the details of all the cards tagged with the provided CIF are extracted.
If Card Number is provided with Type as ‘A’ (Account), the details for all the cards under that
account are extracted.Explain the valid values for type.
If Card Number is provided with Type as ‘C’(Card), the details for that particular card are
extracted.
AUB does not have CIF concept, hence only card number is provided for AUB.
The maximum number of cards under an account, that can be extracted at one time is 10.
The data that will be extracted for each card can be seen in the Layout attached in the 1.2
Reports and extracts
1.1.5 Customer Card Details
AUB KWD AUB GBP AUB SAR UAB NBF BNP
Y Y Y N Y N
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N Y N N Y Y Y Y
Y Y Y Y Y N
The customer details can be extracted based on the Type field received in the incoming
message.
Valid Card Number should be provided in the incoming message.
The valid values for the Type parameter are
CDO (Embosser details including transaction details and statement details)
DNA (Customer name address details)
DAD (Customer demographic details)
DAE (Customer AQU Extract details)
The data that will be extracted for each Type can be seen in the Layout attached in the 1.2
Reports and extracts
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N Y N Y Y Y Y Y
Y Y Y Y Y Y
Valid Card Number should be provided in the incoming message.
For Split account setup, the account level credit limit is considered for OTB calculation.
For Combined account setup, the account level credit limit is considered for OTB calculation.
The data that will be extracted can be seen in the Layout attached in the 1.2 Reports and
extracts
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N Y N N Y Y Y Y
Y Y Y Y Y Y
In this service we can either extract the Statement header or Detailed Statement. The transaction details
are provided in Detailed Statement.
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N Y N N N N N Y
Y Y Y Y Y Y
The Authorized Transactions can be extracted for the account or card based on Type.
A – Account
C - Card
Valid Card Number should be provided in the incoming message.
The transactions can be sorted in ascending or descending order based on Sort Order.
A – Ascending
D - Descending
The number of transactions to be extracted is provided in the incoming message.( Transaction
authorized prior to the EOD batch is not currently part of this message).
A maximum of 98 transactions can be extracted at a time.
A date range can be given to filter the transactions based on effective date.
If a date range is not provided, all the transactions for the account/card irrespective of the
effective date are extracted.
The transaction pointer determines the first eligible transaction from where the extraction
begins. The default number of transactions that can be fetched at one time is 20. For example if
we have extracted 20 transactions by giving Pointer as 1 (First 20) in the first request, we should
give the pointer as 21 to extract the next 20 transactions in the subsequent request.
The data that will be extracted can be seen in the Layout attached in the 1.2 Reports and
extracts
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N Y N N Y Y Y Y
Y Y Y Y Y Y
The Cycle to Date Posted Transactions or all the Posted Transactions can be extracted for the
account based on Type field provided in the incoming message.
A – All
C - Cycle
Valid Card Number should be provided in the incoming message.
The transactions can be sorted in ascending or descending order based on Sort Order.
A – Ascending
D - Descending
The number of transactions to be extracted can be provided.
A maximum of 98 transactions can be extracted at a time.
A date range can be given filter the transactions based on effective date.
If a date range is not provided, all the transactions for the account/card irrespective of the
effective date are extracted.
The transaction pointer determines the first eligible transaction from where the extraction
begins. For example if we have extracted 20 transactions by giving Pointer as 1 (First 20) in the
first request, we should give the pointer as 21 to extract the next 20 transactions in the
subsequent request.
IPP (Installment Payment Plan) details are extracted for ENBD/EIB.
The data that will be extracted can be seen in the Layout attached in the 1.2 Reports and
extracts
1.1.10Status Inquiry
AUB KWD AUB GBP AUB SAR UAB NBF BNP
Y Y Y N N N
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N N N Y Y Y Y Y
Y Y Y Y Y N
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N N N N N N N N
N N N N N N
This service can be used to extract the merchant details based on the merchant id.
The data that will be extracted can be seen in the Layout attached in the 1.2 Reports and
extracts
1.1.12 Supplemental Card Limit Change
AUB KWD AUB GBP AUB SAR UAB NBF BNP
Y Y Y N N N
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
Y Y Y N N N N N N N N
N Y Y Y Y N
This service can be used to update the card limit for supplementary cards.
The UPT-IND field in the incoming message should be spaces.
The card limit provided should be less than the account level credit limit.
A record is written in the log file. This log file is processed in the EOD batch to generate the
maintenance reports.
The data that will be extracted can be seen in the Layout attached in the 1.2 Reports and
extracts
AUB AUB AUB UAB NBF BNP BBY DF FGB FGI QIIB
KWD GBP SAR
N N N N N N N N N N N
Y Y Y Y Y Y
IPP can be booked through API provided the IPP booking service should be set as active in API
parameter screen.
Following validations are performed on the incoming request for booking the IPP.
The card/Account number exists in the VisionPLUS data base.
IPP Plan exists in the VisionPLUS data base
The transaction amount is numeric and is greater than the minimum amount eligible for
IPP conversion.
The IPP plan is valid.
The IPP booking is already done for that transaction.
The CD level of account is less than delinquency roll over defined at plan level.
If any of the above validation fails, then the response code is not 00.
Once the validation is successful, the response code is send as zeroes and the cross reference
file is built.
The cross reference file have card number, reference number, IPP plan and the booking date
and this file is used to avoid duplicate IPP booking. This file also gets logged when the
transaction is converted to IPP through ARTD/ARSD. This ensures that the transactions are not
converted to installments more than one time in a day.
If IPP booking is again initiated for the same transaction on different day, then the reference
number of installment file is used for identification of duplicate IPP transaction.
Post successful validation of the incoming request, a credit and debit transaction is created and
the same gets processed in the subsequent EOD batch. For each successful booking of IPP
through API, two transactions, one is credit to the retail plan and a debit to the IPP plan is
posted in the EOD batch which results in creation of IPP plan using online monetary transaction
log file.
If the transaction which is being booked for IPP has resulted in frequent shopper points, then
these points are not reflected either in credit/debit of the IPP transactions.
Once the IPP is booked successfully in the system, the record is deleted from the cross reference
file built during the booking of IPP. If the reference number of the cross reference file matches
with the installment file reference number, the same record is deleted from the cross reference
file else the same record is retained in the cross reference file.
Refer to the 1.2 Reports and extracts for request & response message layout/cross reference
file layout/ online monetary transaction log file layout.
Y Y Y N N N N N N N N
N Y Y Y Y N
CIF ID can be updated through the API service provided the CIF update service is set as active in
the API parameter screen for the particular product.
Following validations are performed on the incoming request for updating the CIF.
Card number should not be spaces/low values
CIF ID should not be spaces/low values
Action should be either ‘Y’/’N’
Card number should be present in NI Card Management System data base
CIF ID of the card number provided in the incoming request exists in the embosser
logical file for action as ‘Y’.
CIF ID of the card number provided in the incoming request is zeroes if the action is ‘Y’.
Explain action field
Action type can be ‘N’ or ‘Y’
N – Update CIF ID of provided card number in the incoming message by TIBCO team
Y – Card number provided in the incoming request is used to read the embosser file and
the CIF ID associated with the card number is considered. All the cards associated with
that CIF ID are updated with the CIF ID provided in the incoming message.
If any of the above validations fail, then the response code is not zeroes.
Once the validation is successful, the response code is send as zeroes and the values are
updated in the embosser file along with the non-monetary log update for the generation of the
report in the subsequent EOD batch.
If the action is provided as ‘N’, then the card number provided in the incoming message only is
updated with the CIF ID provided in the incoming request.
If the action is ‘Y’, card number provided in the incoming request is used to read the embosser
file and the CIF ID associated with the card number is considered. All the cards associated with
that CIF ID are updated with the CIF ID provided in the incoming message.
Note: Although the setup is done in VisionPLUS, Currently this service is not being used by AUB as
AUB does not have the CIF concept.
The data that will be extracted can be seen in the Layout attached in the 1.2 Reports and
extracts
Y Y Y N N N N N N N Y
Y Y Y Y Y Y
Below Validations are performed to validate the TOCARD (Transferred in account/New Card)
New Card number should be present in embosser database. Hence account transfer
should happen prior to points transfer.
New account number should be present in base segment database and should be
activated for rewards functionality.
New Account status should not be charged off/closed/transferred out/transferred
in/purge or to be purged status.
New account block code/delinquency should allow points adjustment.
The New Card Product should support the rewards functionality if the new card product
differs from old account Product (product upgrade/downgrade).
Points transferred should not cause total Year to Date points to exceed the maximum
earned points allowed for the program.
Upon successful validation of the incoming request, the corresponding program balance of the
FROM card is reduced and for the TO card the corresponding program balance is increased.
ALL CTD, YTD FS balances are reduced/increased for the FROM/TO card.
A log file is updated to log the rewards transfer/reverse transfer points on successful response
and if the incoming message has an indicator to write the log file. This log file is used for
audit/reference purpose.
The data that will be extracted can be seen in the Layout attached in the 1.2 Reports and
extracts
AUB
FGB
QIIB
BBY
API Layout