Get details for all your accounts

Request

Retrieve account details for all your accounts.

Security

BasicAuth

Query

entitystring, [ 1 .. 32 ] characters^[a-zA-Z\s-]{1,32}$required

Unique ID given during the on-boarding process.

currencystring

The ISO 4217 currency codes of the account.

partyReferencestring

Your reference for this party, must be unique within an entity. Allowed values string 3 to 64 characters a-z, A-Z, 0-9, spaces and hyphens.

statusstring

Get accounts on the bases of account status.

Example:status=Active/Inactive

pageNumberinteger, (int32), [ 1 .. 2147483647 ]

Positive whole number indicating which page of the account to return.

pageSizeinteger, (int32)

Positive whole number indicating the number of account to return in each page.

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

Acceptstring

Example:application/json

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/accounts?entity=string&currency=string&partyReference=string&status=Active%2FInactive&pageNumber=1&pageSize=0' \
  -H 'Accept: application/json' \
  -H 'WP-Api-Version: 2025-01-01' \
  -H 'WP-CorrelationId: 15cd16b2-7b82-41cb-9b11-21be9dacad88'

Responses

OK response

Bodyapplication/json

entitystring or null

accountsArray of objects or null

paginationobject

Response

{
  "entity": "Test",
  "accounts": [
    {
      "accountNumber": "01012145214562214",
      "accountName": "TestDisplayName",
      "currency": "GBP",
      "clearedBalance": 36,
      "unclearedBalance": 2,
      "balance": 38,
      "accountStatus": "Active"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "recordsPerPage": 10,
    "totalPages": 1,
    "totalNumberOfRecords": 1
  }
}