{"templateId":"markdown","versions":[{"version":"20250101","label":"2025-01-01","link":"/products/parties/balance-accounts","default":true,"active":true,"folderId":"78a47a1f"}],"sharedDataIds":{"sidebar":"sidebar-products/parties/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/parties/openapi","api-docs-products/parties/@20250101/openapi.yaml":"api-docs-products/parties/@20250101/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","openapi-code-sample","json-schema"]},"custom_product":"Parties","type":"markdown"},"seo":{"title":"Manage balance accounts","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay-bsh.securedataplatform.co.uk","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay-bsh.securedataplatform.co.uk/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"]}]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"font","attributes":{"color":"#FF1F3E"},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["New service"]}]}," | ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 03 August 2026"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"manage-balance-accounts","__idx":0},"children":["Manage balance accounts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can add a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balanceAccount"]}," in two ways. Either ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["during"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["after"]}," the creation of a party. This guide focuses on adding a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balanceAccount"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["after"]}," the party creation call."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To add a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balanceAccount"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["during"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/create-party#orchestrated-party-creation"},"children":["orchestrated party creation call"]},", you can use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://access.worldpay-bsh.securedataplatform.co.uk/parties"]}," endpoint."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-balance-account","__idx":1},"children":["Create a balance account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["After"]}," a party is created, you can create and add a balance account."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/balanceAccount"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can only request creation of one balance account per one currency."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-example","__idx":2},"children":["Request example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://access.worldpay-bsh.securedataplatform.co.uk/parties/parTH82wexHglhnBbzd6iJ7P0/balanceAccount"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/parties/@20250101/openapi.yaml","operationId":"createBalanceAccount","parameters":{},"environments":{},"codeSamplesResolved":[{"lang":"json","title":"Payload application/json","source":"{\n  \"currency\": \"EUR\",\n  \"payoutInstrumentReference\": \"personalCheckingAccount2\",\n  \"scheduledPayoutDay\": \"friday\",\n  \"frequency\": \"weekly\"\n}"},{"lang":"shell","title":"curl","source":"curl -i -X POST \\\n  'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/balanceAccounts' \\\n  -H 'Content-Type: application/json' \\\n  -H 'WP-Api-Version: 2025-01-01' \\\n  -d '{\n    \"currency\": \"EUR\",\n    \"payoutInstrumentReference\": \"personalCheckingAccount2\",\n    \"scheduledPayoutDay\": \"friday\",\n    \"frequency\": \"weekly\"\n  }'"},{"lang":"python","title":"Python","source":"import requests\n\nparty_id = \"YOUR_partyId_PARAMETER\"\nurl = \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + party_id + \"/balanceAccounts\"\n\npayload = {\n  \"currency\": \"EUR\",\n  \"payoutInstrumentReference\": \"personalCheckingAccount2\",\n  \"scheduledPayoutDay\": \"friday\",\n  \"frequency\": \"weekly\"\n}\n\nheaders = {\n  \"Content-Type\": \"application/json\",\n  \"WP-Api-Version\": \"2025-01-01\"\n}\n\nresponse = requests.post(url, json=payload, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n  public static void main(String[] args) throws Exception {\n    var httpClient = HttpClient.newBuilder().build();\n\n    var payload = String.join(\"\\n\"\n      , \"{\"\n      , \" \\\"currency\\\": \\\"EUR\\\",\"\n      , \" \\\"payoutInstrumentReference\\\": \\\"personalCheckingAccount2\\\",\"\n      , \" \\\"scheduledPayoutDay\\\": \\\"friday\\\",\"\n      , \" \\\"frequency\\\": \\\"weekly\\\"\"\n      , \"}\"\n    );\n\n    var host = \"https://try.access.worldpay-bsh.securedataplatform.co.uk\";\n    var partyId = \"YOUR_partyId_PARAMETER\";\n    var pathname = \"/parties/%7BpartyId%7D/balanceAccounts\";\n    var request = HttpRequest.newBuilder()\n      .POST(HttpRequest.BodyPublishers.ofString(payload))\n      .uri(URI.create(host + pathname ))\n      .header(\"Content-Type\", \"application/json\")\n      .header(\"WP-Api-Version\", \"2025-01-01\")\n      .build();\n\n    var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n    System.out.println(response.body());\n  }\n}"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n  const partyId = 'YOUR_partyId_PARAMETER';\n  const resp = await fetch(\n    `https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/${partyId}/balanceAccounts`,\n    {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/json',\n        'WP-Api-Version': '2025-01-01'\n      },\n      body: JSON.stringify({\n        currency: 'EUR',\n        payoutInstrumentReference: 'personalCheckingAccount2',\n        scheduledPayoutDay: 'friday',\n        frequency: 'weekly'\n      })\n    }\n  );\n\n  const data = await resp.json();\n  console.log(data);\n}\n\nrun();"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n  \"fmt\"\n  \"bytes\"\n  \"net/http\"\n  \"io/ioutil\"\n)\n\nfunc main() {\n  partyId := \"YOUR_partyId_PARAMETER\";\n  reqUrl := \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + partyId + \"/balanceAccounts\"\n  var data = []byte(`{\n    \"currency\": \"EUR\",\n    \"payoutInstrumentReference\": \"personalCheckingAccount2\",\n    \"scheduledPayoutDay\": \"friday\",\n    \"frequency\": \"weekly\"\n  }`)\n  req, err := http.NewRequest(\"POST\", reqUrl, bytes.NewBuffer(data))\n  if err != nil {\n    panic(err)\n  }\n  req.Header.Add(\"Content-Type\", \"application/json\")\n  req.Header.Add(\"WP-Api-Version\", \"2025-01-01\")\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, err := ioutil.ReadAll(res.Body)\n  if err != nil {\n    panic(err)\n  }\n\n  fmt.Println(res)\n  fmt.Println(string(body))\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\nconst partyId = \"YOUR_partyId_PARAMETER\";\n$curl = curl_init();\n\n$payload = array(\n  \"currency\" => \"EUR\",\n  \"payoutInstrumentReference\" => \"personalCheckingAccount2\",\n  \"scheduledPayoutDay\" => \"friday\",\n  \"frequency\" => \"weekly\"\n);\n\ncurl_setopt_array($curl, [\n  CURLOPT_HTTPHEADER => [\n    \"Content-Type: application/json\",\n    \"WP-Api-Version: 2025-01-01\"\n  ],\n  CURLOPT_POSTFIELDS => json_encode($payload),\n  CURLOPT_URL => \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" . partyId . \"/balanceAccounts\",\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_CUSTOMREQUEST => \"POST\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n  echo \"cURL Error #:\" . $error;\n} else {\n  echo $response;\n}"},{"lang":"ruby","title":"Ruby","source":"require 'json'\nrequire 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nparty_id = 'YOUR_partyId_PARAMETER'\nurl = URI('https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/' + party_id + '/balanceAccounts')\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest['Content-Type'] = 'application/json'\nrequest['WP-Api-Version'] = '2025-01-01'\nrequest.body = {\n  currency: 'EUR',\n  payoutInstrumentReference: 'personalCheckingAccount2',\n  scheduledPayoutDay: 'friday',\n  frequency: 'weekly'\n}.to_json\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\nusing System.Text;\nusing System.Text.Json;\n\npublic class Program\n{\n  public static async Task Main()\n  {\n    System.Net.Http.HttpClient client = new()\n    {\n      DefaultRequestHeaders =\n      {\n        {\"WP-Api-Version\", \"2025-01-01\"},\n      }\n    };\n\n    string json = JsonSerializer.Serialize(new\n    {\n      currency = \"EUR\",\n      payoutInstrumentReference = \"personalCheckingAccount2\",\n      scheduledPayoutDay = \"friday\",\n      frequency = \"weekly\"\n    });\n\n    using StringContent postData = new(json, Encoding.UTF8, \"application/json\");\n      var PartyId = \"YOUR_partyId_PARAMETER\";\n    using HttpResponseMessage request = await client.PostAsync(\"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + PartyId + \"/balanceAccounts\", postData);\n    string response = await request.Content.ReadAsStringAsync();\n\n    Console.WriteLine(response);\n  }\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-response-schema","__idx":3},"children":["Request/ response schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/BalanceAccount"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/BalanceAccount"},"BalanceAccount":{"type":"object","properties":{"currency":{"type":"string","description":"The currency in [ISO 4217 currency format](/products/reference/supported-countries-currencies#iso-currency-codes).","example":"GBP","maxLength":3,"minLength":3,"pattern":"^[A-Z]*$"},"payoutInstrumentReference":{"type":"string","description":"A reference of the `payoutInstrument` created by you. This\nfield holds the beneficiary bank details. Use this to direct payouts to\nthe relevant beneficiary. This must be unique within an entity.\n","example":"primaryBusinessAccount"},"scheduledPayoutDay":{"type":"string","description":"The scheduled payout day for this `balanceAccount`. You must provide this for \"weekly\" and \"monthly\" `frequency`.","enum":["monday","tuesday","wednesday","thursday","friday"],"example":"friday"},"frequency":{"type":"string","description":"Scheduled payout frequency for this `balanceAccount`:\\\n**daily** - payouts are processed every business day\\\n**weekly** - you must include `scheduledPayoutDay`\\\n**monthly** - you must include `scheduledPayoutDay` and `recurrence`\n","enum":["daily","weekly","monthly"],"example":"weekly"},"recurrence":{"type":"string","description":"The week of the month the payout is paid out. You must provide this for \"monthly\" `frequency`.","enum":["first","second","third","fourth"],"example":"first"},"nextPayoutDate":{"type":"string","description":"The next scheduled payout date for this balance account.","example":"2025-02-14","readOnly":true},"balanceAccountId":{"type":"string","description":"Unique ID created by us to identify a balance account. This is sent in the response after `balanceAccount` creation.","readOnly":true},"accountNumber":{"type":"string","description":"The number of your balanceAccount.","readOnly":true},"dateTimeCreated":{"type":"string","description":"The date and time that the balance account was created, as an ISO 8601 zoned date time.","example":"2025-01-23T12:23:445.222Z","readOnly":true},"dateTimeUpdated":{"type":"string","description":"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","readOnly":true},"version":{"type":"integer","format":"int32","readOnly":true}},"required":["currency"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"view-a-balance-account","__idx":4},"children":["View a balance account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["View information about a balance account, previously created."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/balanceAccount/{balanceAccountId"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can see the full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#schema"},"children":["schema"]}," above or in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/openapi/balance-accounts"},"children":["API reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"assigning-a-payout-schedule","__idx":5},"children":["Assigning a payout schedule"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Assign a payout schedule to a balance account, to ensure regular payouts to a specified ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/payout-instruments/"},"children":["payout instrument"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some regions require you to assign a regular schedule to their balance accounts. Please speak to your Worldpay Implementation Manager for further details."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"schedule-support","__idx":6},"children":["Schedule support"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["daily"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["for every workday of the week (Monday-Friday)"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["weekly"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["for any workday of the week (Monday-Friday), using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scheduledPayoutDay"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["monthly"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["set the day of the week (Monday-Friday), using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scheduledPayoutDay"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["define which week of the month (first, second, third, fourth), using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recurrence"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update-a-balance-account","__idx":7},"children":["Update a balance account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can change:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrument"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the day the payouts are scheduled for"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Requirements"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When updating a balance account, you must provide the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextPayoutDate"]},". This is the date of the upcoming payout of the existing schedule for this ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balanceAccountId"]},". You can make a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/openapi/balance-accounts/getbalanceaccount"},"children":["GET request against this ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["balanceAccountId"]}]}," to retrieve this."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrument"]}," currency must match the currency of the balance account."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-example-1","__idx":8},"children":["Request example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/balanceAccount/{balanceAccountId}"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/parties/@20250101/openapi.yaml","operationId":"updateBalanceAccount","parameters":{},"environments":{},"codeSamplesResolved":[{"lang":"json","title":"Payload application/json","source":"{\n  \"currency\": \"USD\",\n  \"payoutInstrumentReference\": \"primaryBusinessAccount\",\n  \"scheduledPayoutDay\": \"thursday\",\n  \"frequency\": \"weekly\",\n  \"balanceAccountId\": \"parApcraCq1bmBuCotAMoyss0\",\n  \"dateTimeCreated\": \"2025-04-16T20:46:26.852Z\",\n  \"dateTimeUpdated\": \"2025-04-16T20:46:29.901Z\",\n  \"version\": 1,\n  \"accountNumber\": \"12345678\",\n  \"nextPayoutDate\": \"2026-03-19\"\n}"},{"lang":"shell","title":"curl","source":"curl -i -X PUT \\\n  'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/balanceAccounts/{balanceAccountId}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'WP-Api-Version: 2025-01-01' \\\n  -d '{\n    \"currency\": \"USD\",\n    \"payoutInstrumentReference\": \"primaryBusinessAccount\",\n    \"scheduledPayoutDay\": \"thursday\",\n    \"frequency\": \"weekly\",\n    \"balanceAccountId\": \"parApcraCq1bmBuCotAMoyss0\",\n    \"dateTimeCreated\": \"2025-04-16T20:46:26.852Z\",\n    \"dateTimeUpdated\": \"2025-04-16T20:46:29.901Z\",\n    \"version\": 1,\n    \"accountNumber\": \"12345678\",\n    \"nextPayoutDate\": \"2026-03-19\"\n  }'"},{"lang":"python","title":"Python","source":"import requests\n\nparty_id = \"YOUR_partyId_PARAMETER\"\nbalance_account_id = \"YOUR_balanceAccountId_PARAMETER\"\nurl = \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + party_id + \"/balanceAccounts/\" + balance_account_id\n\npayload = {\n  \"currency\": \"USD\",\n  \"payoutInstrumentReference\": \"primaryBusinessAccount\",\n  \"scheduledPayoutDay\": \"thursday\",\n  \"frequency\": \"weekly\",\n  \"balanceAccountId\": \"parApcraCq1bmBuCotAMoyss0\",\n  \"dateTimeCreated\": \"2025-04-16T20:46:26.852Z\",\n  \"dateTimeUpdated\": \"2025-04-16T20:46:29.901Z\",\n  \"version\": 1,\n  \"accountNumber\": \"12345678\",\n  \"nextPayoutDate\": \"2026-03-19\"\n}\n\nheaders = {\n  \"Content-Type\": \"application/json\",\n  \"WP-Api-Version\": \"2025-01-01\"\n}\n\nresponse = requests.put(url, json=payload, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n  public static void main(String[] args) throws Exception {\n    var httpClient = HttpClient.newBuilder().build();\n\n    var payload = String.join(\"\\n\"\n      , \"{\"\n      , \" \\\"currency\\\": \\\"USD\\\",\"\n      , \" \\\"payoutInstrumentReference\\\": \\\"primaryBusinessAccount\\\",\"\n      , \" \\\"scheduledPayoutDay\\\": \\\"thursday\\\",\"\n      , \" \\\"frequency\\\": \\\"weekly\\\",\"\n      , \" \\\"balanceAccountId\\\": \\\"parApcraCq1bmBuCotAMoyss0\\\",\"\n      , \" \\\"dateTimeCreated\\\": \\\"2025-04-16T20:46:26.852Z\\\",\"\n      , \" \\\"dateTimeUpdated\\\": \\\"2025-04-16T20:46:29.901Z\\\",\"\n      , \" \\\"version\\\": 1,\"\n      , \" \\\"accountNumber\\\": \\\"12345678\\\",\"\n      , \" \\\"nextPayoutDate\\\": \\\"2026-03-19\\\"\"\n      , \"}\"\n    );\n\n    var host = \"https://try.access.worldpay-bsh.securedataplatform.co.uk\";\n    var partyId = \"YOUR_partyId_PARAMETER\";\n    var balanceAccountId = \"YOUR_balanceAccountId_PARAMETER\";\n    var pathname = \"/parties/%7BpartyId%7D/balanceAccounts/%7BbalanceAccountId%7D\";\n    var request = HttpRequest.newBuilder()\n      .PUT(HttpRequest.BodyPublishers.ofString(payload))\n      .uri(URI.create(host + pathname ))\n      .header(\"Content-Type\", \"application/json\")\n      .header(\"WP-Api-Version\", \"2025-01-01\")\n      .build();\n\n    var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n    System.out.println(response.body());\n  }\n}"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n  const partyId = 'YOUR_partyId_PARAMETER';\n  const balanceAccountId = 'YOUR_balanceAccountId_PARAMETER';\n  const resp = await fetch(\n    `https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/${partyId}/balanceAccounts/${balanceAccountId}`,\n    {\n      method: 'PUT',\n      headers: {\n        'Content-Type': 'application/json',\n        'WP-Api-Version': '2025-01-01'\n      },\n      body: JSON.stringify({\n        currency: 'USD',\n        payoutInstrumentReference: 'primaryBusinessAccount',\n        scheduledPayoutDay: 'thursday',\n        frequency: 'weekly',\n        balanceAccountId: 'parApcraCq1bmBuCotAMoyss0',\n        dateTimeCreated: '2025-04-16T20:46:26.852Z',\n        dateTimeUpdated: '2025-04-16T20:46:29.901Z',\n        version: 1,\n        accountNumber: '12345678',\n        nextPayoutDate: '2026-03-19'\n      })\n    }\n  );\n\n  const data = await resp.json();\n  console.log(data);\n}\n\nrun();"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n  \"fmt\"\n  \"bytes\"\n  \"net/http\"\n  \"io/ioutil\"\n)\n\nfunc main() {\n  partyId := \"YOUR_partyId_PARAMETER\";\n  balanceAccountId := \"YOUR_balanceAccountId_PARAMETER\";\n  reqUrl := \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + partyId + \"/balanceAccounts/\" + balanceAccountId\n  var data = []byte(`{\n    \"currency\": \"USD\",\n    \"payoutInstrumentReference\": \"primaryBusinessAccount\",\n    \"scheduledPayoutDay\": \"thursday\",\n    \"frequency\": \"weekly\",\n    \"balanceAccountId\": \"parApcraCq1bmBuCotAMoyss0\",\n    \"dateTimeCreated\": \"2025-04-16T20:46:26.852Z\",\n    \"dateTimeUpdated\": \"2025-04-16T20:46:29.901Z\",\n    \"version\": 1,\n    \"accountNumber\": \"12345678\",\n    \"nextPayoutDate\": \"2026-03-19\"\n  }`)\n  req, err := http.NewRequest(\"PUT\", reqUrl, bytes.NewBuffer(data))\n  if err != nil {\n    panic(err)\n  }\n  req.Header.Add(\"Content-Type\", \"application/json\")\n  req.Header.Add(\"WP-Api-Version\", \"2025-01-01\")\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, err := ioutil.ReadAll(res.Body)\n  if err != nil {\n    panic(err)\n  }\n\n  fmt.Println(res)\n  fmt.Println(string(body))\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\nconst partyId = \"YOUR_partyId_PARAMETER\";\nconst balanceAccountId = \"YOUR_balanceAccountId_PARAMETER\";\n$curl = curl_init();\n\n$payload = array(\n  \"currency\" => \"USD\",\n  \"payoutInstrumentReference\" => \"primaryBusinessAccount\",\n  \"scheduledPayoutDay\" => \"thursday\",\n  \"frequency\" => \"weekly\",\n  \"balanceAccountId\" => \"parApcraCq1bmBuCotAMoyss0\",\n  \"dateTimeCreated\" => \"2025-04-16T20:46:26.852Z\",\n  \"dateTimeUpdated\" => \"2025-04-16T20:46:29.901Z\",\n  \"version\" => 1,\n  \"accountNumber\" => \"12345678\",\n  \"nextPayoutDate\" => \"2026-03-19\"\n);\n\ncurl_setopt_array($curl, [\n  CURLOPT_HTTPHEADER => [\n    \"Content-Type: application/json\",\n    \"WP-Api-Version: 2025-01-01\"\n  ],\n  CURLOPT_POSTFIELDS => json_encode($payload),\n  CURLOPT_URL => \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" . partyId . \"/balanceAccounts/\" . balanceAccountId,\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_CUSTOMREQUEST => \"PUT\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n  echo \"cURL Error #:\" . $error;\n} else {\n  echo $response;\n}"},{"lang":"ruby","title":"Ruby","source":"require 'json'\nrequire 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nparty_id = 'YOUR_partyId_PARAMETER'\nbalance_account_id = 'YOUR_balanceAccountId_PARAMETER'\nurl = URI('https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/' + party_id + '/balanceAccounts/' + balance_account_id)\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest['Content-Type'] = 'application/json'\nrequest['WP-Api-Version'] = '2025-01-01'\nrequest.body = {\n  currency: 'USD',\n  payoutInstrumentReference: 'primaryBusinessAccount',\n  scheduledPayoutDay: 'thursday',\n  frequency: 'weekly',\n  balanceAccountId: 'parApcraCq1bmBuCotAMoyss0',\n  dateTimeCreated: '2025-04-16T20:46:26.852Z',\n  dateTimeUpdated: '2025-04-16T20:46:29.901Z',\n  version: 1,\n  accountNumber: '12345678',\n  nextPayoutDate: '2026-03-19'\n}.to_json\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\nusing System.Text;\nusing System.Text.Json;\n\npublic class Program\n{\n  public static async Task Main()\n  {\n    System.Net.Http.HttpClient client = new()\n    {\n      DefaultRequestHeaders =\n      {\n        {\"WP-Api-Version\", \"2025-01-01\"},\n      }\n    };\n\n    string json = JsonSerializer.Serialize(new\n    {\n      currency = \"USD\",\n      payoutInstrumentReference = \"primaryBusinessAccount\",\n      scheduledPayoutDay = \"thursday\",\n      frequency = \"weekly\",\n      balanceAccountId = \"parApcraCq1bmBuCotAMoyss0\",\n      dateTimeCreated = \"2025-04-16T20:46:26.852Z\",\n      dateTimeUpdated = \"2025-04-16T20:46:29.901Z\",\n      version = \"1\",\n      accountNumber = \"12345678\",\n      nextPayoutDate = \"2026-03-19\"\n    });\n\n    using StringContent postData = new(json, Encoding.UTF8, \"application/json\");\n      var PartyId = \"YOUR_partyId_PARAMETER\";\n      var BalanceAccountId = \"YOUR_balanceAccountId_PARAMETER\";\n    using HttpResponseMessage request = await client.PutAsync(\"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + PartyId + \"/balanceAccounts/\" + BalanceAccountId, postData);\n    string response = await request.Content.ReadAsStringAsync();\n\n    Console.WriteLine(response);\n  }\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can see the full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#schema"},"children":["schema"]}," above or in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/openapi/balance-accounts"},"children":["API reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete-a-balance-account","__idx":9},"children":["Delete a balance account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Coming soon"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next steps"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/payout-instruments"},"children":["Add a payout instrument"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/beneficial-owners"},"children":["Manage beneficial owners"]}," or ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/verify-parties"},"children":["Verify a party"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]},"headings":[{"value":"Manage balance accounts","id":"manage-balance-accounts","depth":1},{"value":"Create a balance account","id":"create-a-balance-account","depth":2},{"value":"Request example","id":"request-example","depth":3},{"value":"Request/ response schema","id":"request-response-schema","depth":3},{"value":"View a balance account","id":"view-a-balance-account","depth":2},{"value":"Assigning a payout schedule","id":"assigning-a-payout-schedule","depth":2},{"value":"Schedule support","id":"schedule-support","depth":3},{"value":"Update a balance account","id":"update-a-balance-account","depth":2},{"value":"Request example","id":"request-example-1","depth":3},{"value":"Delete a balance account","id":"delete-a-balance-account","depth":2}],"frontmatter":{"breadcrumbs":{"hide":true},"seo":{"title":"Manage balance accounts"}},"lastModified":"2026-08-03T06:56:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/parties/balance-accounts","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}