Access Worldpay
/
Get statement

Last Updated: 27 July 2023 | Change Log

Statement 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 to ensure a resilient integration.

Get Started

Get started using our API Reference and set your headers.

HeaderDescription
AuthorizationWe use the Authorization header to identify and authenticate you within Access Worldpay. You must use the Authorization header for any request you send to our Account APIs, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide on Authenticating with SSL/TLS.
AcceptWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Account APIs.
Note

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

Date range query

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

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.com/accounts/statements/?accountNumber={accountNumber}&startDate={startDate}&endDate={endDate}

Example:

GET https://try.access.worldpay.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.

Response

Response schema

accountNumberstring or null

The account number.

currencystring or null

The currency, determined by the first item in the list. The currency is the same for all items.

accountStatementItemsArray of objects or null(ExternalAccountStatementItems)

A collection of account statement items.

pageNumberinteger(int32)

The page number. Default is 1 if no value is provided. This value specifies the exact page of each list of statements that you want to retrieve.

pageSizeinteger(int32)

The exact number of records per page to be shown. Max 500 items/rows. Value must be between 1-500. Default is 1 if no value is provided.

pageCountinteger(int32)

The total number of pages.

totalNumberOfRecordsinteger(int32)

The total number of records.

Response examples

{
    "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
}