Get bank statement results

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You can use this endpoint to retrieve the status, and once completed, the bank statement results for any upload.

The bank statement results will be fully available for a document once the documentStatus is completed.

Bank Statement Status details

The complete list of possible options for documentStatus is:

Document Status ValueDescription
InProgressThe file is being processed.
CompletedThe file has been successfully processed by Butler and the bank statement results are ready.
FailedThe file was not processed successfully. If this continues to occur, reach out to the Butler customer success team.
📘

Polling and Timeouts

In a production integration, while waiting for bank statement results to complete, you'll want to poll on this endpoint until the job completes.

You can poll as frequently as you like (we recommend every 5 seconds). If you need to have a polling timeout, we recommend using a timeout of 2 hours

Path Params
string
required

The id of the Queue that processed the bank statements you would like to get results for.

Query Params
string
required

The id of the specific upload that you would like to get bank statement results for.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json