Last Updated: 27 July 2023 | Change Log

Account API

Request your account details

Request

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

by account number or
by entity

By account number

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

Query string parameters

/accounts/balance/{accountNumber}

Mandatory string parameter

Field Name	Description	Data Type/Format	Min-Max Length	Validation Criteria
`accountNumber`	Account Number. The first 6 characters indicate the entity (domain ID) of the merchant.The rest determines the specific account number.	String	16-16	Alphanumeric only. Special characters are restricted.

Response

Successful response example

{
  "entity": "000055",
  "accounts": [
    {
      "accountNumber": "0000550000000044",
      "accountName": "Envoy Live Test (PLN)",
      "currency": "PLN",
      "clearedBalance": 1418.64,
      "unclearedBalance": 0,
      "balance": 1418.64
    }
  ]
}

Successful response fields

Field Name	Description	Data Type/Format
`entity`	Unique ID given to you during the onboarding process.	AN (Length: 6)
`accounts`	Collection of account details list.
`accountNumber`	Account Number. The first 6 characters indicate the entity (domain ID) of the merchant. The rest determines the specific account number.	AN (Length: 16)
`accountName`	Name of the account (this name is given to an account during on-boarding and is usually the merchant name followed by the currency code).	AN
`currency`	Currency of the account.	AN
`clearedBalance`	Cleared balance.	N
`unclearedBalance`	Uncleared balance.	N
`balance`	Total balance.	N

Error response example

{
    "httpStatusCode": 404,
    "customCode": "ACCN15",
    "message": "Could not find details for accountNumber"
}

Error response codes

HTTP code	Custom code	Message	Scenario
400	ACCB05	Schema validation failed	Schema Validation Failed - account number not provided, or account number length is incorrect
400	ACCU07	Invalid accountNumber	Internal service error
401	ACCU06	Authorization has been denied for this request	Internal service error
401	ACCU06	Authorisation Failed for this Domain	Token validation failed
404	ACCN15	Could not find details for accountNumber	There are no details found for the provided account number
500	ACCE11	Something went wrong	Internal service error
500	ACCE11	Unexpected Issue. Please try again	Unexpected issue. Please try again

By entity

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

Query string parameters

`/accounts/balance/?entity={entity}

Mandatory string parameter

Field Name	Description	Data Type/Format	Min-Max Length	Validation Criteria
`entity`	Unique ID given to you during the onboarding process.	String	6	Alphanumeric only. Special characters are restricted.

Response

Successful response example

{
  "entity": "000055",
  "accounts": [
    {
      "accountNumber": "0000550000000044",
      "accountName": "Envoy Live Test (PLN)",
      "currency": "PLN",
      "clearedBalance": 1418.64,
      "unclearedBalance": 0,
      "balance": 1418.64
    },
    {
      "accountNumber": "0000550000000045",
      "accountName": "Envoy Live Test (EUR)",
      "currency": "EUR",
      "clearedBalance": 9997.01,
      "unclearedBalance": 0,
      "balance": 9997.01
    },
    {
      "accountNumber": "0000550000000046",
      "accountName": "Envoy Live Test (USD)",
      "currency": "USD",
      "clearedBalance": 2235.11,
      "unclearedBalance": 0,
      "balance": 2235.11
    }
  ]
}

Successful response fields

Field Name	Description	Data Type/Format
`entity`	Unique ID given to you during the onboarding process.	AN (Length: 6)
`accounts`	Collection of account details list.
`accountNumber`	Account Number. The first 6 characters indicate the entity (domain ID) of the merchant. The rest determines the specific account number.	AN (Length: 16)
`accountName`	Name of the account (this name is given to an account during on-boarding and is usually the merchant name followed by the currency code).	AN
`currency`	Currency of the account.	AN
`clearedBalance`	Cleared balance.	N
`unclearedBalance`	Uncleared balance.	N
`balance`	Total balance.	N

Error response example

{
    "httpStatusCode": 400,
    "customCode": "ACCB05",
    "message": "Schema validation failed",
    "errors": {
         "entity":  ["Entity should be 6 characters"]
     }
}

Error response codes

HTTP code	Custom code	Message	Scenario
400	ACCB05	Schema validation failed	Schema Validation Failed: Entity not provided, or is of incorrect length
400	ACCU07	Invalid accountNumber	Internal service error
401	ACCU06	Authorization has been denied for this request	Internal service error
401	ACCU06	Authorisation Failed for this Domain	Token validation failed
404	ACCN15	Could not find details for accountNumber	There are no details found for provided for the account number
500	ACCE11	Something went wrong	Internal service error
500	ACCE11	Unexpected Issue. Please try again	Unexpected issue. Please try again

Account API

Request

By account number

Query string parameters

Mandatory string parameter

Response

Successful response example

Successful response fields

Error response example

Error response codes

By entity

Query string parameters

Mandatory string parameter

Response

Successful response example

Successful response fields

Error response example

Error response codes

Do you like our page?