The end user wants to get the list of images for an account. They could be check images or deposit slip or statement images.The user in this case is the customer of financial institution (FI).
Gets the check or deposit slip or statement image for the given account Gets various types of images for the given account GET /db-banking-images/v1/banking-images
Request:
Query Parameters:
- accountId: dentifier of the account for which the image(s) need to be fetched. This is a mandatory request parameter.
- imageType: The type of images to fetch. The possible values are CHECK, DEPOSIT_SLIP, STATEMENT, DEPOSIT_CHECK.
- transactionDate: Date of the transaction. This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
- transactionImageNumber: Reference number on the check (eg. check number) or the deposit slip (eg. deposit slip number). This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
- statementStartDate: Start date of the statements. This is a required parameter when the imageType is STATEMENT.
- statementEndDate: End date of the statements. This is a required parameter when the imageType is STATEMENT.
- statementPreview: True/False. Parameter to support one online statement vendor. The vendor’s host request requires a PREVIEW parameter. This allows an administrator to view a preview of the Statement List. From AP, an administrator can view a preview of the Statement List. Only the request originating from AP will send the preview=true parameter.
- institutionCustomerId: LocationId for the business banking user for which online statements are being retrieved. This is a required parameter for BB User.
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: The UUID string used as a unique identifier for this token request
- callingAppId: An ID of the application that made this request
- Content-type: The content type of the request; only application/JSON and application/XML are supported
Get the specified image for the given account Get the specific image GET /db-banking-images/v1/banking-images/{bankingImageId}
Request:
Path Parameter:
- bankingImageId: The ID of the statement/depositCheck image to be retrieved
Query Parameters:
- accountId: Identifier of the account for which the image(s) need to be fetched. This is a mandatory request parameter.
- imageType: The type of the images to fetch. The possible values are CHECK, DEPOSIT_SLIP, STATEMENT, DEPOSIT_CHECK.
- statementDate: Date for a single statement. statementDate is not used for filtering multiple statements.
- transactionDate: Date of the transaction. This is a required parameter when the imageType is CHECK or DEPOSIT_SLIP.
- institutionCustomerId: LocationId for the business banking user for which online statements are being retrieved. This is a required parameter for BB User.
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request
- Content-type: The content type of the request. Only application/JSON and application/XML are supported.
Example Code
Here's an excerpt from the accounts service: Gets the check or deposit slip or statement image for the given account
Check image sample response:
{
"bankingImage": [
{
"transactionImageNumber": "4321",
"institutionCustomerId": "adf75264892f4337a17fa807b1d4bfc6",
"institutionId": "02487",
"accountId": "kFTtOZg7Diyokp0BBWIWQS9WikdiWwY\_wXx2IHVSnbI",
"imageType": "CHECK",
"imageInfoItems": {
"imageInfo": [
{
"data": "SW1hZ2UgcmVxdWVzdG9yIHJldHVybnMgYW4gaW1hZ2Ugbm90IFhNTA==",
"view": "FRONT"
},
{
"data": "SW1hZ2UgcmVxdWVzdG9yIHJldHVybnMgYW4gaW1hZ2Ugbm90IFhNTA==",
"view": "BACK"
}
]
}
}
]
}Deposit slip image sample response:
{
"bankingImage": [
{
"transactionImageNumber": "3004",
"transactionDate": "2016-01-07",
"amount": {
"currencyCode": "USD",
"amount": 300.0
},
"institutionCustomerId": "8a8dc264f1dc4ed3ab15113a1e7b81bb",
"institutionId": "03487",
"accountId": "uLnrf9L7XATfjWxo746hnFXPHG2NPY8Thdl44Y3WL4M",
"imageType": "DEPOSIT\_SLIP",
"imageInfoItems": {
"imageInfo": [
{
"data": "BASE64Fr",
"type": "JPEG"
"view": "FRONT"
},
{
"data": "BASE64Back",
"type": "JPEG",
"view": "BACK"
}
]
}
}
]
}Deposit check image sample response:
{
"bankingImage": [
{
"transactionDate": "2019-08-30",
"amount": {
"currencyCode": "USD",
"amount": 1171.96
},
"id": "441",
"institutionCustomerId": "d3cb7fe39f9c4bf381d7494d15928029",
"institutionId": "04787",
"accountNumber": "2300000001",
"accountType": "CHECKING",
"imageType": "DEPOSIT\_SLIP",
"imageInfoItems": {}
},
{
"transactionImageNumber": "11917",
"transactionDate": "2019-08-30",
"amount": {
"currencyCode": "USD",
"amount": 398.63
},
"id": "442",
"institutionCustomerId": "d3cb7fe39f9c4bf381d7494d15928029",
"institutionId": "04787",
"accountNumber": "4451081836",
"accountType": "CHECKING",
"imageType": "CHECK",
"imageInfoItems": {}
},
{
"transactionImageNumber": "11918",
"transactionDate": "2019-08-30",
"amount": {
"currencyCode": "USD",
"amount": 748.33
},
"id": "443",
"institutionCustomerId": "d3cb7fe39f9c4bf381d7494d15928029",
"institutionId": "04787",
"accountNumber": "2020014",
"accountType": "CHECKING",
"imageType": "CHECK",
"imageInfoItems": {}
},
{
"transactionImageNumber": "6174406",
"transactionDate": "2019-08-30",
"amount": {
"currencyCode": "USD",
"amount": 25.00
},
"id": "444",
"institutionCustomerId": "d3cb7fe39f9c4bf381d7494d15928029",
"institutionId": "04787",
"accountNumber": "1005834",
"accountType": "CHECKING",
"imageType": "CHECK",
"imageInfoItems": {}
}
]
}Get the specified image for the given account
Single deposit check image sample response:
{
"transactionImageNumber": "11917",
"transactionDate": "2019-08-30",
"amount": {
"currencyCode": "USD",
"amount": 398.63
},
"id": "442",
"institutionCustomerId": "d3cb7fe39f9c4bf381d7494d15928029",
"institutionId": "04787",
"accountNumber": "4451081836",
"accountType": "CHECKING",
"imageType": "UNKNOWN",
"imageInfoItems": {
"imageInfo": [
{
"data": "YmFzZTY0aW1hZ2U=",
"type": "PNG",
"view": "FRONT"
},
{
"data": "YmFzZTY0aW1hZ2V=",
"type": "PNG",
"view": "BACK"
}
]
}
}`Single statement image sample response:
{
"statementDescription": "STM",
"statementDate": "2014-03-31",
"id": "40828",
"institutionCustomerId": "a0ff6414c24142a286658fbd728d3b90",
"institutionId": "01687",
"accountId": "1eqEeJLLoMlFBRxYMPI-RnQqbH8OseQIqVAU-bkNO4k",
"imageType": "STATEMENT",
"imageInfoItems": {
"imageInfo": [
{
"data": "YmFzZTY0aW1hZ2U=",
"type": "PDF"
}
]
}
}
