Book

IOB – CORPORATE APPLICATION PROGRAMMING

INTERFACE (API) SUITE

Ver 1.0 Last updated on 26/11/2024

Page 1 of 39

Revision Control : Date

Version

Changes/Comments

26/11/2024

1

Initial Draft

ge a P

39 f 2o

Table of Contents 1. Customer Onboarding ................................................. 6 1.1 Overview ....................................................................................... 6 1.2 Security standards ....................................................................... 6 1.3 Pre-requisites for integration .................................................... 6 1.4 Onboarding process .................................................................. 6 1.5 Customer Application details .................................................. 7

2. Asymmetric Encryption ................................................ 8 2.1 Asymmetric Payload encryption ............................................ 8 2.1.1 Steps involved during the life cycle of Request Response: ..... 8 i. Steps involved during the Request initiation at Client side ....... 8 ii. Steps involved during Request processing at Bank side ............ 8 iii. Steps involved during Response initiation at Bank side .............. 8 iv. Steps involved during Response processing at Client side ........ 9

2.2 JWS request format .................................................................... 9 2.3 Encryption/Decryption .............................................................. 9 2.4 Request headers ......................................................................... 10 2.5 Message format .......................................................................... 10 2.6 API Request Format .................................................................... 10 2.7 API Response Format ................................................................. 10

3. Specifications for the services .................................... 11 3.1 Intra-Bank (IOB to IOB) Funds Transfer API ........................ 11 3.1.1 API Information ...................................................................................... 11 3.1.2 Environment Information .................................................................... 11 3.1.3 IntraBankFT - Request Parameters ................................................... 12 ge a P

39 f 3o

3.1.4 IntraBankFT - Response Parameters .............................................. 13 3.1.5 IntraBankFT - Original Request/Response .................................... 13 3.1.6 IntraBankFT – Postman Collection ................................................. 13

3.2. NEFT/RTGS API ...................................................................... 14 3.2.1 API Information ................................................................................... 14 3.2.2 Environment Info ................................................................................ 14 3.2.3 Neft/Rtgs - Request Parameters ..................................................... 15 3.2.4 Neft/Rtgs - Response Parameters .................................................. 15 3.2.5 Neft/Rtgs - Original Request/Response ........................................ 16 3.2.6 Neft/Rtgs - Postman Collection ...................................................... 16

3.3 IMPS P2A Transaction API 12 ................................................ 16 3.3.1 API Information 12 .............................................................................. 16 3.3.2 Environment Info 12 ........................................................................... 16 3.3.3 P2A - Request Parameters 12 .......................................................... 17 3.3.4 P2A- Response Parameters 13 ........................................................ 18 3.3.5 P2A - Original Request/Response 15 ............................................. 19 3.3.6 P2A - Postman Collection 15 ........................................................... 19

3.4. CBS-AccountStatement-APIv2 ............................................ 20 3.4.1 API Information .................................................................................... 20 3.4.2 Environment Info ................................................................................. 20 3.4.3 AccountStatement - Request Parameters ................................... 21 3.4.4 AccountStatement - Response Parameters ................................ 22 3.4.5 AccountStatement - Original Request/Response ...................... 25 3.4.6 AccountStatement - Postman Collection .................................... 25

3.5. CBS-MiniStatement-APIv2 ................................................... 26 3.5.1 API Information .................................................................................... 26 3.5.2 Environment Info ................................................................................. 26 3.5.3. MiniStatement - Request Parameters ......................................... 27 ge a P

39 f 4o

3.5.4 MiniStatement - Response Parameters ...................................... 27 3.5.5 MiniStatement - Original Request/Response ............................ 29 3.5.6 MiniStatement - Postman Collection .......................................... 29

3.6. CBS- Fetch-IMPS-Transactions-API .................................. 29 3.6.1 API Information ................................................................................... 29 3.6.2 Environment Info ............................................................................... 29 3.6.3 Fetch-IMPS-Transactions - Request Parameters ........................ 30 3.6.4 Fetch-IMPS-Transactions - Response Parameters ..................... 30 3.6.5 Fetch-IMPS-Transactions - Original Request/Response ........... 31 3.6.6 Fetch-IMPS-Transactions - Postman Collection ......................... 31

3.7. CBS-Fetch-NEFT/RTGS-Transactions-API ......................... 32 3.7.1 API Information ................................................................................... 32 3.7.2 Environment Info ............................................................................... 32 3.7.3 Fetch-NEFT-RTGS-Transactions - Request Parameters .............. 32 3.7.4 Fetch-NEFT-RTGS-Transactions - Response Parameters ........... 33 3.7.5 Fetch-NEFT-RTGS-Transactions - Original Request/Response.. 34 3.7.6 Fetch-NEFT-RTGS-Transactions - Postman Collection ............... 34

3.8. CBS-IssueChequeService-API ........................................... 35 3.8.1 API Information ................................................................................... 35 3.8.2 Environment Info ................................................................................ 35 3.8.3 IssueChequeService- Request Parameters ................................ 35 3.8.4 IssueChequeService - Response Parameters ............................ 36 3.8.5 IssueChequeService - Original Request/Response .................. 37 3.8.6 IssueChequeService - Postman Collection ................................ 37

4. API Error Codes .......................................................... 38 4.1 ESB Response codes .......................................................... 38 4.2 Platform Status Codes ........................................................ 39 ge a P

39 f 5o

1. Customer Onboarding : 1.1 Overview The primary objective of this document is to provide our customers a detailed understanding of the offerings of our Corporate API services suite along with necessary information security standards adhered during the integration process.

1.2 Security standards All APIs available under the present suite follow Asymmetric Encryption algorithm (public-key cryptography).

1.3 Pre-requisites for integration Following are the pre-requisites from the customer for a seamless onborading process: i. 1 Certificate Authority(CA) signed public X.509 certificate in PEM format for Two-way SSL purpose ii. 1 Certificate Authority(CA) signed public X.509 certificate in PEM format as part of public-key cryptography iii. Public IPs for necessary whitelisting at IOB side

1.4 Onboarding process The following process illustrates the onboarding process of the customer.

UAT/Testing

Step1: Submit the document and agreement formalities.

Production

onboarding complete

Step1: Submit 2 CA signed x.509 certificates (1 for SSL & 1 for Asymmetric encryption)

ge a P

39 f 6o

UAT/Testing

Production

Step2: Submit 2 CA signed x.509 certificates (1 for SSL & 1 for Asymmetric encryption)

Step2: Sign up on Production Developer portal, subscribe to APIs and receive client id/client secret.

Step3: Sign up on UAT Developer portal, subscribe to APIs and receive client id/client secret.

Step4: Perform testing and obtain signoff from IOB.

1.5 Customer Application details Upon completion of document formalities, the customer shall be able to access the Developer portal of the IOB application, wherein the customer can sign up for the portal and subscribe to APIs. During the process, below mentioned details shall be generated and should be noted by the customer for record. i. Client id ii. Client secret

ge a P

39 f 7o

2. Asymmetric Encryption 2.1 Asymmetric Payload encryption Algorithm and key size Asymmetric Algorithm for key Encryption

RSA-OAEP-256

Symmetric Algorithm for Key encryption

AES256-CBC

Signature Algorithm

RSA-SHA256

Key Size

256 bits

2.1.1 Steps involved during the life cycle of Request Response: i. Steps involved during the Request initiation at Client side Generate 256 bits random key Encrypt the payload using random key with AES256-CBC algorithm.

Encrypt random key using Bank public key with RSA-OAEP-256 algorithm.

Sign the ciphertext using Client private key using RSA-SHA256 algorithm.

ii. Steps involved during Request processing at Bank side Bank shall verify the signature using client’s public key Bank shall decrypt the encrypted random key using Bank private key Bank shall decrypt the ciphertext using the decrypted random key to receive plain payload

iii. Steps involved during Response initiation at Bank side Bank shall generate 256 bits random key Bank shall encrypt the payload using random key with AES256-CBC algorithm.

Bank shall encrypt the random key using Client public key with RSAOAEP-256 algorithm Bank shall sign the ciphertext using Bank private key using RSA39 f SHA256 algorithm. o 8 e g Pa

iv. Steps involved during Response processing at Client side Client shall verify the signature using Bank public key Client shall decrypt the encrypted random key using Client private key Client shall decrypt the ciphertext using the decrypted random key to receive plain payload

2.2 JWS request format JWS request contains Header, Payload, Signature.

After verification JWS turn into JWE request for the decryption.

JWE request contains Header, encrypted key, IV, ciphertext, Authentication tag.

2.3 Encryption/Decryption Method

Description

API Catalog

SANDBOX | EXTERNAL

Asymmetric Algorithm for key Encryption

RSA-SHA256

Symmetric Algorithm encryption

AES256-GCM

Signature Algorithm

for

Key

RSA-SHA256

Key Size

256 bits

Process

JWE Encrypt the payload using IOB certificate shared using KEY algorithm RSA-OAEP-256 and payload encryption algorithm AES256-GCM and JWS sign the resulting encrypted value using RSASHA256 algorithm and API consumer’s private key ge a P

39 f 9o

2.4 Request headers Header Name

Value

Description

Authorization

Bearer <<token>>

Oauth Token

2.5 Message format Consumes : application/json Produces: application/json

2.6 API Request Format { "enc": "pXkClLExMlUQHXphnESCiGnjF3b3hVKR8AR7op98bG2Vl7js9R3cGa6bOnv nkjhd0sV2tk9aW3VC7GW9VVvQILsT/H6W4JMFYvmpvuqPinuPv+IPMzOV4 ybWfb7Q9JgVh6JwzQdQmGkdlE/Pzhd4tQ==" }

2.7 API Response Format { "enc": "3PZIpcqNBgb5ftiwH8ccwqgfpbNxT97LgFrVcGbta46iZkFYXgG0Jek8uTrKzHs NxRG1rd51syHCz6WuEV//vPcY9X9TO2o/vC0JUlN5p6S/oPU3ZJZVA1l43VIbt qqUWmYqNTXyFMeBGKZskteOgXmfJOB8b+vbHAUOjdrlxqQERruw+HhG7Bi SzN496m55w9xQEjGQM7tzrPatIrAyh/i9P0sQ6+dKfZMQbmfL1g05ItoiY/1hfhtj 8ujuAElnAmflnSta5SV+ez+EJBKZTD+WRs2zxifcvY8R/Wll09FSx20kdaDysoHnR mnP/GEIRwnr+im0qTL4hZrU42ruifUXpN9qYJbFfEAZKvIXCko=" }

39 f o 0 e1 g Pa

3. Specifications for the services 3.1. Intra-Bank (IOB to IOB) Funds Transfer API This API is used for transfer the amount within IOB accounts.

3.1.1 API Information API Spec

Description

Product Title:

Interbank-FT

Name:

InterBank-Fundtransfer -API

Version:

1.0.0

3.1.2 Environment Information API Spec

Description

API CATALOG

Sandbox

INTERNAL/EXTERNAL

EXTERNAL

API URL

InterBankF t

https://apigatewaysandbox.iob.in/iob -sb ext/external/IntrabankFT/ intrabank/fundtransfer/v1

URL

https://apigatewaysandbox.iob.in/i ob-sb-ext/external/intrabank-ftoauth/oauth2/token

client_id

<subscribed application clientid>>

Oauth

39 f o 1 e1 g Pa

API Spec

Oauth

Description client_secret

<subscribed application client secret>>

scope

INTRABANK

grant_type

client_credentials

Version

v1.0.0

Format

application/json

Method

POST

3.1.3 IntraBankFT - Request Parameters S.NO

FieldName

Data Length Type

1

RequestId

32

String

NM

Unique tnx ID

2

SessionId

32

String

NM

Session id

String

Card number (required Conditional if TranType=NCMC)

3 4

CardNumber 15 stanNo

12

String

Mandatory

Description

Mandatory

Unique tnx id for c24 request

5

Amount

10

String

Mandatory

Amount – last 2 digits are paise

6

creditAccou ntNumber

32

String

Mandatory

Beneficiary a/c number 39 f o 2 e1 g Pa

S NO

FielName

Length

Data Type

Mandatory

Description

7

Transaction Narration

20

String

Mandatory

Narration

8

DebitAccountNum 15 ber

String

Mandatory

Remitter a/c number

Mandatory

Supported TranTypes are: 1.FUNDTRANSFER 2.RDPAY 3.Prepaid 4.CRCARDNO 5.BINET|LOANREPAY 6.NCMCMADD

9

TranType

10

String

3.1.4 IntraBankFT - Response Parameters S.NO

Parameter

Data Type

Mandatory

Description

1

code

String

Mandatory

Transaction code

2

status

String

Mandatory

Transaction status

3

desc

String

Mandatory

Transaction desc

3.1.5 IntraBankFT - Original Request/Response

3.1.6 IntraBankFT – Postman Collection 39 f o 3 e1 g Pa

3.2 NEFT/RTGS API This API is used for transfer the amount outside IOB accounts.

3.2.1 API Information API Spec

Description

Product Title:*

NEFT/RTGS

Name:*

NEFT/RTGS-Fund-Transfer-API

Version:*

1.0.0

3.2.2 Environment Info API Spec

Description

API CATALOG

SANDBOX

INTERNAL/ EXTERNAL

EXTERNAL

API URL

Oauth

NEFT/RTGS

https://apigatewaysandbox.iob.in/iob-sbext/external/neft/rtgs-fund-transfer/neft/rtgs-ft/v1

URL

https://apigatewaysandbox.iob.in/iob-sbext/external/neft-rtgs-auth/oauth2/token

client_id

<subscribed application clientid>>

client_secret <subscribed application client secret>> scope

NEFT

grant_type

client_credentials

Version

v1.0.0

Format

application/json

Method

POST

39 f o 4 e1 g Pa

3.2.3 Neft/Rtgs - Request Parameters S.NO

FieldName

Length Data Type

Mandatory

Description Unique tnx ID

1

RequestId

16

String

NM

2

stanno

21

String

Mandatory

3

TransactionType

4

String

Mandatory

4

CreditAccountNumber

15

String

Mandatory

Beneficiary a/c number

5

DebitAccountNumber

15

String

Mandatory

Remitter a/c number

6

TransactionNarration

20

String

Mandatory

Narration

7

IFSCCODE

15

String

Mandatory

8

ChargesRequired

3

String

Mandatory

9

Amount

String

Mandatory

10

Name

50

String

Mandatory

11

SessionId

32

String

NM

3.2.4 Neft/Rtgs - Response Parameters Parameter

Data Type

Mandatory

Description

RequestId

String

Mandatory

Unique tnx ID

code

String

Mandatory

Transaction code

status

String

Mandatory

Transaction status

desc

String

Mandatory

Transaction desc

39 f o 5 e1 g Pa

3.2.5 Neft/Rtgs - Original Request/Response:

3.2.6 Neft/Rtgs - Postman Collection

3.3 IMPS P2A Transaction API This API allows users to transfer funds directly to a beneficiary's bank account using details like the account number and IFSC code. Its purpose is to facilitate quick, secure, and seamless real-time interbank fund transfers.

3.3.1 API Information API Spec

Description

Product Title:*

IMPS-P2A-Transaction

Name:*

IMPS-P2A-Transaction-API

Version:*

1.0.0

3.3.2 Environment Info API Spec

Description

API CATALOG

SANDBOX

INTERNAL/ EXTERNAL

EXTERNAL 39 f o 6 e1 g Pa

API Spec

Description

API URL

P2A

https://apigatewaysandbox.iob.in/iob-sbext/external/imps/p2a/transaction/v1

URL

https://apigatewaysandbox.iob.in/iob-sbext/external/imps/oauth2/token

client_id Oauth

client_secret scope grant_type

<subscribed application clientid>> <subscribed application client secret>> P2A client_credentials

Version

v1.0.0

Format

application/json

Method

POST

3.3.3 P2A - Request Parameters S.NO

FieldName

Data Type

Length

Mandatory Example

1

mobNo

Alpha Numeric

Oct-13

M

9.19791E+11

2

tType

Alpha Numeric

Jun-15

M

mid708

3

bankId

Alpha Numeric

06-Dec

M

422132

4

bVer

Alpha Numeric

Mar-15

M

6

5

mType

Alpha Numeric

03-Mar

M

req

6

remName

Alphabets

Mar-80

M

Test

7

remUserId

Alpha Numeric

Apr-15

O

39 f o 7 e1 g Pa

S.NO FieldName

Data Type

Length

Mandatory

Example

8

remCustId

Alpha Numeric

06-Dec M

287284

9

remMob

Alpha Numeric

Oct-13

M

9.1984E+11

10

remAcc

Alpha Numeric

Oct-19

M

7.35386E+11

11

beneIFSC

Alpha Numeric

11/ 11

M

INDB0101334

12

tranAmt

Alpha Numeric

1/10

M

70.5

13

remarks

Alpha Numeric

1/40

M

Test

14

beneAc

Alpha Numeric

M

15

txnDateTime Date

M

019-12-02 T20:01:32+05:30

16

txnId

M

2.87285E+11

Alpha Numeric

3.3.4 P2A- Response Parameters FieldName Data Type

Length Mandatory Example

mType

Alpha Numeric 03-Mar M

rsp

tType

Alpha Numeric Jun-15 M

mid708

rsCode

AlphaNumeric

0

3 / 15 M

rsMsg

Alpha Numeric 1 / 200 M

Your a/c no.

XXXXXXXX4667 is debited for Rs. 15.00 on 10/12/19 and a/c XXXXXXX - (a/c holder name - kiran) credited.

(IMPS reference no.

934413490606)

vailBal

Alpha Numeric 20

O

1885.01

beneName Alpha Numeric 20

O

kiran 39 f o 8 e1 g Pa

FieldName Data Type

Length Mandatory Example

orgRspCode Alpha Numeric 2

O

0

pushNotific Alpha Numeric 250 ation Message

O

Your a/c no. XXXXXXXX4667 is debited for Rs. 15.00 on 10/12/19 and a/c XXXXXXX (a/c holder name - kiran) credited.

(IMPS reference no.

934413490606).

smsMessag Alpha Numeric 250 e

O

Your a/c no.XXXXXXXX4667 is debited for Rs. 15.00 on 10/12/19 and a/c XXXXXXX - (a/c holder name - kiran) credited. (IMPS reference no.

934413490606).

txnId

Numeric

12-Dec M

dateTime

Alpha Numeric Apr-50 M

2017-09- 27T13:56:39+05:30

rspTime

Alpha Numeric Apr-15 M

0.026

nodeName Alpha Numeric Apr-50 M

7.2704E+11

M2NODE

3.3.5 P2A - Original Request/Response

3.3.6 P2A - Postman Collection

39 f o 9 e1 g Pa

3.4 CBS-AccountStatement-APIv2 The CBS AccountStatement API retrieves account transaction details with pagination and without pagination, enabling efficient, scalable, and filtered data access for seamless integration with banking systems.

3.4.1 API Information API Spec

Description

Product Title:*

CBS-AccountStatement-v2

Name:*

CBS-AccountStatement-APIv2

Version:*

1.0.0

3.4.2 Environment Info API Spec

Description

API CATALOG

SANDBOX

INTERNAL/ EXTERNAL

EXTERNAL

API URL

Oauth

A/C Statement https://apigatewaysandbox.iob.in/iob-sbext/external/cbs/accountstatement/v2 URL

https://apigatewaysandbox.iob.in/iob-sbext/external/accountstatement/v2/oauth2/toke

client_id

<subscribed application clientid>>

client_secret

<subscribed application client secret>>

scope

Accounts

grant_type

client_credentials

Version

v1.0.0

Format

application/json

Method

POST

39 f o 0 e2 g Pa

3.4.3 AccountStatement - Request Parameters S.NO FieldName

Length

Data Type Mandatory

Description

1

RequestUUID

16-32

String

Mandatory

RequestUUID

2

ChannelId

01-Jun

String

Mandatory

ChannelId

JSON OBJECT

Mandatory

3

Body

4

RequestID

16-32

String

Mandatory

RequestID

5

userID

05-Oct

String

Mandatory

userID

6

acid

15-16

String

Mandatory

acid

7

branchId

04-Oct

String

Mandatory

branchId

8

fromDate

20

String

Mandatory

fromDate

9

numOfTxns

10

Numeric

Mandatory

numOfTxns

10

toDate

20

String

Mandatory

toDate

11

paginationDetails NA

Object

Optional

Object

Conditional if paginationDet ails is passed

12

13

14

15

16

lastBalance

NA

amountValue

Up to 10 Digits 2 String Decimal

Conditional if paginationDet ails is passed

3

String

Conditional if paginationDet ails is passed

String

Conditional if paginationDet ails is passed

20

Conditional if paginationDet ails is passed

currencyCode

lastPstdDate

lastTxnDate

20

20

39 f o 1 e2 g Pa

S.NO 17

FieldName

Length Empty or <10

lastTxnId

Data Type

Mandatory

Description

String

Conditional if paginationDe tails is passed

String

Conditional if paginationDe tails is passed

18

lastTxnSrlNo

Empty or <10

19

txnType

1

String

Optional

20

sortIn

1

String

Optional

3.4.4 AccountStatement - Response Parameters FieldName

Description

Mandatory

String

Unique identifier for the request.

Length: 16-32, Alphanumeric, No < or >

String

Identifier for the channel Length: ≤6, Uppercase making the request. letters only

Object

Contains the main response data.

Required

PaginatedAccou Object ntStatement

Contains account balances and transaction details.

Required

accountBalances Object

Details of the account balances.

Required

acid

Account ID.

15-16 digits only

Currency code for the available balance.

3 uppercase letters

RequestUUID ChannelId Body

Data Type

String

availableBalance String .currencyCode

39 f o 2 e2 g Pa

FieldName

Data Type

Description

Mandatory

String

Up to 10 digits with Forward Float balance optional 2 decimal amount. places

fFDBalance.currency String Code

Currency code for 3 uppercase letters Forward Float balance.

floatingBalance.amo String untValue

Floating balance amount.

Up to 10 digits with optional 2 decimal places

floatingBalance.curr encyCode

String

Currency code for Floating balance.

3 uppercase letters

ledgerBalance.curre String ncyCode

Currency code for ledger balance.

3 uppercase letters

userDefinedBalance.

String currencyCode

Currency code for user-defined balance.

3 uppercase letters

field125, field126, field127

Object

Reserved or additional Optional fields.

hasMoreData

String

Indicato if more data exists for pagination.

Empty or Booleanlike values

transactionDetails

Array of Objects

List of transactions.

Required

pstdDate

String Posted date of the (ISO 8601) transaction.

fFDBalance.amount Value

Format: YYYY-MMDTHH:mm:ss.sss

transactionSummary Object

Summary of the transaction details.

transactionSummary.

String instrumentId

Identifier for the Optional, Can be transaction instrument. empty

Required

39 f o 3 e2 g Pa

FieldName

Data Type

Description

Mandatory

transactionSummary.

String txnAmt.amountValue

Transaction amount.

Up to 10 digits with optional 2 decimalplaces

transactionSummary. txnAmt.currencyCod String e

Currency code for the transaction amount.

3 uppercase letters

transactionSummary.

Date of the String (ISO 8601) txnDate transaction.

Format: YYYY-MMDTHH:mm:ss.sss

transactionSummary.

String txnDesc

Transaction description.

Optional

transactionSummary.

String txnType

Type of transaction (C for credit, D for 1 character only debit).

transactionSummary.

Object addtnlData

Additional data related to the transaction.

Optional

txnBalance.amountV String alue

Balance after the transaction.

Up to 10 digits with optional 2 decimalplaces

txnBalance.currency Code

String

Currency code for the transaction balance.

3 uppercase letters

txnCat

String

Transaction category.

Optional

Transaction ID.

Alphanumeric, Up to 10 characters

txnId

String

39 f o 4 e2 g Pa

FieldName

Data Type

Description

Mandatory Numeric, Up to 10 digits

txnSrlNo

String

Transaction serial number.

valueDate

String (ISO 8601)

Value date of the transaction.

Format: YYYY-MMDDTHH:mm:ss.sss

Object

Custom data related to the account statement.

Optional

String

Additional custom data field.

Optional

getFullAccountSt atementWithPa gination_Custo mData

THB

3.4.5 AccountStatement - Original Request/Response

3.4.6 AccountStatement - Postman Collection

39 f o 5 e2 g Pa

3.5 CBS-MiniStatement-APIv2 3.5.1 API Information API Spec

Description

Product Title:*

CBS-MiniStatement

Name:*

CBS-MiniStatement-API

Version:*

1.0.0

3.5.2 Environment Info API Spec

Description

API CATALOG

SANDBOX

INTERNAL/ EXTERNAL

EXTERNAL

API URL

Oauth

https://apigatewaysandbox.iob.in/iob-sbext/external/cbs/fetch/ministatement/v1 URL

https://apigatewaysandbox.iob.in/iob-sbext/external/ministatement/oauth2/token

client_id

<subscribed application clientid>>

client_secret

<subscribed application clientsecret>>

scope

Fetch

grant_type

client_credentials

Version

v1.0.0

Format

application/json

Method

POST

39 f o 6 e2 g Pa

3.5.3 MiniStatement - Request Parameters S.NO FieldName

Length

Data Type

Mandatory Description

1

RequestUUID 16-32

String

Mandatory RequestUUID

2

ChannelId

String

Mandatory ChannelId

3

Body

JSON OBJECT

Mandatory

4

RequestID

16-32

String

Mandatory RequestID

5

userID

05-Oct

String

Mandatory userID

6

acid

15-15

String

Mandatory acid

7

branchId

04-Oct

String

Mandatory branchId

01-Jun

3.5.4 MiniStatement - Response Parameters Parameter

Length

Data Type

Mandatory

requestID

10

String

Mandatory

status

10

String

Description

TRUE

S/F(Success/ Failure)

errorCode

10

String

Optional

Error code in case of failure

error Description

100

String

Optional

Error description

remarks

100

String

TRUE

Remarks

39 f o 7 e2 g Pa

Parameter

Length

Data Type

Mandatory

Description

getMiniAc countStat ementRes ponse

500

Array List {} [length] getMiniAccountStatementResp onse { MiniStatementSummary { accountSummary { acid[15], availableBalance { amountValue[20,4], currencyCode[3] } branchId[4], currencyCode[3], fFDBalance { amountValue[20,4], currencyCode[3] } floatingBalance { amountValue[20,4], currencyCode[3] } ledgerBalance { amountValue[20,4], currencyCode[3] } userDefinedBalance { amountValue[20,4], currencyCode[3] } }accountTransactionSummary { instrumentId[12], txnAmt { amountValue[20,4], currencyCode[3] } txnDate[25], txnDesc[50], txnType[1] } } }

TRUE

AccountSumm ary Details: Account Number, Available Balance (Amount, Currency), Branch Code, Currency Code, FFD Balance, Floating Balance, Ledger Balance, User defined Balance Account Transaction Summary Details: Instrument ID, Transaction Amount (Amount, Currency), Transaction date, Transaction Description, Transaction Type 39 f o 8 e2 g Pa

3.5.5 MiniStatement - Original Request/Response

3.5.6 MiniStatement - Postman Collection

3.6. CBS- Fetch-IMPS-Transactions-API 3.6.1 API Information API Spec

Description

Product Title:*

CBS-Fetch-IMPS-Transactions

Name:*

CBS- Fetch-IMPS-Transactions-API

Version:*

1.0.0

3.6.2 Environment Info API Spec

Description

API CATALOG

SANDBOX

INTERNAL/EXTERNAL

External

API URL

https://apigatewaysandbox.iob.in/iob-sbext/external/cbs/fetch/imps-transactions/v1

Token URL

https://apigatewaysandbox.iob.in/iob-sbext/external/imps-transactions/oauth2/token

Token Scope

Fetch

Version

v1.0.0

Format

Application/json

Method

POST

39 f o 9 e2 g Pa

3.6.3 Fetch-IMPS-Transactions - Request Parameters Parameter

Length

Data Type

Mandatory/ Optional

Description

FIXML HEADER RequestUUID

16-32

String

Mandatory 1931b4974792229300

ChannelId

01-Jun

String

Mandatory

requestID

Aug-32

String

Mandatory

userID

05-Oct

String

Mandatory

makerID

05-Oct

String

Optional

checkerID

05-Oct

String

Optional

acno

15-15

String

Mandatory Account Number

Date

Value From Date Ex: Mandatory 01-01-2023

Date

Value To Date Ex: 01Mandatory 01-2023

FIXML BODY

fromdate todate

10 10

3.6.4 Fetch-IMPS-Transactions - Response Parameters Parameter

Length Data Type

Mandatory

Description

requestID

10

String

Mandatory

status

10

String

String

S/F(Success/Failure)

errorCode

10

String

Optional

Error code in case of failure

errorDescription

100

String

Optional

Error description 39 f o 0 e3 g Pa

Parameter

Length

Data Type

Mandatory

Description

remarks

100

String

TRUE

Remarks

crm

500

Array List {} [length] { sol [10], valuedt[15], arttrantype [10],ccy[10], amount[20, 2],tranpartic ular[250], lchgtime[50 ], msgrrn[100], ranid[25], trandt[25] }

TRUE

Tran SOL ID, Value Date, Part Tran Type, Tran Currency Code, Tran Amount, Tran Particular, Last Changed Time (DD-MMMYYYY HH:MM:SS), Message RRN, Tran ID, Tran Date

3.6.5 Fetch-IMPS-Transactions - Original Request/Response

3.6.6 Fetch-IMPS-Transactions - Postman Collection

39 f o 1 e3 g Pa

3.7. CBS-Fetch-NEFT/RTGS-Transactions-API 3.7.1 API Information API Spec

Description

Product Title:*

CBS-Fetch-NEFT-RTGS-Transactions

Name:*

CBS- Fetch-NEFT-RTGS-Transactions-API

Version:*

1.0.0

3.7.2 Environment Info API Spec

Description

API CATALOG

SANDBOX

INTERNAL/EXTERNAL

External

API URL

https://apigatewaysandbox.iob.in/iob-sbext/external/cbs/fetch/neft-rtgs-transactions/v1

Token URL

https://apigatewaysandbox.iob.in/iob-sbext/external/neft-rtgs-transactions/oauth2/token

Token Scope

Fetch

Version

v1.0.0

Format

Application/json

Method

POST

3.7.3 Fetch-NEFT-RTGS-Transactions - Request Parameters Parameter

Length

Data Type

Mandatory/ Optional

Description

FIXML HEADER RequestUUID

16-32

String

Mandatory

1931b4974792229300

ChannelId

01-Jun

String

Mandatory

COR

39 f o 2 e3 g Pa

Data Type

Mandatory/ Optional

requestID

Aug-32 String

Mandatory

userID

05-Oct

String

Mandatory

acno

15-15

String

Mandatory

Account Number

fromdate

10

Date

Mandatory

Value From Date Ex: 01-01-2023

todate

10

Date

Mandatory

Value To Date Ex: 01-01-2023

paysysid

5

String

Mandatory

Paysys ID – NEFT (or) RTGS

Parameter

Length

Description

FIXML BODY

3.7.4 Fetch-NEFT-RTGS-Transactions - Response Parameters Parameter

Length

Data Type

Mandatory

Description

requestID

10

String

Mandatory

status

10

String

TRUE

S/F(Success/Failure)

errorCode

10

String

Optional

Error code in case of failure

errorDescription

100

String

Optional

Error description

remarks

100

String

TRUE

Remarks

39 f o 3 e3 g Pa

Parameter

Length

Data Type

Mandatory

Description

crm

500

Array List {} [length] { SOL_ID [8], lchgtime [15], valuedt [15], trandt [15], tranid [9], parttrantype[1], tran_crncy_code [3], amount [20,4], Bank [50], UTR [50], tranparticular [50], TRAN_RMKS_OUTWA RD_IFSC [30], INWARD_Routing_R ef_Num[20] }

TRUE

SOL ID, Last changed Time, Value Date, Tran Date, Tran ID, Part Tran Type, Tran Currency Code, Tran Amount, Bank, UTR, Transaction particular, Tran remarks outward IFSC, Inward routing reference number

3.7.5 Fetch-NEFT-RTGS-Transactions - Original Request/Response

3.7.6 Fetch-NEFT-RTGS-Transactions - Postman Collection

39 f o 4 e3 g Pa

3.8. CBS-IssueChequeService-API 3.8.1 API Information API Spec

Description

Product Title:*

CBS-IssueChequeService

Name:*

CBS-IssueChequeService-API

Version:*

1.0.0

3.8.2 Environment Info API Spec

Description

API CATALOG

SANDBOX

INTERNAL/EXTERNAL

External

API URL

https://apigatewaysandbox.iob.in/iob-sbext/external/cbs/issue/chequeservice/v1

Token URL

https://apigatewaysandbox.iob.in/iob-sbext/external/issuechequeservie/oauth2/token

Token Scope

Issue

Version

v1.0.0

Format

Application

Method

POST

3.8.3 IssueChequeService- Request Parameters Parameter

Mandatory/ Optional

Length

Data Type

Description

RequestUUID

16-32

String

Mandatory

1931b4974792229300

Channe lId

1-6

String

Mandatory

COR

FIXML HEADER

39 f o 5 e3 g Pa

Parameter Length

Data Type

Mandatory /Optional

Description

FIXML BODY requestID

16-32

String

Mandatory

userID

10

String

Mandatory

makerID

10

String

Mandatory

checkerID 10

String

Mandatory

accountN 15 umber

String

Mandatory

chequeBo 10 okType

String

Mandatory SB20

SBA 20 LEAVES

CA50

CAA 50 LEAVES

CC50

CCA 50 LEAVES

CA100

CAA 100 LEAVES

CC100

CCA 100 LEAVES

SB20A

SBA 20 LEAVES VIA ADC

CC50A CCA 50 LEAVES VIA ADC CA50A

CAA 50 LEAVES VIA ADC

noOfLeav 01-May Number Mandatory Multiples of Cheque Book Type es crossType 02-Mar brcode

String

04-May String

Mandatory NN – Not Negotiable Mandatory Branch Code of the userID

3.8.4 IssueChequeService - Response Parameters Parameter requestID

Length Data Type String

Mandatory Mandatory

Description 39 f o 6 e3 g Pa

Parameter Status

Length

Data Type

Mandatory

Description

String

TRUE

SUCCESS/FAILURE

String

Optional (if no error observed)

Error code in case of failure

errorDescripti on

String

Optional (if no error observed)

Error description

remarks

String

TRUE

Remarks

errorCode

3.8.5 IssueChequeService - Original Request/Response

3.8.6 IssueChequeService - Postman Collection

39 f o 7 e3 g Pa

4. API Error Codes 4.1 ESB Response codes Error Codes

Description

ESB-200

Success

ESB-ERR-100

Invalid Account Number

ESB-ERR-101

Invalid CIF ID

ESB-ERR-102

Invalid IFSC code

ESB-ERR-104

SMS Generation Error

ESB-ERR-105

SMS Generation Error

ESB-ERR-106

Account Validation Failure

ESB-ERR-107

OTP Expired

ESB-ERR-108

Invalid OTP

ESB-ERR-109

Session Expired

ESB-ERR-110

Invalid Session

ESB-ERR-111

No active session

ESB-ERR-112

In valid Account number

ESB-ERR-113

Account Authentication Failure

ESB-ERR-125

Token Error

39 f o 8 e3 g Pa

4.2 Platform Status Codes Status Codes

Description

200

OK

201

Account Access Consents Created

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

406

Not Acceptable

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

39 f o 9 e3 g Pa