Bank Statement Extraction

5 min

Introduction

The bankStatements endpoint allows patrons to retrieve bank statements from their linked bank accounts. API enables patrons to access their bank statements through a secure and efficient platform. This API request requires authentication via an access token, as well as the submission of relevant account details such as the bank URL, bank name, and account type.

Sample CURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-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..."}}'

Parameter	Type	Required	Description
url	string	Yes	The URL where the bank statements can be accessed.
bankName	string	Yes	The name of the bank that the patron has an account with.
accountType	string	Yes	The type of account that the patron has (e.g. savings, checking, etc.).
patron-id	string	Yes	The unique identifier for the patron whose bank statements are being requested.
access-token	string	Yes	A token that provides authorization to access the requested resource.

Valid Account Type List

Serial Number	Account Type
1	SAVING
2	CURRENT
3	CREDIT_CARD

Sample API 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.."
    			}]

    		}
    	}

    }

Parameter Name	Description
bankName	The name of the bank associated with the account
accountType	The type of the account, e.g. savings, checking, credit
accountHolder	The name of the account holder
address	The address of the account holder
accountLimit	The account limit amount
accountNo	The account number
availableCashLimit	The available cash limit amount
availableCreditLimit	The available credit limit amount
bankAddress	The address of the bank
bankCredentialCO	The credential CO of the bank
bankTransactionList	The list of transactions associated with the bank
branchAddress	The address of the branch
cifNumber	The CIF (Customer Information File) number
client	The client associated with the account
creditCardNo	The credit card number
creditLimit	The credit limit amount
crnNo	The CRN (Customer Relationship Number) number
currentCashAdvance	The current cash advance amount
currentPurchaseCharges	The current purchase charges amount
customer	The customer associated with the account
customerID	The customer ID
customerPhoneNo	The customer phone number
dueDate	The due date for payments
email	The email address of the account holder
fromDate	The starting date for transactions
ifsCode	The Indian Financial System Code (IFSC)
lastPaymentReceived	The date of the last payment received
micrCode	The Magnetic Ink Character Recognition (MICR) code
minAmountDue	The minimum amount due
openingBalance	The opening balance of the account
pan	The Permanent Account Number (PAN)
pointsEarned	The points earned with the account
prevBalance	The previous balance amount
relationshipWithBank	The relationship of the account holder with the bank
toDate	The ending date for transactions
totalAmountDue	The total amount due
allTransactions	The list of all transactions with their details
transactionDistribution.atmWithdrawls	The list of ATM withdrawals
transactionDistribution.averageMonthlyBalance	The average monthly balance with day wise details
transactionDistribution.averageQuarterlyBalance	The average quarterly balance with month and year
transactionDistribution.expenses	The list of expenses with their details
transactionDistribution.highValueTransactions	The list of high-value transactions with their details
transactionDistribution.incomes	The list of incomes with their details
transactionDistribution.internalTransactionList	The list of internal transactions with their details
transactionDistribution.investments	The list of investments with their details
userID	Unique identifier for the user
startDate	Start date of the data range
endDate	End date of the data range
incomeTransactions	List of income transactions with details such as amount, bank, category, balance after transaction, date, time, transaction type, and description
expenseTransactions	List of expense transactions with details such as amount, bank, category, balance after transaction, date, time, transaction type, and description
minimumBalances	List of minimum balance information for each bank account including amount, bank, category, balance after transaction, date, time, transaction type, and description
missingMonths	List of months in which no transaction data is available
moneyReceivedTransactions	List of transactions where money was received, including details such as amount, bank, category, balance after transaction, date, time, transaction type, description, and total received amount Note: The actual parameter values have been replaced with placeholder text "..parameter.." in the code snippet provided. Regenerate response