Access Worldpay
/
Get Account

Last Updated: 27 July 2023 | Change Log

Account API

Request your account details for a single account or all accounts under an entity.

Important

Make yourself familiar with our API Principles to ensure a resilient integration.

Get Started

Get started using our API Reference and set your headers.

Request

There are two ways you can retrieve the details of your account:

Request by account number

GET https://try.access.worldpay.com/accounts/balance/

Query string parameters

/accounts/balance/{accountNumber}

Mandatory string parameter

Field NameDescriptionData Type/FormatLengthValidation Criteria
accountNumberThe account number.String16Alphanumeric only. Special characters are restricted.

Response

Schema

entitystring or null

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

Example: 111155
accountsArray of objects or null(Account)

Collection of account details.


Examples

{
  "entity": "111155",
  "accounts": [
    {
      "accountNumber": "1111550000000044",
      "accountName": "PLN account",
      "currency": "PLN",
      "clearedBalance": 1418.64,
      "unclearedBalance": 0,
      "balance": 1418.64
    }
  ]
}

Errors

Check out our API reference for the error code schema.

Request by entity

GET https://try.access.worldpay.com/accounts/balance/

Query string parameters

/accounts/balance/?entity={entity}

Mandatory string parameter

Field NameDescriptionData Type/FormatMin-Max LengthValidation Criteria
entityUnique ID given to you during the onboarding process.String6Alphanumeric only. Special characters are restricted.

Response

Response examples
{
  "entity": "111155",
  "accounts": [
    {
      "accountNumber": "1111550000000044",
      "accountName": "PLN account",
      "currency": "PLN",
      "clearedBalance": 1418.64,
      "unclearedBalance": 0,
      "balance": 1418.64
    },
    {
      "accountNumber": "1111550000000045",
      "accountName": "EUR account",
      "currency": "EUR",
      "clearedBalance": 9997.01,
      "unclearedBalance": 0,
      "balance": 9997.01
    },
    {
      "accountNumber": "1111550000000046",
      "accountName": "USD account",
      "currency": "USD",
      "clearedBalance": 2235.11,
      "unclearedBalance": 0,
      "balance": 2235.11
    }
  ]
}

Response schema

entitystring or null

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

Example: 111155
accountsArray of objects or null(Account)

Collection of account details.


Errors

Check out our API reference for the full error code schema.