The statements endpoint allows you to retrieve a statement for a single currency account held with Alpha.

Statements are formatted records that summarise the financial activities and position of a currency account. They can be prepared for custom periods and provide a summary of currency account, balance and transaction data.

See the Statements API reference section for technical implementation.

Return a full statement

As statements are only returned per currency account, there has to be an AccountID included in the query. However, if no further parameters are defined, the statement will include all the data we have on the currency account.

See the policy page on how far back in time you can retrieve transactions.

Return filtered statements

Including query parameters in your request will constrain your search, but will be useful if you are looking to return a statement based on a certain time range, e.g. specifying From and To for a financial period.

You may use any number of query parameters. Please note that using multiple parameters will make them all applicable. Querying parameters acts as an AND function, not OR.

📚 Any terms that you don’t understand below? Check out the glossary

Request parameters

Name	Type	Use case
`AccountId` required	string	Specify the ID of the currency account which you want to return the statement for
`From`	date-time	Choose a date that the statement will start from in UTC ISO 8601 date in YYYY-MM-DD format
`To`	date-time	Choose a date that the statement will end on in UTC ISO 8601 date in YYYY-MM-DD format
`PageNumber`	integer	Specifies the page to be returned, useful when there are multiple pages of results, see the pagination section for more information

Response

Name	Type	Description
`AccountId`	string	The ID for the currency account associated with the statement
`StatementFromDate`	string	The date that the statement starts from in YYYY-MM-DD format
`StatementToDate`	string	The date that the statement ends in YYYY-MM-DD format
`CreatedAt`	date-time	Date the statement was generated
`Reference`	string	Statement from {From} to {To}
`Currency`	string	Currency of the currency account being used to retrieve the statement
`OpeningBalance`	string	The balance at the time of the start of the statement
`ClosingBalance`	string	The balance at the time of the end date of the statement
`Transactions`	array	An array of transactions for the statement period. See the transactions response for a detailed description of the response

Integration Examples

Retrieve a statement for a given time range

Produce a statement for a currency account for a specified time period. Call the statements endpoint, passing the desired dates in the From and To parameters.

curl -X 'GET' \
  'https://sandbox.api.alphagroup.com/api/v1/statements?AccountId=a8c9b73c-e127-452b-9d69-d5160258a62b&From=2024-03-04&To=2024-03-08' \
  -H 'accept: text/plain' \
  -H 'authorization: Bearer **BearerTokenGoesHere**'

The following response shows a statement for the specified currency account over a defined time period.

{
  "Statement": {
    "AccountId": "a8c9b73c-e127-452b-9d69-d5160258a62b",
    "StatementFromDate": "2024-03-05",
    "StatementToDate": "2024-03-08",
    "CreatedAt": "2024-03-08T05:04:28+00:00",
    "Reference": "Statement from 2024-03-05 to 2024-03-08",
    "Currency": "USD",
    "OpeningBalance": "0",
    "ClosingBalance": "0.5"
  },
  "Transactions": [
    {
      "Id": "72fd2406-b856-41c1-9fcc-509a45ae18ac",
      "AccountId": "a8c9b73c-e127-452b-9d69-d5160258a62b",
      "Status": "Booked",
      "CreatedDateTime": "2024-03-05T09:18:44",
      "ValueDate": "2024-03-05",
      "CreditOrDebit": "Debit",
      "Type": "Payment",
      "Amount": 100.18,
      "Balance": 0.5,
      "CreditorAccount": {
        "Name": "Sandbox Company",
        "AddressLine": "123 Road,Town",
        "Iban": ""
      },
      "DebtorAccount": {
        "Id": "a8c9b73c-e127-452b-9d69-d5160258a62b",
        "Name": "USD Account",
        "Iban": "",
        "AccountNumber": "87836066",
        "Swift": "TESTUS22",
        "AccountReference": "A0020154",
        "NationalBankCode": "200000"
      },
      "Reference": "Transfer to A0020154",
      "TradeReference": "Transfer to A0020154",
      "SupplementaryDetails": ""
    },
    {
      "Id": "79e70547-f49f-4563-bf1e-ddfaf4900966",
      "AccountId": "a8c9b73c-e127-452b-9d69-d5160258a62b",
      "Status": "Booked",
      "CreatedDateTime": "2024-03-05T09:18:33",
      "ValueDate": "2024-03-05",
      "CreditOrDebit": "Credit",
      "Type": "Receipt",
      "Amount": 100.28,
      "Balance": 100.68,
      "CreditorAccount": {
        "Id": "a8c9b73c-e127-452b-9d69-d5160258a62b",
        "Name": "USD Account",
        "Iban": "",
        "AccountNumber": "87836066",
        "Swift": "FAKEUS22",
        "AccountReference": "A0020154",
        "NationalBankCode": "200000"
      },
      "DebtorAccount": {
        "Name": "Sandbox Company",
        "AddressLine": "765 Street,City",
        "Iban": ""
      },
      "Reference": "Transfer from Sandbox Company",
      "TradeReference": "Transfer from Sandbox Company",
      "SupplementaryDetails": ""
    }
  ],
  "IsLastPage": true
}