Balance accounts

Update a balance account

put/parties/{partyId}/balanceAccounts/{balanceAccountId}

Request

Base URL
https://try.access.worldpay.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/worldpay/apis/parties/docs/parties/:partyId/balanceAccounts/:balanceAccountId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

partyIdstring required

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

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

Request body

currencystring required

The currency in ISO 4217 currency format.

payoutInstrumentReferencestring required

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.

scheduledPayoutDay'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday'

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

frequency'daily' | 'weekly' | 'monthly'

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

recurrence'first' | 'second' | 'third' | 'fourth'

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

balanceAccountIdstring

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

dateTimeCreatedstring

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

dateTimeUpdatedstring

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

versioninteger

accountNumberstring

The number of your balanceAccount.

nextPayoutDatestring date required

The upcoming payout date of the existing schedule for this balanceAccountId. You can retrieve this via our GET endpoint.

Example request

{
  "currency": "GBP",
  "payoutInstrumentReference": "primaryBusinessAccount",
  "scheduledPayoutDay": "friday",
  "frequency": "weekly",
  "recurrence": "first",
  "dateTimeCreated": "2025-01-23T12:23:445.222Z",
  "dateTimeUpdated": "2025-01-25T02:43:499.202Z",
  "nextPayoutDate": "2025-02-14"
}

Response