**Last updated**: 14 May 2025 | [**Change log**](/products/statements/changelog/)

# Statements API

Retrieve your account statement and see individual entries for all credits and debits.
Specify a date range and other optional filter values.

Important
Make yourself familiar with our [API Principles](/products/reference/api-principles) to ensure a resilient integration.

## Get started

Ready to integrate? Use our [API reference](/products/statements/openapi) and set your headers.

Note
Replace `{your_credentials}` with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.

Account Payout customers
## Date range query (Account Payout customers)

Query account statement within date range for a max 30 day period.

You must provide an `accountNumber` to pull information specific to an account.

You must also provide a `startDate` and `endDate` to query an account within a date range.
Both dates must be a date in the past and the difference between the dates shouldn't exceed 30 days.


`GET` `https://try.access.worldpay-bsh.securedataplatform.com/accounts/statements/?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}`

### Example

`GET` `https://try.access.worldpay-bsh.securedataplatform.com/accounts/statements/?accountNumber=000555312371213&startDate=2022-05-01T15:16:30.109Z&endDate=2022-05-01T15:16:30.109Z`

## Response

The response contains the account number, currency and a collection of statement items.

### Examples

Successful response example
{
    "accountNumber": "0001010101010001",
    "currency": "EUR",
    "accountStatementItems": [
        {
            "transactionReference": "123456",
            "transferType": "PAYOUT REVERSAL",
            "amount": 2.34,
            "timestamp": "2023-06-21T16:48:59.683Z",
            "fundingType": "credit",
            "cleared": "yes",
            "description": " Return of original statement entry #1. REVERSAL: Other-TEST",
            "statementItemId": "3824f47e-5310-ee11-811a-0050568e2b86",
            "balance": 7.66,
            "statementNumber": 4,
            "narrative": "Ref: 123456",
            "countryCode": "GB"
        },
        {
            "transactionReference": "123456",
            "transferType": "PAYOUT",
            "amount": 2.34,
            "timestamp": "2023-06-21T16:16:09.670Z",
            "fundingType": "debit",
            "rate": 4.27396,
            "cleared": "yes",
            "description": "Harry Potter",
            "statementItemId": "ab8614ee-4e10-ee11-811a-0050568e2b86",
            "balance": 5.32,
            "statementNumber": 3,
            "narrative": "Ref: 123456",
            "countryCode": "US",
            "originalCurrency": "USD",
            "originalAmount": 10
        },
        {
            "transferType": "LIQUIDITY FUNDING",
            "amount": 10,
            "timestamp": "2023-06-21T13:10:58.553Z",
            "fundingType": "credit",
            "cleared": "yes",
            "description": "ALTEULIQFUND2106",
            "statementItemId": "06a63f0a-3510-ee11-811a-0050568e2b86",
            "balance": 7.66,
            "statementNumber": 2,
            "narrative": ""
        },
        {
            "transactionReference": "123456",
            "transferType": "PAYOUT",
            "amount": 2.34,
            "timestamp": "2023-06-21T12:32:17.490Z",
            "fundingType": "debit",
            "rate": 4.27396,
            "cleared": "yes",
            "description": "John Doe",
            "statementItemId": "d9904ba4-2f10-ee11-811a-0050568e2b86",
            "balance": -2.34,
            "statementNumber": 1,
            "narrative": "Ref: 123456",
            "countryCode": "GB",
            "originalCurrency": "PLN",
            "originalAmount": 10
        }
    ],
    "pageNumber": 3,
    "pageSize": 4,
    "pageCount": 3,
    "totalNumberOfRecords": 12
}
Error response example
{
    "errorName": "urlContainsInvalidValue",
    "message": "accountNumber or the combination of partyRef, entity and currency is mandatory.",
    "validationErrors": [
        {
            "errorName": "fieldIsMissing",
            "message": "accountNumber is mandatory",
            "queryParameter": "accountNumber"
        },
        {
            "errorName": "fieldIsMissing",
            "message": "partyRef is mandatory",
            "queryParameter": "partyRef"
        },
        {
            "errorName": "fieldIsMissing",
            "message": "entity is mandatory",
            "queryParameter": "entity"
        },
        {
            "errorName": "fieldIsMissing",
            "message": "currency is mandatory",
            "queryParameter": "currency"
        }
    ]
}
See our [API reference](/products/statements/openapi) for all response parameters.

Marketplaces
## Date range query (Marketplaces)

Query account statement within date range for a max 30 day period.

You must provide a `partyReference`, `currency` and `entity` to pull information specific to a party.

You must also provide a `startDate` and `endDate` to query an account within a date range.
Both dates must be in a date in the past and the difference between the dates shouldn't exceed 30 days.


`GET` `https://try.access.worldpay-bsh.securedataplatform.com/accounts/statements/?partyReference={partyRef}&currency={currency}&entity={entity}&startDate={startDate}&endDate={endDate}`

### Example

`GET` `https://try.access.worldpay-bsh.securedataplatform.com/accounts/statements/?partyReference=Driver&currency=EUR&entity=WorldpayAPLtd&startDate=2022-05-01T15:16:30.109Z&endDate=2022-05-01T15:16:30.109Z`

## Response

The response contains the account number, currency and a collection of statement items.

### Examples

Successful response example
{
    "accountNumber": "0001010101010001",
    "currency": "EUR",
    "accountStatementItems": [
        {
            "transactionReference": "123456",
            "transferType": "PAYOUT REVERSAL",
            "amount": 2.34,
            "timestamp": "2023-06-21T16:48:59.683Z",
            "fundingType": "credit",
            "cleared": "yes",
            "description": " Return of original statement entry #1. REVERSAL: Other-TEST",
            "statementItemId": "3824f47e-5310-ee11-811a-0050568e2b86",
            "balance": 7.66,
            "statementNumber": 4,
            "narrative": "Ref: 123456",
            "countryCode": "GB"
        },
        {
            "transactionReference": "123456",
            "transferType": "PAYOUT",
            "amount": 2.34,
            "timestamp": "2023-06-21T16:16:09.670Z",
            "fundingType": "debit",
            "rate": 4.27396,
            "cleared": "yes",
            "description": "Harry Potter",
            "statementItemId": "ab8614ee-4e10-ee11-811a-0050568e2b86",
            "balance": 5.32,
            "statementNumber": 3,
            "narrative": "Ref: 123456",
            "countryCode": "US",
            "originalCurrency": "USD",
            "originalAmount": 10
        },
        {
            "transferType": "LIQUIDITY FUNDING",
            "amount": 10,
            "timestamp": "2023-06-21T13:10:58.553Z",
            "fundingType": "credit",
            "cleared": "yes",
            "description": "ALTEULIQFUND2106",
            "statementItemId": "06a63f0a-3510-ee11-811a-0050568e2b86",
            "balance": 7.66,
            "statementNumber": 2,
            "narrative": ""
        },
        {
            "transactionReference": "123456",
            "transferType": "PAYOUT",
            "amount": 2.34,
            "timestamp": "2023-06-21T12:32:17.490Z",
            "fundingType": "debit",
            "rate": 4.27396,
            "cleared": "yes",
            "description": "John Doe",
            "statementItemId": "d9904ba4-2f10-ee11-811a-0050568e2b86",
            "balance": -2.34,
            "statementNumber": 1,
            "narrative": "Ref: 123456",
            "countryCode": "GB",
            "originalCurrency": "PLN",
            "originalAmount": 10
        }
    ],
    "pageNumber": 3,
    "pageSize": 4,
    "pageCount": 3,
    "totalNumberOfRecords": 12
}
Error response example
{
    "errorName": "urlContainsInvalidValue",
    "message": "accountNumber or the combination of partyRef, entity and currency is mandatory.",
    "validationErrors": [
        {
            "errorName": "fieldIsMissing",
            "message": "accountNumber is mandatory",
            "queryParameter": "accountNumber"
        },
        {
            "errorName": "fieldIsMissing",
            "message": "partyRef is mandatory",
            "queryParameter": "partyRef"
        },
        {
            "errorName": "fieldIsMissing",
            "message": "entity is mandatory",
            "queryParameter": "entity"
        },
        {
            "errorName": "fieldIsMissing",
            "message": "currency is mandatory",
            "queryParameter": "currency"
        }
    ]
}
See our [API reference](/products/statements/openapi) for all response parameters.