Bank Statement Extraction

8 min

Introduction

This API allows you to retrieve bank statements for a specific patron using their patron ID. By integrating this API into your application, you can automate the process of fetching bank statements and streamline your banking operations.

How to call the API

You will need to login before sending request.

Replace the placeholder "..your-patron-id.." in the URL with the actual patron ID for whom you want to retrieve bank statements. The URL should be in the format: https://signzy.tech/api/v2/patrons/{patron-id}/bankStatements.
Obtain an access token from Signzy. Replace "<Access-Token>" in the Authorization header with the actual access token. The access token is usually provided when you register and authenticate with Signzy's API services.
Fill in the required information in the request body JSON. Replace the placeholder values "url," "bankName," and "accountType" with the appropriate values for the bank statement service URL, the name of the bank, and the account type respectively.
Once you have replaced all the necessary placeholders, execute the cURL command in a terminal or command prompt to make the API call.

API Input Guidelines

To use the Signzy Bank Statements API, you need to obtain an access token. The access token should be included in the "Authorization" header of your API requests.
Ensure that you have the necessary permissions and authentication to access the bank statements of the specified patron.
The API follows the RESTful architecture and supports the HTTP POST method for retrieving bank statements.
The request and response data are formatted in JSON.

Sample Curl

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/{patron-id}/bankStatements \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"essentials":{"url":"...url..","bankName":"...bankName...","accountType":"...accountType..."}}'

Input Parameters

Parameter	Type	Required	Description
url	string	Required	The URL of the bank statement service for the specified patron.
bankName	string	Required	The name of the bank for which you want to retrieve statements.
accountType	string	Required	The type of the bank account (e.g., savings, current, credit card).

Sample Reponse

    // Expected response
    {
    	"result": {
    		"bankName": "..bankName...",
    		"accountType": "..accountType..",
    		"accountHolder": "..accountHolder..",
    		"address": "..address..",
    		"accountLimit": "..accountLimit..",
    		"accountNo": "..accountNo..",
    		"availableCashLimit": "..availableCashLimit..",
    		"availableCreditLimit": "..availableCreditLimit..",
    		"bankAddress": "..bankAddress..",
    		"bankCredentialCO": "..bankCredentialCO..",
    		"bankTransactionList": ["..bankTransactionList..."],
    		"branchAddress": "..branchAddress..",
    		"cifNumber": "..cifNumber..",
    		"client": "..client..",
    		"creditCardNo": "..creditCardNo..",
    		"creditLimit": "..creditLimit..",
    		"crnNo": "..crnNo...",
    		"currentCashAdvance": "..currentCashAdvance..",
    		"currentPurchaseCharges": "..currentPurchaseCharges..",
    		"customer": "..customer..",
    		"customerID": "..customerID..",
    		"customerPhoneNo": "..customerPhoneNo..",
    		"dueDate": "..dueDate..",
    		"email": "..email..",
    		"fromDate": "..fromDate..",
    		"ifsCode": "..ifsCode..",
    		"lastPaymentReceived": "..lastPaymentReceived..",
    		"micrCode": "..micrCode..",
    		"minAmountDue": "..minAmountDue..",
    		"openingBalance": "..openingBalance..",
    		"pan": "..pan..",
    		"pointsEarned": "..pointsEarned..",
    		"prevBalance": "..prevBalance..",
    		"relationshipWithBank": "..relationshipWithBank..",
    		"toDate": "..toDate..",
    		"totalAmountDue": "..totalAmountDue..",
    		"allTransactions": [{
    			"amount": "..amount..",
    			"balanceAfterTransaction": "..balanceAfterTransaction...",
    			"date": "..date..",
    			"description": "..description..",
    			"firstLevelCategory": "..firstLevelCategory..",
    			"remark": "..remark..",
    			"secondLevelCategory": "..secondLevelCategory..",
    			"transactionNumber": "..transactionNumber..",
    			"type": "..type..",
    			"valueDate": "..valueDate.."
    		}],
    		"transactionDistribution": {
    			"atmWithdrawls": [{
    				"amount": "..amount..",
    				"bank": "..bank..",
    				"date": "..date..",
    				"time": "..time..",
    				"description": "..description.."
    			}],
    			"averageMonthlyBalance": [{
    				"netAverageBalance": "..netAverageBalance..",
    				"monthAndYear": "..monthAndYear..",
    				"dayBalanceMap": {
    					"1": "..amount..",
    					"5": "..amount..",
    					"10": "..amount..",
    					"15": "..amount..",
    					"20": "..amount..",
    					"25": "..amount..",
    					"30": "..amount.."
    				}
    			}],
    			"averageQuarterlyBalance": [{
    				"netAverageBalance": "..netAverageBalance..",
    				"monthAndYear": "..monthAndYear.."
    			}],
    			"expenses": [{
    				"amount": "..amount..",
    				"bank": "..bank..",
    				"category": "..category..",
    				"date": "..date..",
    				"time": "..time..",
    				"description": "..description.."
    			}],
    			"highValueTransactions": [{
    				"amount": "..amount..",
    				"bank": "..bank..",
    				"category": "..category..",
    				"balanceAfterTransaction": "..balanceAfterTransaction..",
    				"date": "..date..",
    				"time": "..time..",
    				"type": "..type..",
    				"description": "..description.."
    			}],
    			"incomes": [{
    				"amount": "..amount..",
    				"bank": "..bank..",
    				"category": "..category..",
    				"balanceAfterTransaction": "..balanceAfterTransaction..",
    				"date": "..date..",
    				"time": "..time..",
    				"transactionType": "..transactionType..",
    				"isSalary": "..isSalary..",
    				"isSalaryCheck": "..isSalaryCheck..",
    				"description": "..description..",
    				"total": "..total.."
    			}],
    			"internalTransactionList": [{
    				"amount": "..amount..",
    				"bank": "..bank..",
    				"category": "..category..",
    				"balanceAfterTransaction": "..balanceAfterTransaction..",
    				"date": "..date..",
    				"time": "..time..",
    				"transactionType": "..transactionType..",
    				"description": "..description.."
    			}],
    			"investments": [{
    				"amount": "..amount..",
    				"bank": "..bank..",
    				"category": "..category..",
    				"balanceAfterTransaction": "..balanceAfterTransaction..",
    				"date": "..date..",
    				"time": "..time..",
    				"type": "..type..",
    				"description": "..description.."
    			}],
    			"minimumBalances": [{
    				"amount": "..amount..",
    				"bank": "..bank..",
    				"category": "..category..",
    				"balanceAfterTransaction": "..balanceAfterTransaction..",
    				"date": "..date..",
    				"time": "..time..",
    				"transactionType": "..transactionType..",
    				"description": "..description.."
    			}],
    			"missingMonths": ["..missingMonths.."],
    			"moneyReceivedTransactions": [{
    				"amount": "..amount..",
    				"bank": "..bank..",
    				"category": "..category..",
    				"balanceAfterTransaction": "..balanceAfterTransaction..",
    				"date": "..date..",
    				"time": "..time..",
    				"transactionType": "..transactionType..",
    				"description": "..description..",
    				"total": "..total.."
    			}]

    		}
    	}

    }

Response Parameters

Parameter	Description
bankName	The name of the bank for which the statements are retrieved.
accountType	The type of the bank account.
accountHolder	The account holder's name.
address	The address associated with the account.
accountLimit	The account limit.
accountNo	The account number.
availableCashLimit	The available cash limit.
availableCreditLimit	The available credit limit.
bankAddress	The address of the bank.
bankCredentialCO	The bank credential CO.
bankTransactionList	A list of bank transactions.
branchAddress	The address of the bank branch.
cifNumber	The CIF number.
client	The client associated with the account.
creditCardNo	The credit card number.
creditLimit	The credit limit.
crnNo	The CRN number.
currentCashAdvance	The current cash advance amount.
currentPurchaseCharges	The current purchase charges.
customer	The customer associated with the account.
customerID	The customer ID.
customerPhoneNo	The customer's phone number.
dueDate	The due date.
email	The email address.
fromDate	The start date of the statement period.
ifsCode	The IFSC code.
lastPaymentReceived	The date of the last payment received.
micrCode	The MICR code.
minAmountDue	The minimum amount due.
openingBalance	The opening balance of the account.
pan	The PAN (Permanent Account Number).
pointsEarned	The points earned.
prevBalance	The previous balance.
relationshipWithBank	The customer's relationship with the bank.
toDate	The end date of the statement period.
totalAmountDue	The total amount due.
allTransactions	A list of all transactions.
transactionDistribution	The distribution of transactions categorized by type.
transactionDistribution.atmWithdrawls	A list of ATM withdrawal transactions.
transactionDistribution.averageMonthlyBalance	The average monthly balance for each day of the month.
transactionDistribution.averageQuarterlyBalance	The average quarterly balance.
transactionDistribution.expenses	A list of expense transactions.
transactionDistribution.highValueTransactions	A list of high-value transactions.
transactionDistribution.incomes	A list of income transactions.
transactionDistribution.internalTransactionList	A list of internal transactions.
transactionDistribution.investments	A list of investment transactions.
transactionDistribution.minimumBalances	A list of transactions related to minimum balances.
transactionDistribution.missingMonths	A list of missing months in statements.
transactionDistribution.moneyReceivedTransactions	A list of money received transactions.
transactionDistribution.atmWithdrawls.amount	The amount of the ATM withdrawal transaction.
transactionDistribution.atmWithdrawls.bank	The bank associated with the ATM withdrawal transaction.

Parameter	Description
transactionDistribution.atmWithdrawls.date	The date of the ATM withdrawal transaction.
transactionDistribution.atmWithdrawls.time	The time of the ATM withdrawal transaction.
transactionDistribution.atmWithdrawls.description	The description of the ATM withdrawal transaction.
transactionDistribution.averageMonthlyBalance.netAverageBalance	The net average balance for a specific month.
transactionDistribution.averageMonthlyBalance.monthAndYear	The month and year corresponding to the average monthly balance.
transactionDistribution.averageMonthlyBalance.dayBalanceMap	A map of day-wise balances for the month.
transactionDistribution.averageQuarterlyBalance.netAverageBalance	The net average balance for a specific quarter.
transactionDistribution.averageQuarterlyBalance.monthAndYear	The month and year corresponding to the average quarterly balance.
transactionDistribution.expenses.amount	The amount of the expense transaction.
transactionDistribution.expenses.bank	The bank associated with the expense transaction.
transactionDistribution.expenses.category	The category of the expense transaction.
transactionDistribution.expenses.date	The date of the expense transaction.
transactionDistribution.expenses.time	The time of the expense transaction.
transactionDistribution.expenses.description	The description of the expense transaction.
transactionDistribution.highValueTransactions.amount	The amount of the high-value transaction.
transactionDistribution.highValueTransactions.bank	The bank associated with the high-value transaction.
transactionDistribution.highValueTransactions.category	The category of the high-value transaction.
transactionDistribution.highValueTransactions.balanceAfterTransaction	The balance after the high-value transaction.
transactionDistribution.highValueTransactions.date	The date of the high-value transaction.
transactionDistribution.highValueTransactions.time	The time of the high-value transaction.
transactionDistribution.highValueTransactions.type	The type of the high-value transaction.
transactionDistribution.highValueTransactions.description	The description of the high-value transaction.
transactionDistribution.incomes.amount	The amount of the income transaction.
transactionDistribution.incomes.bank	The bank associated with the income transaction.
transactionDistribution.incomes.category	The category of the income transaction.
transactionDistribution.incomes.balanceAfterTransaction	The balance after the income transaction.
transactionDistribution.incomes.date	The date of the income transaction.
transactionDistribution.incomes.time	The time of the income transaction.
transactionDistribution.incomes.transactionType	The type of the income transaction.
transactionDistribution.incomes.isSalary	Indicates if the income transaction is a salary.
transactionDistribution.incomes.isSalaryCheck	Indicates if the income transaction is a salary check.
transactionDistribution.incomes.description	The description of the income transaction.
transactionDistribution.incomes.total	The total income amount.
transactionDistribution.internalTransactionList.amount	The amount of the internal transaction.
transactionDistribution.internalTransactionList.bank	The bank associated with the internal transaction.
transactionDistribution.internalTransactionList.category	The category of the internal transaction.
transactionDistribution.internalTransactionList.balanceAfterTransaction	The balance after the internal transaction.
transactionDistribution.internalTransactionList.date	The date of the internal transaction.
transactionDistribution.internalTransactionList.time	The time of the internal transaction.
transactionDistribution.internalTransactionList.transactionType	The type of the internal transaction.
transactionDistribution.internalTransactionList.description	The description of the internal transaction.
transactionDistribution.investments.amount	The amount of the investment transaction.
transactionDistribution.investments.bank	The bank associated with the investment transaction.
transactionDistribution.investments.category	The category of the investment transaction.
transactionDistribution.investments.balanceAfterTransaction	The balance after the investment transaction.
transactionDistribution.investments.date	The date of the investment transaction.
transactionDistribution.investments.time	The time of the investment transaction.
transactionDistribution.investments.type	The type of the investment transaction.
transactionDistribution.investments.description	The description of the investment transaction.
transactionDistribution.minimumBalances.amount	The amount of the minimum balance transaction.
transactionDistribution.minimumBalances.bank	The bank associated with the minimum balance transaction.
transactionDistribution.minimumBalances.category	The category of the minimum balance transaction.
transactionDistribution.minimumBalances.balanceAfterTransaction	The balance after the minimum balance transaction.
transactionDistribution.minimumBalances.date	The date of the minimum balance transaction.
transactionDistribution.minimumBalances.time	The time of the minimum balance transaction.
transactionDistribution.minimumBalances.transactionType	The type of the minimum balance transaction.
transactionDistribution.minimumBalances.description	The description of the minimum balance transaction.
transactionDistribution.missingMonths	A list of months that are missing in the statements.
transactionDistribution.moneyReceivedTransactions.amount	The amount of the money received transaction.
transactionDistribution.moneyReceivedTransactions.bank	The bank associated with the money received transaction.
transactionDistribution.moneyReceivedTransactions.category	The category of the money received transaction.
transactionDistribution.moneyReceivedTransactions.balanceAfterTransaction	The balance after the money received transaction.
transactionDistribution.moneyReceivedTransactions.date	The date of the money received transaction.
transactionDistribution.moneyReceivedTransactions.time	The time of the money received transaction.
transactionDistribution.moneyReceivedTransactions.transactionType	The type of the money received transaction.
transactionDistribution.moneyReceivedTransactions.description	The description of the money received transaction.
transactionDistribution.moneyReceivedTransactions.total	The total money received amount.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].