New service | Last updated: 14 May 2025
This documentation is for preview purposes only.
Create and manage balance accounts which represent a virtual currency account within Worldpay. We use this to store the party's funds ahead of a payout.
You can add a balanceAccount
in two ways. Either during or after the creation of a party. This guide focuses on adding a balanceAccount
after the party creation call.
To add a balanceAccount
during orchestrated party creation call, you can use the https://access.worldpay.com/parties
endpoint.
After a party is created, you can create and add a balance account.
POST
https://access.worldpay.com/parties/{partyId}/balanceAccount
You can only request creation of one balance account per one currency.
POST
https://access.worldpay.com/parties/parTH82wexHglhnBbzd6iJ7P0/balanceAccount
- Live
http://access.worldpay.com/parties/{partyId}/balanceAccounts
- Try
http://try.access.worldpay.com/parties/{partyId}/balanceAccounts
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
Create balance account for existing party of a person (modular)
{ "currency": "EUR", "scheduledPayoutDay": "friday", "payoutInstrumentReference": "MyPayoutInstrument1" }
The currency in ISO 4217 currency format.
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.
The scheduled payout day for this balanceAccount
.
Unique ID created by us to identify a balance account. This sent in the response after balanceAccount
creation.
The date and time that the balance account was created, as an ISO 8601 zoned date time.
The date and time that the balance account was last updated, as an ISO 8601 zoned date time.
View information about a balance account, previously created.
GET
https://access.worldpay.com/parties/{partyId}/balanceAccount/{balanceAccountId
- Live
http://access.worldpay.com/parties/{partyId}/balanceAccounts/{balanceAccountId}
- Try
http://try.access.worldpay.com/parties/{partyId}/balanceAccounts/{balanceAccountId}
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
No request payload
You can see the full schema above or in our API reference.
Assign a payout schedule to a balance account, to ensure regular payouts to a specified payout instrument.
Some regions require you to assign a regular schedule to their balance accounts. Please speak to your Implementation Manager for further details
weekly schedules
- for each workday of the week (Monday-Friday)
- the
payoutInstrument
currency must match the one of the balance account
Coming Soon - Additional schedules and FX functionality
You can:
- change the
payoutInstrument
- day the schedules are paid out to
PUT
https://access.worldpay.com/parties/{partyId}/balanceAccount/{balanceAccountId}
- Live
http://access.worldpay.com/parties/{partyId}/balanceAccounts/{balanceAccountId}
- Try
http://try.access.worldpay.com/parties/{partyId}/balanceAccounts/{balanceAccountId}
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
Update balance account for existing party of a sole trader (modular)
{ "currency": "USD", "payoutInstrumentReference": "MyPayoutInstrument1", "scheduledPayoutDay": "wednesday" }
You can see the full schema above or in our API reference.
Coming Soon
Add a payout instrument
Manage beneficial owners or
Verify a party