Query account statement items

Request

Security

BasicAuth

Query

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

accountNumberstring, = 16 characters

The account number. You must use this if you are an Account Payout customer. You can use this for a Marketplaces flow.

accountNumber or partyReference must be provided.

Example:accountNumber=0005553123712133

partyReferencestring, [ 3 .. 63 ] characters

Your reference for this party, must be unique within an entity. Typically used for a Marketplaces flow and used to retrieve information about your onboarded party. Allowed values: a-z, A-Z, 0-9, spaces and hyphens.

accountNumber or partyReference must be provided.

If partyReference is provided you must also include entity and currency.

Example:partyReference=Hosaka2738491

entitystring, [ 1 .. 36 ] characters

Used to route the request in Access Worldpay, created as part of on-boarding.

Example:entity=default

currencystring, = 3 characters

The currency in ISO 4217 currency format for the account associated with the party.

Example:currency=GBP

pageNumberinteger, (int32), non-empty

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 ] characters

Exact number of records per page to be shown. Max 500 items/rows. Value must be between 1-500. Default is 500 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^[a-zA-Z0-9 ._-]*$

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

Enum Value	Description
ACQUIRING SETTLEMENT
BANKIN	Non-US customers only
BANKIN_REFUND	Non-US customers only
BANKOUT	Non-US customers only
BENEFICIARY PAYOUT	Used in Marketplaces
BENEFICIARY_FUNDING	Used in Marketplaces
CHARGEBACK	Used in Marketplaces
COMMISSION	Used in Marketplaces
CORRECTION
CREDIT	Used in Marketplaces
DEBIT	Used in Marketplaces
DEDUCTION
EFTIN
EFTIN_REFUND
FFX PAYOUT
FFX PAYOUT RETURNED
FFX PAYOUT REVERSAL
FX DEAL
INTERNAL LIQUIDITY
LIQUIDITY
PAYIN	US-merchants only
PAYIN_REFUND	US-merchants only
PAYIN REVERSAL
PAYOUT	US-merchants only
PAYOUT RETURNED
PAYOUT REVERSAL
REFUND
SPLIT PAYMENT
SPLIT PAYOUT
STREAMLINE TRANSFER

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

The country code specified in ISO 3166-1 Alpha-2 code format of the transaction.

amountnumber, (double)

The transaction amount.

transactionReferencestring, [ 1 .. 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.

WP-Api-Versionstringrequired

Represents the version of the API.

Example:2025-01-01

WP-CorrelationIdstring

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

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

WP-CallerIdstring

An ID used for logging purposes.

Acceptstring

Accept header is optional and must be application/json if provided.

Example:application/json

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/accounts/statements?startDate=2022-05-01T15%3A16%3A30Z&endDate=2022-05-05T15%3A16%3A30Z&accountNumber=0005553123712133&partyReference=Hosaka2738491&entity=default&currency=GBP&pageNumber=0&pageSize=0&fundingType=credit&transferType=ACQUIRING%20SETTLEMENT&countryCode=st&amount=0.1&transactionReference=string' \
  -H 'Accept: application/json' \
  -H 'WP-Api-Version: 2025-01-01' \
  -H 'WP-CallerId: string' \
  -H 'WP-CorrelationId: 15cd16b2-7b82-41cb-9b11-21be9dacad88'

Responses

OK response if the request is valid

Bodyapplication/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 500 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": {
        "line1": "string"
      },
      "countryCode": "string",
      "originalCurrency": "string",
      "originalAmount": 0.1
    }
  ],
  "pageNumber": 0,
  "pageSize": 0,
  "pageCount": 0,
  "totalNumberOfRecords": 0
}