Statements

Get statement details

Retrieve details for a specific statement request by UUID. For completed statements, includes a pre-signed download URL.

get/statements/{statement_id}

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/statements/{statement_id}
  • Auth: API key in header x-api-key

Path parameters

statement_idstring uuid required

UUID of the statement request

Query parameters

client_idstring required

The identifier of a client.

Headers

Authorizationstring required

The access token.

X-Contact-IDstring

The identifier of a contact.

Response

Returns the statement request details

uuidstring required

Unique identifier for the statement request

statement_type'accounts' | 'trades' | 'mt940' | 'incoming_funds' required

Type of statement

file_format'pdf' | 'csv' | 'xls' | 'mt940' | 'coda' required

Format of the statement file

statusinteger required

Status code (0=Pending, 1=Running, 2=Completed, 3=Failed)

status_displaystring required

Human-readable status

start_datetimestring date-time required

Start date/time for the statement period

end_datetimestring date-time required

End date/time for the statement period

created_atstring date-time required

When the request was created

completed_atstring date-time nullable

When the statement was completed (null if not yet complete)

file_namestring nullable

Name of the generated file (null if not yet complete)

download_urlstring nullable

Pre-signed S3 URL for downloading the statement (null if not yet complete, expires after 15 minutes)

send_via'push' | 'email' | 'both' nullable

How the generated statement is delivered

error_messagestring nullable

Error message if the request failed

Example response

{
  "uuid": "86f62d50-baa2-38dd-f61c-0eacc34ead50",
  "statement_type": "accounts",
  "file_format": "pdf",
  "status": 2,
  "status_display": "Completed",
  "start_datetime": "2026-01-01T00:00:00",
  "end_datetime": "2026-03-31T23:59:59.999999",
  "created_at": "2026-04-07T21:18:49.061735",
  "completed_at": "2026-04-07T21:19:00.123456",
  "file_name": "statement_2026-01-01_2026-03-31.pdf",
  "download_url": "https://s3.amazonaws.com/bucket/file.pdf?X-Amz-Signature=abc123",
  "send_via": "push"
}

Changes

No recorded changes to this operation across all 1 revision of this API.