Passed

Statements (2025-01-01)

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

Authentication Header

  Authorization: {your_credentials}

Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.

You must use the Authorization header for any request you send to our Statements API, unless you are using client certificate authenticating with SSL/TLS.

WP-Api-Version Header

  WP-Api-Version: 2025-01-01

We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send to our Account APIs.

DNS Whitelisting

Whitelist the following URLs:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Worldpay

Languages
Servers
Try

https://try.access.worldpay.com/

Live

https://access.worldpay.com/

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 30 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 30 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 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^[a-zA-Z0-9 ._-]*$

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

Enum ValueDescription
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

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.

Headers
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
No request payload

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.

transactionReferencestring or null

Your unique reference for the transaction.

transferTypestring or null

The transfer type.

amountnumber(double)

The amount.

timestampstring(date-time)

The posting date of the specific statement item.

fundingTypestring or null

A credit or debit operation. Value can be credit or debit.

ratenumber or null(double)

The rate applied for FX conversion.

clearedstring or null

Cleared balance or uncleared balance. Value can be yes or no.

descriptionstring or null

The description of this statement item.

statementItemIdstring(uuid)

The statement identifier.

balancenumber(double)

The balance that resulted from this statement item's transaction.

statementNumberinteger(int64)

The statement number.

narrativeobject
countryCodestring or null

The country code.

originalCurrencystring or null

For statement items (debits/credits) with no FX conversion involved, originalCurrency value will be null.

In case an FX conversion is involved, then:

  • For debit items, originalCurrency shows the target currency.
  • For credit items, originalCurrency shows the source currency.
originalAmountnumber or null(double)

For statement items (debits/credits) with no FX conversion involved, originalAmount value will be null.

In case an FX conversion is involved, then:

  • For debit items, originalAmount shows the target amount.
  • For credit items, originalAmount shows the source amount.
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
application/json
{
  "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
}