Skip to content
APIs/Parties/
/
View a balance account

Parties (2025-01-01)

Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.

Authentication

Set your headers

Authorization: {your_credentials}
WP-Api-Version: 2025-01-01

Replace {your_credentials} with your base64-encoded Basic Auth username and password.

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.

API collection

A full set of API examples based on different scenarios.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Languages
Servers
Test (Try)
https://try.access.worldpay.com
Live
https://access.worldpay.com

Parties

Create and maintain parties.

Operations

Payout instruments

Create and maintain payout instruments.

Operations

Balance accounts

Create and maintain balance accounts.

Operations

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

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
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.

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

Scheduled payout for this balanceAccount.
weekly - you must include schedulePayoutDay
monthly - You must include schedulePayoutDay and recurrence

Enum"weekly""monthly"
Example: "weekly"
recurrencestring

The week of the month the payout is paid out. Used for monthly frequency.

Enum"first""second""third""fourth"
Example: "first"
application/json
{
  "currency": "EUR",
  "scheduledPayoutDay": "friday",
  "payoutInstrumentReference": "personalCheckingAccount2"
}

Responses

Created

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.

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

Scheduled payout for this balanceAccount.
weekly - you must include schedulePayoutDay
monthly - You must include schedulePayoutDay and recurrence

Enum"weekly""monthly"
Example: "weekly"
recurrencestring

The week of the month the payout is paid out. Used 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.

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
application/json
{
  "currency": "EUR",
  "payoutInstrumentReference": "personalCheckingAccount2",
  "scheduledPayoutDay": "friday",
  "balanceAccountId": "pareBH4YMkUx7MA2X7bnS4750",
  "dateTimeCreated": "2025-04-16T20:46:26.727Z",
  "version": 0,
  "nextPayoutDate": "2025-04-25"
}

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.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
No request payload

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.

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

Scheduled payout for this balanceAccount.
weekly - you must include schedulePayoutDay
monthly - You must include schedulePayoutDay and recurrence

Enum"weekly""monthly"
Example: "weekly"
recurrencestring

The week of the month the payout is paid out. Used 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.

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
application/json
{
  "currency": "USD",
  "payoutInstrumentReference": "primaryBusinessAccount",
  "scheduledPayoutDay": "thursday",
  "balanceAccountId": "parGWfE__Xr1F-AmY0v72fwR0",
  "dateTimeCreated": "2025-04-16T20:46:27.014Z",
  "version": 1,
  "frequency": "weekly",
  "nextPayoutDate": "2025-04-25"
}

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

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
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.

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

Scheduled payout for this balanceAccount.
weekly - you must include schedulePayoutDay
monthly - You must include schedulePayoutDay and recurrence

Enum"weekly""monthly"
Example: "weekly"
recurrencestring

The week of the month the payout is paid out. Used for monthly frequency.

Enum"first""second""third""fourth"
Example: "first"
application/json
{
  "currency": "USD",
  "payoutInstrumentReference": "primaryBusinessAccount",
  "scheduledPayoutDay": "wednesday",
  "frequency": "monthly",
  "recurrence": "second",
  "nextPayoutDate": "2025-05-12"
}

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.

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

Scheduled payout for this balanceAccount.
weekly - you must include schedulePayoutDay
monthly - You must include schedulePayoutDay and recurrence

Enum"weekly""monthly"
Example: "weekly"
recurrencestring

The week of the month the payout is paid out. Used 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.

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
application/json
{
  "currency": "USD",
  "payoutInstrumentReference": "primaryBusinessAccount",
  "scheduledPayoutDay": "wednesday",
  "balanceAccountId": "parApcraCq1bmBuCotAMoyss0",
  "dateTimeCreated": "2025-04-16T20:46:26.852Z",
  "dateTimeUpdated": "2025-04-16T20:46:29.901Z",
  "version": 1,
  "frequency": "monthly",
  "recurrence": "second",
  "nextPayoutDate": "2025-05-12"
}

Beneficial owners

Create and maintain beneficial owners.

Operations

Identity verification

Enable identity verification check on a party.

Operations