View a balance account

Request

Security

basicAuth

Path

partyIdstring, = 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

balanceAccountIdstring, = 25 characterspar.*0$required

A unique identifier for the balanceAccount generated by us. This is sent in the response of your balanceAccount creation call.

WP-Api-Versionstring, (date)required

The API version.

Example:2025-01-01

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/balanceAccounts/{balanceAccountId}' \
  -H 'WP-Api-Version: 2025-01-01'

Responses

OK

Bodyapplication/json

currencystring, = 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example:"GBP"

payoutInstrumentReferencestring

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example:"primaryBusinessAccount"

scheduledPayoutDaystring

The scheduled payout day for this balanceAccount. You must provide this for "weekly" and "monthly" frequency.

Enum:"monday""tuesday""wednesday""thursday""friday"

Example:"friday"

frequencystring

Scheduled payout frequency for this balanceAccount:
daily - payouts are processed every business day
weekly - you must include scheduledPayoutDay
monthly - you must include scheduledPayoutDay and recurrence

Enum:"daily""weekly""monthly"

Example:"weekly"

recurrencestring

The week of the month the payout is paid out. You must provide this for "monthly" frequency.

Enum:"first""second""third""fourth"

Example:"first"

nextPayoutDatestringread-only

The next scheduled payout date for this balance account.

Example:"2025-02-14"

balanceAccountIdstringread-only

Unique ID created by us to identify a balance account. This is sent in the response after balanceAccount creation.

accountNumberstringread-only

The number of your balanceAccount.

dateTimeCreatedstringread-only

The date and time that the balance account was created, as an ISO 8601 zoned date time.

Example:"2025-01-23T12:23:445.222Z"

dateTimeUpdatedstringread-only

The date and time that the balance account was last updated, as an ISO 8601 zoned date time.

Example:"2025-01-25T02:43:499.202Z"

versioninteger, (int32)read-only

Response

Balance account for a party of type company (modular)

{
  "currency": "USD",
  "payoutInstrumentReference": "primaryBusinessAccount",
  "frequency": "daily",
  "balanceAccountId": "parGWfE__Xr1F-AmY0v72fwR0",
  "dateTimeCreated": "2025-04-16T20:46:27.014Z",
  "dateTimeUpdated": "2025-04-17T20:46:27.014Z",
  "version": 1,
  "accountNumber": "12345678",
  "nextPayoutDate": "2026-03-19"
}