Passed
APIs
/
Balance
/
Balance

Balance (2025-01-01)

Get accounts data.

Authentication Header

  Authorization: {your_credentials}

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

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

WP-Api-Version Header

  WP-Api-Version: 2025-01-01

We use the WP-Api-Version header to identify which version of our API you are using. You must use the WP-Api-Version header for any request you send.

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. When you make a request within Access Worldpay, you should always cache the response returned.

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

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

accountNumberstring or null

The account number.

accountNamestring or null

Name of the account given to you as part of on-boarding.

currencystring or null
clearedBalancenumber(double)

The cleared balance.

unclearedBalancenumber(double)

The uncleared balance.

balancenumber(double)

The total balance.

accountStatusstring or null

The status of the account.

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

Get details for all your accounts

Request

Retrieve account details for all your accounts.

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

Unique ID given during the on-boarding process.

currencystring
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.

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

Responses

OK response

Bodyapplication/json
entitystring or null
accountsArray of objects or null
accountNumberstring or null

The account number.

accountNamestring or null

Name of the account given to you as part of on-boarding.

currencystring or null
clearedBalancenumber(double)

The cleared balance.

unclearedBalancenumber(double)

The uncleared balance.

balancenumber(double)

The total balance.

accountStatusstring or null

The status of the account.

paginationobject
pageNumberinteger(int32)
recordsPerPageinteger(int32)
totalPagesinteger(int32)
totalNumberOfRecordsinteger(int32)
Response
application/json
{
  "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
  }
}