Account Statment API

Account Statment API (1)

Authentication

Set your headers:

  Authorization: {your_credentials}
  Accept: application/vnd.worldpay.accounts.statements-v1+json

Replace {your_credentials} with your base64-encoded Basic Auth username and password.

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

Servers

testing (try)

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

live

https://access.worldpay.com/

Query account statement items

Request

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

Query

accountNumberstring= 16 charactersrequired

The account number.

Example:

accountNumber=000555312371213

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

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^[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

Headers

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

WP-CallerIdstring

ID of the consumer. This value is optional and provided by you. It should be unique per each consumer. If not provided, it is generated, since it is required for traceability.

Example:

merchantname123

No request payload

Experience it firsthand in the API Explorer!

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.

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.

narrativestring or null

The reference to the specific transaction.

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/vnd.worldpay.accounts.statements-v1+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": "string",
      "countryCode": "string",
      "originalCurrency": "string",
      "originalAmount": 0.1
    }
  ],
  "pageNumber": 0,
  "pageSize": 0,
  "pageCount": 0,
  "totalNumberOfRecords": 0
}

Account Statment API (1)

Query account statement items

Request

Responses

Do you like our page?