Query account statement items

APIs/Statements/

Query account statement items

Request

Retrieve statement entries for an account number using the filter criteria.

Security

basicAuth

Query

accountNumberstring, = 16 charactersrequired

The account number.

Example:accountNumber=0005553123712133

startDatestring, (date-time)required

An ISO 8601 date-time string. From date and time. Timespan between 'startDate' and 'endDate' shouldn't exceed 31 days. This should not be a date in the future.

Example:startDate=2022-05-01T15:16:30Z

endDatestring, (date-time)required

An ISO 8601 date-time string. To date and time. Timespan between 'startDate' and 'endDate' shouldn't exceed 31 days. This should not be a date in the future.

Example:endDate=2022-05-05T15:16:30Z

pageNumberinteger, (int32), >= 1

The page number of the results. 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), [ 1 .. 500 ]

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.

fundingTypestring

Credit or debit operation. Value can be credit or debit. If no value is passed, the statement includes both credits and debits.

Enum:"credit""debit"

transferTypestring, <= 20 characters^[a-zA-Z0-9 ._-]*$

Type of the transaction used to filter out statement entries. Alphanumeric only. Special characters are restricted.

countryCodestring, = 2 characters^[a-zA-Z0-9]*$

ISO country code of the transaction.

amountnumber, (decimal)

The transaction amount.

transactionReferencestring, <= 50 characters

Your unique reference for the payment request. This can be a "like" search (exact or partial match). Special characters are allowed. For the list, please see our formatting guide

Acceptstringrequired

Example:application/vnd.worldpay.accounts.statements-v1+json

WP-CorrelationIdstring

Optional ID to trace requests, if not provided, it is generated.

Example:15cd16b2-7b82-41cb-9b11-21be9dacad88

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/accounts/statements?accountNumber=0005553123712133&startDate=2022-05-01T15%3A16%3A30Z&endDate=2022-05-05T15%3A16%3A30Z&pageNumber=1&pageSize=1&fundingType=credit&transferType=string&countryCode=st&amount=0&transactionReference=string' \
  -H 'Accept: application/vnd.worldpay.accounts.statements-v1+json' \
  -H 'WP-CorrelationId: 15cd16b2-7b82-41cb-9b11-21be9dacad88'

Responses

OK response if the request is valid

Bodyapplication/vnd.worldpay.accounts.statements-v1+json

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

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

{
  "accountNumber": "string",
  "currency": "string",
  "accountStatementItems": [
    {
      "transactionReference": "string",
      "transferType": "string",
      "amount": 0.1,
      "timestamp": "2019-08-24T14:15:22Z",
      "fundingType": "string",
      "rate": 0.1,
      "cleared": "string",
      "description": "string",
      "statementItemId": "d6c0f922-d6e3-428e-9fb6-217f68c41961",
      "balance": 0.1,
      "statementNumber": 0,
      "narrative": "string",
      "countryCode": "string",
      "originalCurrency": "string",
      "originalAmount": 0.1
    }
  ],
  "pageNumber": 0,
  "pageSize": 0,
  "pageCount": 0,
  "totalNumberOfRecords": 0
}