Accounts Balance API (v1)

Authentication Header

  Authorization: {your_credentials}

Replace {your_credentials} with your base64-encoded Basic Auth username and password given to your by your Implementation Manager.

You must use the Authorization header for any request you send to our Account APIs, unless you are using client certificate authenticating with SSL/TLS.

Accept Header

  Accept: application/vnd.worldpay.accounts.balance-v1+json

We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Account APIs.

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.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License Worldpay
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Get account details

Request

Retrieve the details of one specific account.

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
No request payload

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.

accountNumberstring or null

The account number.

Example: "1111557890987654"
accountNamestring or null

The name of the account. (This is given to you during onboarding and typically consist of your merchant name followed by currency code.)

Example: "Etsy GBP"
currencystring or null
Example: "GBP"
clearedBalancenumber(double)

The cleared balance.

Example: 142.5
unclearedBalancenumber(double)

The uncleared balance.

Example: 100.8
balancenumber(double)

The total balance.

Example: 243.5
accountStatusstring or null

The status of the account.

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

Get details for all your accounts

Request

Retrieve account details for all your accounts.

Query
entitystring

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

Example: entity=11155
Headers
WP-CorrelationIdstring

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

Example: 15cd16b2-7b82-41cb-9b11-21be9dacad88
No request payload

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.

accountNumberstring or null

The account number.

Example: "1111557890987654"
accountNamestring or null

The name of the account. (This is given to you during onboarding and typically consist of your merchant name followed by currency code.)

Example: "Etsy GBP"
currencystring or null
Example: "GBP"
clearedBalancenumber(double)

The cleared balance.

Example: 142.5
unclearedBalancenumber(double)

The uncleared balance.

Example: 100.8
balancenumber(double)

The total balance.

Example: 243.5
accountStatusstring or null

The status of the account.

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