HANDBOOK

API BANKING
OVERVIEW
API is a real time communication between client and bank web servers, through
standard protocols, for processing of any financial or non-financial transactions.

Encrypted Decrypted

Request Request Request

Client’s Client’s Bank’s
application server server I-core
Response Response Response Bank

Decrypted Encrypted

Experience toggle-free Banking and Accounting services straight from your ERP
(Enterprise Resource Planning) application with ICICI Bank's API Banking.

Benefits

Seamless banking Real-time status Automated bank

transactions of transactions reconciliation

Improved operational
Secured data Lowest API
efficiency saving
exchange between the integration TAT
manpower,
bank and your servers (Turn Around Time)
time, effort and cost.

Pre-requisite to avail this service

Customers who have servers on their premise and an in-house IT team to manage
API Banking integration.

Customers who have monthly average transaction volume is greater than 200
through digital modes.

ICICI Bank Current Account.

 CORPORATE INTERNET
BANKING API
What is CIB API?
Through CIB API Suite the Corporate Internet Banking (CIB) services are provided to
clients through their own ERP and applications for seamless payment processing and
reconciliation. Client needs to integrate APIs on their ERP for availing the service. Post
integration, client will be able to do single payments with NEFT, RTGS, IMPS, Fund
Transfer and VAP payment modes. OTP is optional in case of Single payment API. Bulk
payments mode support NEFT and Fund Transfer with mandatory OTP verification. The
CIB API Suite also includes reconciliation APIs such as Bank statement and Balance
Check. Also, additionally Beneficiary Addition, Beneficiary Validation and Beneficiary
Payment with OTP APIs are part of CIB API suite

Flow of CIB APIs

Client’s Bank’s
server server

Real time and Secure (encrypted) flow of data.

Product offerings
Single Payments API Bulk Payment API Reconciliation API

For daily payouts of For salary and vendor Balance Fetch API,
the Corporates. payments of corporates. Bank Statement API
and Bank Statement
Transaction can be Transaction is mandatorily Pagination.
with or without OTP. with OTP.

Beneficiary Addition Three APIs are involved,

and Payment API. namely- CIB Bulk
Payments API, Reverse File
API and Create OTP API.

Advantages

Digital payment Makes reconciliation of Initiate transactions and

solution with least payments much easier reconcile fetching your
manual intervention for your business Bank Statements securely
through your ERP
 COMPOSITE PAY API

What is composite pay API?

The umbrella of composite API comprises of Payments, status check and beneficiary
services APIs including Beneficiary Registration & Validation for Current Accounts and
Nodal account customers. Through this, the customer will have all the payment modes
including IMPS, NEFT, RTGS and UPI as part of this API.

Flow of composite API

Merchant initiates payment request

Bank Server Core Bank
through ERP (NEFT/RTGS/UPI/IMPS)

Request Request Request

Response Response Response

Real time and Secure (encrypted) flow of data.

Product offerings

The API is designed in such a manner that it can accommodate multiple payment
modes and the client can choose to use all or any one mode of payment mode.

Payment Modes Supported – NEFT, RTGS, IMPS, UPI

The API has a provision of prioritizing a specific payment mode

Immediate payment modes like IMPS and UPI can have a fall back option of NEFT
or other payment modes.

The entire maker checker leg is at the customer’s end without any bank’s platform
being involved in the process.

The transaction status check API for UPI Payment, NEFT, RTGS, IMPS, and
Incremental Status API for NEFT.

Beneficiary Registration API through account & IFSC

 Advantages

Can be directly integrated in clients ERP.

Reconciliation can be directly done in ERP.

End-to-end security with Encryption.

Backup payment modes can be added in single request itself to avoid

failures.

No manual intervention or multiple hops in processing of the payments

to the beneficiaries

Use case: E-commerce companies, Payment Gateway aggregator companies and companies
having large multi-mode payments.
 E-COLLECTION API

What is e-collection API?

E-Collections enables a corporate to receive and reconcile collections through
NEFT/RTGS/IMPS/FT/UPI modes. This flexible and customizable solution expedites the
collections process for clients and provides them with real time MIS.
Virtual ID based collection by allocation of Unique Virtual ID for every invoice or vendor.
Payment is made to the Virtual ID instead of actual account number of the Payee.
The product focusses on Corporates/ Schools / Micro Finance / Loan Disbursing
Companies / Government Entities (utilities payment) with large vendor/consumer
database needing regularly to collect money through electronic modes for e.g. B2B/
B2C/ channel partners/ utility service provider companies.

Flow for e-collection API:

1 Client Registers for E-Collection facility with new client code

2 Client share E-collect code (i.e. client code + vendor code) along with
IFSC code to payer

3 Client receives the payment in his current account after successful

validation of client code / vendor code

4 MIS is sent to the client at hourly/EOD with all the transaction details

5 Payer makes payment through NEFT/RTGS/IMPS using the E-Collect

code and IFSC code combination

Product offerings:

Validation API MIS Posting API

Validates payer details MIS posting for each Successful
from the client ERP collection in client ERP
E-Collections with validation mode
Client has a requirement to identify the payer before accepting the payment. A unique Virtual
ID is assigned to each payer that needs to be identified before accepting the payment.

Intimation on credits is sent to the client’s server in XML / JSON format from the bank’s server

The client ERP returns a decision in real-time either to credit or refund the transaction
through ‘accept’ or ‘reject’ response.

Bank necessitates action in accordance with the response, Credits the account and triggers
MIS posting API.

Use case: Would be extremely critical for industries that require releasing limits ex. stockbrokers,
travel agents, vehicle/insurance dealers etc.

E-Collections with non - validation mode

The Virtual ID is a combination of <Client Code> + <Unique No>

<Unique No> can be a challan number for the particular transaction or any unique reference
that can help the Corporate to identify the Payer.

MIS posting API is triggered after processing payment.

Client Code IFSC Code

Client code can be of
3 Digit code ICIC0000103
3, 4 or 6 Digits, The IFSC Code
4 Digit code ICIC0000104
will be as follows
6 Digit code ICIC0000106

Advantages

MIS available in Customized MIS over

Ease of Reconciliation
pre-defined frequency and email, Host to Host in text,
with real-time MIS API
consolidated EOD MIS excel and xml formats

Choice of Validating
Credits are passed Client can opt
Payer details prior to
to single main account for SMS/E Mail alert
transaction credit
 HOST TO HOST
What is H2H?
Host-to-Host (H2H) is an automated solution for secure electronic data transfer
between banks and its clients. H2H connectivity enables banks to exchange information
in the client’s preferred file formats, network protocols, and security standards.

How does it work?

The Bank installs a utility on the client’s system that facilitates transfer of payments file
from the client’s system to Bank’s server as well as to send reverse payments and
collection MIS from Bank’s Server to the client’s system.

Host to host process flow

Client Side Bank Side

Encrypted data will be

H2H utility will
transfered via secured
encrypt/decrypt the
channel to bank server
data and send/ receive
IP [Link] on
to/ from bank server
port 4443

Flat File Output

Log Utility Log

Firewall Internet Firewall

Transactions
Report Reports
SAP
Server Successful
Archive Uploaded Files

H2H for payments

Modes of Reverse MIS Advance Customer Bulk upload Beneficiary

Payments logs for Scheduling Preferred with Email and
Supported easy the upload file Multiple SMS
are NEFT, reconciliation Payments format Debit or Notification,
RTGS, IMPS, single Debit Customized
Fund options Credit and
Transfer debit
narration

Use cases - Salary Payment, Bulk Vendor Payments, Disbursement of loans, etc.
H2H for E-collections
Virtual ID based collection by allocation of Unique Virtual ID for every invoice or vendor.
Payment is made to the Virtual ID instead of actual account number of the Payee.

Modes of E-collections
Reverse MIS
Create Collections with
Collect using logs for
virtual IDs Supported are Validation Or
Virtual IDs easy
on the fly NEFT, RTGS, Non-Validation
reconciliation
IMPS and UPI mode

Client Code IIMB2023PGP0011 Vendor Code

Virtual ID Format
Use cases - Fee Collection using Virtual IDs, E-collection for wholesale and Retail market,
Invoice based E-collections

H2H for MT940 Bank statement

Get daily Bank statement in MT940 format directly delivered on your system

Advantages

The host-to-host system eliminates the tedious manual process of payments, collections
and reconciliation of the MIS.

End-to-End automation Secure medium to Speedy execution of

of payment process transfer payment files transaction

End to end integration with customer's

ERP system for Seamless file automation

Auto/Manual Upload of Elimination of manual Reduced operational risk

file generated by ERP into intervention & Better transactional
Bank’s Portal transparency
 UPI COLLECTION
What is UPI collection API?
UPI collection API is a solution that enbles clients to securely recive payments through
UPI channels with enhanced reports on credit information. This flexible and customisable
solution expedites the collections process for clients and provides real-time settlement
and notification to client ERP system.

Process flow for UPI collection

Merchants customer
Transaction routes Credit happens to
scans QR or initiate
through NPCI Merchant account
collect request

Merchant
Bank notifies to
receives notification
Merchant via API
at his ERP

Product offerings

Collect Pay

Enables merchant website to accept payment using UPI

Customer can pay by approving collect request on any PSP or third party UPI
application of his choice
Call back is triggered once collection received in the account of the Merchant.
Simple reconciliation for Merchant with ref id/invoice number.

Static QR/Dynamic QR

Dynamic QR generated for each transaction, thereby reducing QR risk

Customer can pay by scanning QR code from any PSPs, third party application of
his choice.
Complete privacy to the customer with no Account details or VPA ID exposed (QR)
Call back is triggered once collection received in the account of the Merchant.
Simple reconciliation for the Merchant.
Dynamic VPA with QR

Dynamic VPA along with static QR can be used to collect money from client.
Sample dynamic VPA Ex. [Link]@icici
Client can scan and do payments, which will be credited to merchant account.
Validation for subscriber ID (Dynamic part) will be done from the client end for
every transaction.
Call back is triggered once collection received in the account of the Merchant.
Simple reconciliation for Merchant with subscriber id.

Advantages

Merchant’s end customer

Easy reconciliation Seamless on boarding
can use any UPI app
for Merchant on UPI module
to pay against QR code

VPA Validation API -

End to end security Real time
Returns with the
with Encryption settlement
Beneficiary Name
 NACH
What is NACH?
Businesses can use NACH to collect payments digitally on a recurring basis (Towards
subscription Fees, EMIs, Etc.) or even one time based on mandate.
This solution is particularly useful for Companies offering subscription based products,
utility & other service providers, MFIs/NBFCs, including education/coaching institutes,
healthcare & fitness companies offering health packages,
By filling out the NACH Physical mandate form, the end customer authorises the
corporate to debit their account on a recurring basis.

Flow of NACH

Client ICICI Sponsor Bank Vendor

Physical mandates Scanning and

to ICICI Mandateprocessing

Response

Preparation of Mandate
Mandate MIS Response Data

MIS of mandate
registration to Client

ebit Mandate from

MIS
clients customer
Mandate
Response Data

Verification of mandate
and registration
Product offerings

Corporate can get the mandate (One time registration form) signed from their
customer & send it to ICICI BANK for processing.

ICICI BANK will upload the form on the NPCI Portal. Through the NPCI facility, the
form will be shared to the destination bank.

The destination bank will validate the signature, account number, account name and
confirm whether the mandate has been accepted or rejected.

Once the mandate is registered, Corporate can collect the money from their
customers by sending an excel file via email or SFTP to ICICI Bank

Advantages

NACH collection product has helped corporates to collect the money

from their customers on recurring basis as per agreed frequency.

Corporate does not required to do follow-up with their client to pay the
amount through the NPCI Portal facility.
 ENACH
What is Enach?
Businesses can use ENACH to collect payments digitally on a recurring basis (Towards
subscription Fees, EMIs, Etc.) or even one time based on mandate.
This solution is particularly useful for Companies offering subscription based products,
utility & other service providers, MFIs/NBFCs, including education/coaching institutes,
healthcare & fitness companies offering health packages,
In eNACH, the end customer provides debit authorization via filling the eNACH mandate
form online & authentication happens through Net Banking or Debit Card.

Flow of Enach

Mandate
Destination Internet
Customer Corporate Webpage
Bank Banking
ICICI Vendor

Product offerings:
Corporate provides a web page to their end customers to register and accept the
mandate.
Customers authorize the mandate by providing the internet banking credentials /
Debit card details
Once mandate is registered, Corporate can collect money from its customers has-
sle-free on a recurring basis without any intervention from client.

Advantages
Short mandate acceptance cycle
End to End automation and complete digital process
Secured and assured mandate acceptance
Corporates can create their own Mandate Registration Webpage or use ICICI Bank’s
empanelled vendors.
 API INDUSTRY WISE
USE CASES
Industry Use-Cases API Solution
Vendor Payments, Refunds Payments CIB API Composite API
E-Commerce/
Service UPI Collection,
Invoice Payment Collection
ENACH API
Loan Disbursement, Penny Drop Composite API
NBFC / Fintech
Collect Loan Repayments, Mortgage UPI Collection,
Payments and Credit Card bills ENACH API
Salary Payments of Tutors and other Staff, CIB API, Composite API
Vendor Payments
Education
Collect Loan Repayments, Mortgage E-Collection API
Payments and Credit Card bills ENACH API
Hospital Staff Salary Payments,
Medical Insurance Claims
CIB API
Healthcare Vendor Payments

Collection of Outstanding Bill Payments of

Patients, Medical Bills, Other Services such E-Collection API
as X-RAY, Blood Tests
Vendor Payments, Fund Transfer CIB API
Co-operative
Societies Maintenance Fee Collection, ENACH API,
Utility Bill Payments E-Collection
Vendor Payments, Staff Salary Payment CIB API, Composite API
Hospitality
Accommodation Bill Payments, E-collection API, UPI
Subscription fees Collection, ENACH API
Payments to workers and agencies that
CIB API
provide service to the housing society
Housing Societies
Collect Maintenance Fee / E-collection API,
Club / Utilities Fee from society members NACH API

Vendor Payments, Salary Payments

Balance Check and Bank Statement to CIB API, Composite API
Real Estate Check status of taxation
E-collection API
Collection of Money from Buyers
(Non-Validation mode)

Logistics and Invoice Collections from Customers E-collection

Traders Salary Payments and Vendor Payments CIB API

IT/ITES Salary, Vendor Payments CIB API

Invoice Collection E-collection
To know more about ICICI Bank available APIs,
please go through the following link:

[Link]

For any API related Service and query,

Mail us at
APICONNECT@[Link]

For post API Onboarding Support,

Mail us at
KCMAPI@[Link]

T&Cs