Get account details

Request

Retrieve the details of one specific account.

Security

BasicAuth

Path

accountNumberstringrequired

The account number.

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/{accountNumber}' \
  -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

Unique ID given during the on-boarding process.

accountsArray of objects or null

Collection of the account details

Response

{
  "entity": "Test",
  "accounts": [
    {
      "accountNumber": "01012145214562214",
      "accountName": "TestDisplayName",
      "currency": "GBP",
      "clearedBalance": 36,
      "unclearedBalance": 2,
      "balance": 38,
      "accountStatus": "Active"
    }
  ]
}