APIs
/
Parties
/
Balance accounts

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
License Worldpay
Languages
Servers
Live
http://access.worldpay.com/
Try
http://try.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

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
WP-CorrelationIdstring

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

Example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
Bodyapplication/jsonrequired
currencystring= 3 characters^[A-Z]*$required
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: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
application/json

Create balance account for existing party of a person (modular)

{
  "currency": "EUR",
  "scheduledPayoutDay": "friday",
  "payoutInstrumentReference": "MyPayoutInstrument1"
}

Responses

Created

Bodyapplication/json
currencystring= 3 characters^[A-Z]*$required
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: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
balanceAccountIdstringread-only

Unique ID created by us to identify a balance account. This 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-onlyrequired
Response
application/json

Balance account for a party of an existing person (modular)

{
  "currency": "EUR",
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "scheduledPayoutDay": "friday",
  "balanceAccountId": "pareBH4YMkUx7MA2X7bnS4750",
  "dateTimeCreated": "2025-04-16T20:46:26.727Z",
  "version": 0
}

View a balance account

Request

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
WP-CorrelationIdstring

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

Example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
No request payload

Responses

OK

Bodyapplication/json
currencystring= 3 characters^[A-Z]*$required
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: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
balanceAccountIdstringread-only

Unique ID created by us to identify a balance account. This 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-onlyrequired
Response
application/json

Balance account for a party of type company (modular)

{
  "currency": "CHF",
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "scheduledPayoutDay": "thursday",
  "balanceAccountId": "parGWfE__Xr1F-AmY0v72fwR0",
  "dateTimeCreated": "2025-04-16T20:46:27.014Z",
  "version": 1
}

Update a balance account

Request

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
WP-CorrelationIdstring

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

Example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
Bodyapplication/jsonrequired
currencystring= 3 characters^[A-Z]*$required
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: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
application/json

Update balance account for existing party of a sole trader (modular)

{
  "currency": "CHF",
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "scheduledPayoutDay": "wednesday"
}

Responses

OK

Bodyapplication/json
currencystring= 3 characters^[A-Z]*$required
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: "MyPayoutInstrument1"
scheduledPayoutDaystring

The scheduled payout day for this balanceAccount.

Enum"monday""tuesday""wednesday""thursday""friday"
balanceAccountIdstringread-only

Unique ID created by us to identify a balance account. This 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-onlyrequired
Response
application/json

Update balance account for existing party of a sole trader (modular)

{
  "currency": "CHF",
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "scheduledPayoutDay": "wednesday",
  "balanceAccountId": "parApcraCq1bmBuCotAMoyss0",
  "dateTimeCreated": "2025-04-16T20:46:26.852Z",
  "dateTimeUpdated": "2025-04-16T20:46:29.901Z",
  "version": 1
}

Beneficial owners

Create and maintain beneficial owners.

Operations

Identity Verification

Enable Identity Verification check on a party.

Operations