API PROCESS
AGENDA
• API - INTRODUCTION
• MERITS OF API PROCESS
• API COMMUNICATION INTERFACE
• API FUNCTIONAL DIAGRAM
• API LISTENER & PROCESSOR
• API STATUS DURING EOD
• API MESSAGE FORMAT
• API PARAMETERS
• API RESTART PROCESS
• API PROGRAMS
APLICATION PROGRAMMING INTERFACE
API is the Interface between Vision Plus and TIBCO providing Credit
Card Information from Vision Plus back to various interfaces and
external third party systems via TIBCO
Below are the Various subsystems which are currently accessing
TIBCO API services
• IVR - Interactive Voice Recognition system
• BANKNET - Internet Banking site
• CIF - Customer Information File
• ATM - Automated Teller Machine
• CDM - Cash Deposit Machine
• CRM - Customer Relationship Management
• MEM - Mobile Phone Banking
MERITS OF API PROCESS
• Earlier, TIBCO accessed Vision Plus using SQL queries
• Resulting in High Network I/O and CPU usage as SQL Queries being
executed from TIBCO to fetch Data from Vision Plus
• API process was introduced to remove the above barrier
• As API needs real time (Online) communication, programs are based
on FAS standards
API COMMUNICATION INTERFACE
• Communication between TIBCO Interface and Vision Plus API will be
through TCP Connection
• TCP Listeners are the connecting network module through which
communication is established between TIBCO and Vision Plus
• API communicates through request and response message
• Both Request & Response message is being handled in AS400 by use
of two Data Queues
• Incoming Data Queue will be populated by TIBCO system whereas the
outgoing Data Queue will be populated by Vision Plus
• Incoming message will be forwarded to API Processor which in turn
will link to respective API service based on message type
• The API service will perform the necessary functional processing
associated with it and return the response back to API Processor
which in turn will write the response message back to Outgoing Data
Queue
API FUNCTIONAL DIAGRAM
API LISTENER & PROCESSOR
API LISTENER:
• Acting 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
• Again switches back to receivable mode waiting for next message
API PROCESSOR:
• Receives message from Listener and validates below mandatory
checks on header information:
• API system parameter should not indicate API SYSTEM
UNVAVAILABLE and Vision Plus should not be in AFTER HOURS
UPDATE MODE
• If Vision Plus is in batch mode then the maintenance indicator in the
header should not be switched ON
• API Service should be switched ON at System, Org or Logo Level
API STATUS DURING EOD BATCH
• During EOD Overnight batch, API System will be in Inquiry Mode
due to maintenance activity happening in Vision Plus database
• A Data area APIDTAARA indicates the availability status of API
System
• Value of ‘1’ indicates the API listener is available and ‘0’ indicates
the unavailability of the API listener
API MESSAGE FORMAT
Message Format for Header : Common for Both Incoming & Outgoing
Parameter Name Description
Type Type of Message Request or Response Example: REQ/RES
Institution Name of the Financial Institution or Bank Example: EBI/FGB/ADCB/BBY
Channel Name of Channel ID Example : IVR, BNK, ATM,CRM,CSI,CIF
Request Id Unique Request Message Id
Service Type Specifies service either as Maintenance or Inquiry Example: M/I
Service Name Three byte numeric value pointing to one of the 15 services
Correlation Id Unique Id to correlate the message
Format: DDMMYYYY:HHMMSSMIS This will contain the datetime set by
Timestamp
TIBCO during the request to API
API MESSAGE FORMAT
Incoming Message Format :
Parameter Name Description
Card No. 19 Digit Valid Card Number
Detail fields The detail fields related to a particular service
Outgoing Message Format :
Parameter Name Description
Header Header details
Response Code Response code generated by API Processor
Description Response Message as generated by API Processor
API REQUEST & RESPONSE MESSAGE
Request Message:
REQEBIOCM54454545454
I006ebg.uae.vpsapiadapter.query.response.queue.api{EBI-OCM-QCDT-
54454545454-272320536}-CDO
22022011:0956310740004439590000064447CDO
Response Message:
RESEBIOCM54454545454
I006ebg.uae.vpsapiadapter.query.response.queue.api{EBI-OCM-QCDT-
54454545454-272320536}-CDO
22022011:09563134000SUCCESSFUL
#=23379634 0004439590000064447784HARMEET
KAUR KANWAR
API PARAMETERS – OFMN
API PARAMETERS – OFMN
API RESTART PROCESS
CHECK API LISTENER JOBS BY GIVING
WRKACTJOB SBS(QDEVAPIU06P)
API RESTART PROCESS
FOR PURGING API LISTENERS GIVE E1 TO E5
API RESTART PROCESS
API RESTART PROCESS
DELETE USERSPACE ONLY WHEN MODIFIYING API PROGRAMS
WRKOBJ OBJ(VPTU06WORK/*ALL) OBJTYPE(*USRSPC)
API RESTART PROCESS
TRIGGER OFLC ONLY WHENEVER USERSPACES ARE DELETED
API RESTART PROCESS
FOR STARTING API LISTENERS GIVE S1 TO S5
API RESTART PROCESS
PRESS ENTER AFTER GETTING THE ABOVE DIALOG
DATA QUEUE ISSUES
DATA QUEUE ISSUES
WRKOBJ OBJ(OFAP*) OBJTYPE(*DTAQ)
API PROGRAMS
PROGRAMS FUNCTIONS
OFONCTL API DRIVER INTERFACE PROGRAM
OFOZAPI001 API PAYMENT PROCESSING PROGRAM - used to process payment files received from various
interfaces
OFOZAPI002 API STATUS CHANGE - Performs Card Activation Request, Block Request and PIN change
Request
OFOZAPI003 REWARD LOYALTY POINTS PROGRAM - Performs redemption of reward points, Reverse
points and CTC transfer of points
OFOZAPI004 INSURANCE PROGRAM - Activates, deactivates and reactivates insurance product on an
account
OFOZAPI005 ADDRESS MAINTENANCE PROGRAM - All the Customer address details can be maintainable
OFOZAPI006 DIRECT DEBIT PROGRAM - Direct Debit functionality can be either activated or deactivated
OFOZAPI007 DEMOGRAPHIC MAINTANENCE - All the Customer Demographic details can be maintainable
OFOZAPI008 CUSTOMER CARD LIST - Retrieves the Credit Card list for the requested credit card number
OFOZAPI009 CUSTOMER CARD DETAILS (CDO) - List entire embosser details including transaction details
statement details
OFOZAPI010 CARD BALANCE ENQUIRY - Retrieves the Balance details for the requested card no.
OFOZAPI011 STATEMENT INQUIRY - Retrieves the statement details for the requested card no.
API PROGRAMS contd.
PROGRAMS FUNCTIONS
OFOZAPI012 AUTHORIZED TRANSACTIONS - Retrieves the authorized transaction details for the
requested card no.
OFOZAPI013 POSTED TRANSACTIONS - Retrieves only the CTD transaction details for the requested card
no.
OFOZAPI014 CUSTOMER CARD DETAILS (DNA, DAD & DAE) - Retrieves customer name address,
OFOZAPI015 demographic and AQU Extract details
OFOZAPI016
OFOZAPI017 STATEMENT HEADER INQUIRY - Header information of the statement related to the
requested statement date of the card no. will be retrieved
OFOZAPI018 POSTED & STATEMENT TRANSACTION - Retrieves both CTD as well as statement
transactions
OFOZAPI019 STATUS ENQIRY - Inquires the status of requested card no.
OFOZAPI020 CUSTOMER CARD LIST API FOR DFB - Program specifically for DFB for customer card list
OFOZAPI021 PRODUCT TRANSFER - Retrieves details of transferred card
OFOZAPI022 MERCHANT DETAILS - Retrieves relevant Merchant details for a specific merchant
OFOZAPI023 CIF UPDATE - CIF No. will be updated from this service
OFOZAPI024 SUPPLEMENTAL CARD LIMIT CHANGE - Requested Supplementary Card limit can be
modified from this service
Thank You
