v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Bank Statement

API to request transaction statement from bank accounts enabled for this functionality.

post/bank-stmt

Request body

entityIdstring required

Entity ID for your organization

programIdstring required

Program ID related to this activity

customerRequestIdstring

A unique reference from customer for tracking purposes.

customerIdstring

Customer ID/URN for the account holder (see bankCode table below for bank-wise values)

bankCode string required

4-character bank code.

accountNumberstring required

Account number

fromDateTime string required

From date in “YYYY-MM-DD HH:MM:SS” format. This varies as per the bank. The time will be used if the bank integration supports it otherwise we will send just the date to the bank integration. fromDateTime cannot be more than 6 months before current date-time.

toDateTimestring required

To date in “YYYY-MM-DD HH:MM:SS” format Should be on or after fromDateTime. Should not be more than 30 days from fromDateTime. This varies as per the bank. The time will be used if the bank integration supports it otherwise we will send just the date to the bank integration.

tokenNumber string

Number Required only if using KMBL as the source bank.

Response

Successful response

customerRequestIdstring

Alphanumeric reference received in the request

statusstring

'success' if request is successful, 'error' if error has occurred

messagestring

Success or Error message

dataobject

Collection of transactions

data.transactionIdstring

Bank statement transaction ID for the each transaction

data.transactionDatestring

Transaction date

data.valueDatestring

Transaction value date

data.transactionTypestring

Debit (DR) or Credit (CR)

data.remarksstring

Transaction remarks

data.transactionReferenceNumbestring

Unique transaction reference

data.transactionModestring

Transaction mode such as NEFT/IMPS/RTGS

data.transactionAmountstring

Transaction amount

data.runningBalancestring

Running balance at the end of this transaction