Skip to content
APIs/Balances/
Get account details

Get account details

Request

Retrieve the details of one specific account.

Security
basicAuth
Path
accountNumberstringrequired

The account number

Headers
WP-CorrelationIdstring

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

Example:15cd16b2-7b82-41cb-9b11-21be9dacad88
curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/accounts/balance/{accountNumber}' \
  -H 'WP-CorrelationId: 15cd16b2-7b82-41cb-9b11-21be9dacad88'

Responses

OK response

Body
entitystring or null

Your unique 6-digit ID given to you during the onboarding process.

Example:"111155"
accountsArray of objects or null

Collection of account details.

Response
{
  "entity": "111155",
  "accounts": [
    {
      "accountNumber": "1111557890987654",
      "accountName": "Etsy GBP",
      "currency": "GBP",
      "clearedBalance": 142.5,
      "unclearedBalance": 100.8,
      "balance": 243.5,
      "accountStatus": "ACTIVE"
    }
  ]
}