Download Monthly Statements
The following steps allow customers to query the monthly statements and download the pdf statements.
Step by step guide
Step 1 - Query the monthly statements generated by TxB
You should use the API POST /v2/documents/query
which will return a list of statements generated.
Representative payload to query monthly statements in PDF format:
{
"entityId": "2481F41D17064198BDAA16A7CBC91D70",
"documentData": {
"reportFormat": "PDF",
"reportCategory": "MONTHLY_STATEMENT",
"startDateTime": "2024-06-01T00:00:00Z"
}
}
Representative response with list of generated statements:
{
"documentData": [
{
"reportName": "CLIENT_IBDA_STATEMENT JUNE-2024",
"reportFormat": "PDF",
"reportId": "364a6291-e798-4368-af91-160cew8f21cf",
"reportCategory": "MONTHLY_STATEMENT",
"entityId": "2481F41D17064198BDAA16A7CBC91D70",
"linkUrl": "https://api.test.txb.gs.com/v2/documents/eyJ...fdeg/file",
"reportScopeStartTime": "2024-05-05T00:00:00Z",
"reportScopeEndTime": "2024-06-04T00:00:00Z"
},
{
"reportName": "CLIENT_IBDA_STATEMENT JUNE-2024",
"reportFormat": "PDF",
"reportId": "be183b2e-55ef-4a6b-9b39-4c386e16b1t5",
"reportCategory": "MONTHLY_STATEMENT",
"entityId": "2481F41D17064198BDAA16A7CBC91D70",
"linkUrl": "https://api.test.txb.gs.com/v2/documents/eyJ...gdLg/file",
"reportScopeStartTime": "2024-05-02T00:00:00Z",
"reportScopeEndTime": "2024-06-01T00:00:00Z"
}
]
}
Step 2 - Download a monthly statement
The response data from the previous step, contains an array of report objects with a linkUrl
included for each, representing the monthly statements generated. To download a particular pdf statement, you have to invoke the corresponding linkUrl
.
Note: The link is only valid for 5 days, after which date you will need to repeat step 1.
Was this page useful?
Give feedback to help us improve developer.gs.com and serve you better.