{"templateId":"markdown","versions":[{"version":"20250101","label":"2025-01-01","link":"/products/parties/payout-instruments","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":"Add payout instrument","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":"add-payout-instrument","__idx":0},"children":["Add payout instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A payout instrument represents a single reference to store the details for a payout to your party."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We currently only support bank account details.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","Cards and e-wallets are coming soon."]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrument"]}," is created 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 the creation of a payout instrument ",{"$$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 payout instrument ",{"$$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-payout-instrument","__idx":1},"children":["Create a payout instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["After"]}," a party is created, you can add a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrument"]}," to it."]},{"$$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}/payoutInstrument"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We verify the details sent against a template for a particular country-currency pair. You can view the  specific country requirements in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/marketplaces/coverage/bank"},"children":["coverage guide"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"requestresponse-example","__idx":2},"children":["Request/response example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/parties/@20250101/openapi.yaml","operationId":"createPayoutInstruments","parameters":{},"environments":{},"codeSamplesResolved":[{"lang":"json","title":"Payload application/json","source":"{\n  \"accountHolderName\": \"Case H. Mitchell\",\n  \"payoutInstrumentType\": \"bankAccount\",\n  \"swiftBic\": \"BUKBGB22\",\n  \"bankCode\": \"045110\",\n  \"branchCode\": \"Barclays Branch\",\n  \"accountNumber\": \"23198765\",\n  \"accountType\": \"checking\",\n  \"iban\": \"GB892019000123456789\",\n  \"bankName\": \"Metro Bank\",\n  \"payoutInstrumentReference\": \"personalCheckingAccount\",\n  \"currency\": \"EUR\",\n  \"address\": {\n    \"address1\": \"17 Neo-London Financial Tower\",\n    \"address2\": \"Suite 1288\",\n    \"type\": \"business\",\n    \"city\": \"London\",\n    \"countryCode\": \"GB\",\n    \"postalCode\": \"EC1A 1BB\"\n  }\n}"},{"lang":"shell","title":"curl","source":"curl -i -X POST \\\n  'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/payoutInstruments' \\\n  -H 'Content-Type: application/json' \\\n  -H 'WP-Api-Version: 2025-01-01' \\\n  -d '{\n    \"accountHolderName\": \"Case H. Mitchell\",\n    \"payoutInstrumentType\": \"bankAccount\",\n    \"swiftBic\": \"BUKBGB22\",\n    \"bankCode\": \"045110\",\n    \"branchCode\": \"Barclays Branch\",\n    \"accountNumber\": \"23198765\",\n    \"accountType\": \"checking\",\n    \"iban\": \"GB892019000123456789\",\n    \"bankName\": \"Metro Bank\",\n    \"payoutInstrumentReference\": \"personalCheckingAccount\",\n    \"currency\": \"EUR\",\n    \"address\": {\n      \"address1\": \"17 Neo-London Financial Tower\",\n      \"address2\": \"Suite 1288\",\n      \"type\": \"business\",\n      \"city\": \"London\",\n      \"countryCode\": \"GB\",\n      \"postalCode\": \"EC1A 1BB\"\n    }\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 + \"/payoutInstruments\"\n\npayload = {\n  \"accountHolderName\": \"Case H. Mitchell\",\n  \"payoutInstrumentType\": \"bankAccount\",\n  \"swiftBic\": \"BUKBGB22\",\n  \"bankCode\": \"045110\",\n  \"branchCode\": \"Barclays Branch\",\n  \"accountNumber\": \"23198765\",\n  \"accountType\": \"checking\",\n  \"iban\": \"GB892019000123456789\",\n  \"bankName\": \"Metro Bank\",\n  \"payoutInstrumentReference\": \"personalCheckingAccount\",\n  \"currency\": \"EUR\",\n  \"address\": {\n    \"address1\": \"17 Neo-London Financial Tower\",\n    \"address2\": \"Suite 1288\",\n    \"type\": \"business\",\n    \"city\": \"London\",\n    \"countryCode\": \"GB\",\n    \"postalCode\": \"EC1A 1BB\"\n  }\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      , \" \\\"accountHolderName\\\": \\\"Case H. Mitchell\\\",\"\n      , \" \\\"payoutInstrumentType\\\": \\\"bankAccount\\\",\"\n      , \" \\\"swiftBic\\\": \\\"BUKBGB22\\\",\"\n      , \" \\\"bankCode\\\": \\\"045110\\\",\"\n      , \" \\\"branchCode\\\": \\\"Barclays Branch\\\",\"\n      , \" \\\"accountNumber\\\": \\\"23198765\\\",\"\n      , \" \\\"accountType\\\": \\\"checking\\\",\"\n      , \" \\\"iban\\\": \\\"GB892019000123456789\\\",\"\n      , \" \\\"bankName\\\": \\\"Metro Bank\\\",\"\n      , \" \\\"payoutInstrumentReference\\\": \\\"personalCheckingAccount\\\",\"\n      , \" \\\"currency\\\": \\\"EUR\\\",\"\n      , \" \\\"address\\\": {\"\n      , \"  \\\"address1\\\": \\\"17 Neo-London Financial Tower\\\",\"\n      , \"  \\\"address2\\\": \\\"Suite 1288\\\",\"\n      , \"  \\\"type\\\": \\\"business\\\",\"\n      , \"  \\\"city\\\": \\\"London\\\",\"\n      , \"  \\\"countryCode\\\": \\\"GB\\\",\"\n      , \"  \\\"postalCode\\\": \\\"EC1A 1BB\\\"\"\n      , \" }\"\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/payoutInstruments\";\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}/payoutInstruments`,\n    {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/json',\n        'WP-Api-Version': '2025-01-01'\n      },\n      body: JSON.stringify({\n        accountHolderName: 'Case H. Mitchell',\n        payoutInstrumentType: 'bankAccount',\n        swiftBic: 'BUKBGB22',\n        bankCode: '045110',\n        branchCode: 'Barclays Branch',\n        accountNumber: '23198765',\n        accountType: 'checking',\n        iban: 'GB892019000123456789',\n        bankName: 'Metro Bank',\n        payoutInstrumentReference: 'personalCheckingAccount',\n        currency: 'EUR',\n        address: {\n          address1: '17 Neo-London Financial Tower',\n          address2: 'Suite 1288',\n          type: 'business',\n          city: 'London',\n          countryCode: 'GB',\n          postalCode: 'EC1A 1BB'\n        }\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 + \"/payoutInstruments\"\n  var data = []byte(`{\n    \"accountHolderName\": \"Case H. Mitchell\",\n    \"payoutInstrumentType\": \"bankAccount\",\n    \"swiftBic\": \"BUKBGB22\",\n    \"bankCode\": \"045110\",\n    \"branchCode\": \"Barclays Branch\",\n    \"accountNumber\": \"23198765\",\n    \"accountType\": \"checking\",\n    \"iban\": \"GB892019000123456789\",\n    \"bankName\": \"Metro Bank\",\n    \"payoutInstrumentReference\": \"personalCheckingAccount\",\n    \"currency\": \"EUR\",\n    \"address\": {\n      \"address1\": \"17 Neo-London Financial Tower\",\n      \"address2\": \"Suite 1288\",\n      \"type\": \"business\",\n      \"city\": \"London\",\n      \"countryCode\": \"GB\",\n      \"postalCode\": \"EC1A 1BB\"\n    }\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  \"accountHolderName\" => \"Case H. Mitchell\",\n  \"payoutInstrumentType\" => \"bankAccount\",\n  \"swiftBic\" => \"BUKBGB22\",\n  \"bankCode\" => \"045110\",\n  \"branchCode\" => \"Barclays Branch\",\n  \"accountNumber\" => \"23198765\",\n  \"accountType\" => \"checking\",\n  \"iban\" => \"GB892019000123456789\",\n  \"bankName\" => \"Metro Bank\",\n  \"payoutInstrumentReference\" => \"personalCheckingAccount\",\n  \"currency\" => \"EUR\",\n  \"address\" => array(\n    \"address1\" => \"17 Neo-London Financial Tower\",\n    \"address2\" => \"Suite 1288\",\n    \"type\" => \"business\",\n    \"city\" => \"London\",\n    \"countryCode\" => \"GB\",\n    \"postalCode\" => \"EC1A 1BB\"\n  )\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 . \"/payoutInstruments\",\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 + '/payoutInstruments')\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  accountHolderName: 'Case H. Mitchell',\n  payoutInstrumentType: 'bankAccount',\n  swiftBic: 'BUKBGB22',\n  bankCode: '045110',\n  branchCode: 'Barclays Branch',\n  accountNumber: '23198765',\n  accountType: 'checking',\n  iban: 'GB892019000123456789',\n  bankName: 'Metro Bank',\n  payoutInstrumentReference: 'personalCheckingAccount',\n  currency: 'EUR',\n  address: {\n    address1: '17 Neo-London Financial Tower',\n    address2: 'Suite 1288',\n    type: 'business',\n    city: 'London',\n    countryCode: 'GB',\n    postalCode: 'EC1A 1BB'\n  }\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      accountHolderName = \"Case H. Mitchell\",\n      payoutInstrumentType = \"bankAccount\",\n      swiftBic = \"BUKBGB22\",\n      bankCode = \"045110\",\n      branchCode = \"Barclays Branch\",\n      accountNumber = \"23198765\",\n      accountType = \"checking\",\n      iban = \"GB892019000123456789\",\n      bankName = \"Metro Bank\",\n      payoutInstrumentReference = \"personalCheckingAccount\",\n      currency = \"EUR\",\n      address = new {\n        address1 = \"17 Neo-London Financial Tower\",\n        address2 = \"Suite 1288\",\n        type = \"business\",\n        city = \"London\",\n        countryCode = \"GB\",\n        postalCode = \"EC1A 1BB\"\n      }\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 + \"/payoutInstruments\", postData);\n    string response = await request.Content.ReadAsStringAsync();\n\n    Console.WriteLine(response);\n  }\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"schema","__idx":3},"children":["Schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/BankAccount"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/BankAccount"},"Address":{"type":"object","description":"Object containing details about the address.","properties":{"address1":{"type":"string","description":"The address.\n\nMust consist of at least two letters, two words, and one number.","example":"1847 Kingsbury Court","maxLength":35,"minLength":2},"address2":{"type":"string","description":"Line two of the address.","example":"Unit 42","maxLength":35,"minLength":2},"city":{"type":"string","description":"The city of this address.","example":"London","maxLength":35,"minLength":1},"state":{"type":"string","description":"The state of this address.","example":"Greater London","maxLength":35,"minLength":2},"countryCode":{"type":"string","description":"The country code specified in [ISO 3166-1 Alpha-2 code format](/products/reference/supported-countries-currencies#iso-country-codes).","example":"GB","maxLength":2,"minLength":2},"postalCode":{"type":"string","description":"The postal code of this address.","example":"NW9 0RR","maxLength":20,"minLength":1},"type":{"type":"string","description":"Identifies the type of this address.","enum":["home","business","poBox","other"],"example":"home"}},"required":["address1","city","countryCode"]},"BankAccount":{"type":"object","properties":{"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","maxLength":64,"minLength":3,"pattern":"^[A-Za-z0-9\\-_ ]*$"},"payoutInstrumentId":{"type":"string","description":"An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.","example":"parOk0YlPtQogrqQdz7_fKXs0","maxLength":25,"minLength":25,"pattern":"^par[a-zA-Z0-9-_]*0$"},"payoutInstrumentType":{"type":"string","description":"The type of the payout instrument.","enum":["bankAccount","wallet","card"]},"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]*$"},"dateTimeCreated":{"type":"string","description":"The date and time the `payoutInstrument` was created, as an ISO 8601 zoned date time.","readOnly":true},"dateTimeUpdated":{"type":"string","description":"The date and time the `payoutInstrument` was updated, as an ISO 8601 zoned date time.","readOnly":true},"version":{"type":"integer","format":"int32"},"accountHolderName":{"type":"string"},"swiftBic":{"type":"string"},"bankCode":{"type":"string","description":"The bankCode must be exactly 6 digits.","example":"184758"},"accountNumber":{"type":"string"},"accountType":{"type":"string","enum":["checking","savings","moneyMarket","certificateOfDeposit","vista","other"]},"iban":{"type":"string"},"bankName":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"branchCode":{"type":"string"}},"required":["currency"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"view-a-payout-instrument","__idx":4},"children":["View a payout instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["View information of a payout instrument, previously created, using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payoutInstrumentId"]}," received in your payout instrument creation response."]},{"$$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}/payoutInstrument/{payoutInstrumentId}"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"requestresponse-example-1","__idx":5},"children":["Request/response example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/parties/@20250101/openapi.yaml","operationId":"getPayoutInstrument","parameters":{},"environments":{},"codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X GET \\\n  'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/payoutInstruments/{payoutInstrumentId}' \\\n  -H 'WP-Api-Version: 2025-01-01'"},{"lang":"python","title":"Python","source":"import requests\n\nparty_id = \"YOUR_partyId_PARAMETER\"\npayout_instrument_id = \"YOUR_payoutInstrumentId_PARAMETER\"\nurl = \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + party_id + \"/payoutInstruments/\" + payout_instrument_id\n\nheaders = {\"WP-Api-Version\": \"2025-01-01\"}\n\nresponse = requests.get(url, 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 host = \"https://try.access.worldpay-bsh.securedataplatform.co.uk\";\n    var partyId = \"YOUR_partyId_PARAMETER\";\n    var payoutInstrumentId = \"YOUR_payoutInstrumentId_PARAMETER\";\n    var pathname = \"/parties/%7BpartyId%7D/payoutInstruments/%7BpayoutInstrumentId%7D\";\n    var request = HttpRequest.newBuilder()\n      .GET()\n      .uri(URI.create(host + pathname ))\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 payoutInstrumentId = 'YOUR_payoutInstrumentId_PARAMETER';\n  const resp = await fetch(\n    `https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/${partyId}/payoutInstruments/${payoutInstrumentId}`,\n    {\n      method: 'GET',\n      headers: {\n        'WP-Api-Version': '2025-01-01'\n      }\n    }\n  );\n\n  const data = await resp.text();\n  console.log(data);\n}\n\nrun();"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n  \"fmt\"\n  \"net/http\"\n  \"io/ioutil\"\n)\n\nfunc main() {\n  partyId := \"YOUR_partyId_PARAMETER\";\n  payoutInstrumentId := \"YOUR_payoutInstrumentId_PARAMETER\";\n  reqUrl := \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + partyId + \"/payoutInstruments/\" + payoutInstrumentId\n  req, err := http.NewRequest(\"GET\", reqUrl, nil)\n  if err != nil {\n    panic(err)\n  }\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 payoutInstrumentId = \"YOUR_payoutInstrumentId_PARAMETER\";\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n  CURLOPT_HTTPHEADER => [\n    \"WP-Api-Version: 2025-01-01\"\n  ],\n  CURLOPT_URL => \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" . partyId . \"/payoutInstruments/\" . payoutInstrumentId,\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_CUSTOMREQUEST => \"GET\",\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 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nparty_id = 'YOUR_partyId_PARAMETER'\npayout_instrument_id = 'YOUR_payoutInstrumentId_PARAMETER'\nurl = URI('https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/' + party_id + '/payoutInstruments/' + payout_instrument_id)\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest['WP-Api-Version'] = '2025-01-01'\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;\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      var PartyId = \"YOUR_partyId_PARAMETER\";\n      var PayoutInstrumentId = \"YOUR_payoutInstrumentId_PARAMETER\";\n    using HttpResponseMessage request = await client.GetAsync(\"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + PartyId + \"/payoutInstruments/\" + PayoutInstrumentId);\n    string response = await request.Content.ReadAsStringAsync();\n\n    Console.WriteLine(response);\n  }\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/openapi/payout-instruments/getpayoutinstrument"},"children":["schema"]}," to view your payout instrument."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"modify-a-payout-instrument","__idx":6},"children":["Modify a payout instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can modify certain payout instrument information previously created. Data entered will again be verified and saved if verification is successful."]},{"$$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/parTH82wexHglhnBbzd6iJ7P0/payoutInstrument/{payoutInstrumentId}"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"requestresponse-example-2","__idx":7},"children":["Request/response example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-products/parties/@20250101/openapi.yaml","operationId":"updatePayoutInstruments","parameters":{},"environments":{},"codeSamplesResolved":[{"lang":"json","title":"Payload application/json","source":"{\n  \"accountHolderName\": \"Tessier-Ashpool Systems Ltd.\",\n  \"payoutInstrumentType\": \"bankAccount\",\n  \"swiftBic\": \"FSFCUS33\",\n  \"bankCode\": \"045110\",\n  \"branchCode\": \"Muswell Hill Branch\",\n  \"accountNumber\": \"2276581\",\n  \"accountType\": \"savings\",\n  \"iban\": \"GB33TASS12345678901234\",\n  \"bankName\": \"Freeside Financial Corporation\",\n  \"payoutInstrumentReference\": \"primaryBusinessAccount\",\n  \"currency\": \"EUR\",\n  \"address\": {\n    \"address1\": \"9105 Villa Straylight\",\n    \"address2\": \"Freeside\",\n    \"type\": \"business\",\n    \"city\": \"York\",\n    \"state\": \"NA\",\n    \"countryCode\": \"GB\",\n    \"postalCode\": \"L502 MK54\"\n  }\n}"},{"lang":"shell","title":"curl","source":"curl -i -X PUT \\\n  'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/payoutInstruments/{payoutInstrumentId}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'WP-Api-Version: 2025-01-01' \\\n  -d '{\n    \"accountHolderName\": \"Tessier-Ashpool Systems Ltd.\",\n    \"payoutInstrumentType\": \"bankAccount\",\n    \"swiftBic\": \"FSFCUS33\",\n    \"bankCode\": \"045110\",\n    \"branchCode\": \"Muswell Hill Branch\",\n    \"accountNumber\": \"2276581\",\n    \"accountType\": \"savings\",\n    \"iban\": \"GB33TASS12345678901234\",\n    \"bankName\": \"Freeside Financial Corporation\",\n    \"payoutInstrumentReference\": \"primaryBusinessAccount\",\n    \"currency\": \"EUR\",\n    \"address\": {\n      \"address1\": \"9105 Villa Straylight\",\n      \"address2\": \"Freeside\",\n      \"type\": \"business\",\n      \"city\": \"York\",\n      \"state\": \"NA\",\n      \"countryCode\": \"GB\",\n      \"postalCode\": \"L502 MK54\"\n    }\n  }'"},{"lang":"python","title":"Python","source":"import requests\n\nparty_id = \"YOUR_partyId_PARAMETER\"\npayout_instrument_id = \"YOUR_payoutInstrumentId_PARAMETER\"\nurl = \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + party_id + \"/payoutInstruments/\" + payout_instrument_id\n\npayload = {\n  \"accountHolderName\": \"Tessier-Ashpool Systems Ltd.\",\n  \"payoutInstrumentType\": \"bankAccount\",\n  \"swiftBic\": \"FSFCUS33\",\n  \"bankCode\": \"045110\",\n  \"branchCode\": \"Muswell Hill Branch\",\n  \"accountNumber\": \"2276581\",\n  \"accountType\": \"savings\",\n  \"iban\": \"GB33TASS12345678901234\",\n  \"bankName\": \"Freeside Financial Corporation\",\n  \"payoutInstrumentReference\": \"primaryBusinessAccount\",\n  \"currency\": \"EUR\",\n  \"address\": {\n    \"address1\": \"9105 Villa Straylight\",\n    \"address2\": \"Freeside\",\n    \"type\": \"business\",\n    \"city\": \"York\",\n    \"state\": \"NA\",\n    \"countryCode\": \"GB\",\n    \"postalCode\": \"L502 MK54\"\n  }\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      , \" \\\"accountHolderName\\\": \\\"Tessier-Ashpool Systems Ltd.\\\",\"\n      , \" \\\"payoutInstrumentType\\\": \\\"bankAccount\\\",\"\n      , \" \\\"swiftBic\\\": \\\"FSFCUS33\\\",\"\n      , \" \\\"bankCode\\\": \\\"045110\\\",\"\n      , \" \\\"branchCode\\\": \\\"Muswell Hill Branch\\\",\"\n      , \" \\\"accountNumber\\\": \\\"2276581\\\",\"\n      , \" \\\"accountType\\\": \\\"savings\\\",\"\n      , \" \\\"iban\\\": \\\"GB33TASS12345678901234\\\",\"\n      , \" \\\"bankName\\\": \\\"Freeside Financial Corporation\\\",\"\n      , \" \\\"payoutInstrumentReference\\\": \\\"primaryBusinessAccount\\\",\"\n      , \" \\\"currency\\\": \\\"EUR\\\",\"\n      , \" \\\"address\\\": {\"\n      , \"  \\\"address1\\\": \\\"9105 Villa Straylight\\\",\"\n      , \"  \\\"address2\\\": \\\"Freeside\\\",\"\n      , \"  \\\"type\\\": \\\"business\\\",\"\n      , \"  \\\"city\\\": \\\"York\\\",\"\n      , \"  \\\"state\\\": \\\"NA\\\",\"\n      , \"  \\\"countryCode\\\": \\\"GB\\\",\"\n      , \"  \\\"postalCode\\\": \\\"L502 MK54\\\"\"\n      , \" }\"\n      , \"}\"\n    );\n\n    var host = \"https://try.access.worldpay-bsh.securedataplatform.co.uk\";\n    var partyId = \"YOUR_partyId_PARAMETER\";\n    var payoutInstrumentId = \"YOUR_payoutInstrumentId_PARAMETER\";\n    var pathname = \"/parties/%7BpartyId%7D/payoutInstruments/%7BpayoutInstrumentId%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 payoutInstrumentId = 'YOUR_payoutInstrumentId_PARAMETER';\n  const resp = await fetch(\n    `https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/${partyId}/payoutInstruments/${payoutInstrumentId}`,\n    {\n      method: 'PUT',\n      headers: {\n        'Content-Type': 'application/json',\n        'WP-Api-Version': '2025-01-01'\n      },\n      body: JSON.stringify({\n        accountHolderName: 'Tessier-Ashpool Systems Ltd.',\n        payoutInstrumentType: 'bankAccount',\n        swiftBic: 'FSFCUS33',\n        bankCode: '045110',\n        branchCode: 'Muswell Hill Branch',\n        accountNumber: '2276581',\n        accountType: 'savings',\n        iban: 'GB33TASS12345678901234',\n        bankName: 'Freeside Financial Corporation',\n        payoutInstrumentReference: 'primaryBusinessAccount',\n        currency: 'EUR',\n        address: {\n          address1: '9105 Villa Straylight',\n          address2: 'Freeside',\n          type: 'business',\n          city: 'York',\n          state: 'NA',\n          countryCode: 'GB',\n          postalCode: 'L502 MK54'\n        }\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  payoutInstrumentId := \"YOUR_payoutInstrumentId_PARAMETER\";\n  reqUrl := \"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + partyId + \"/payoutInstruments/\" + payoutInstrumentId\n  var data = []byte(`{\n    \"accountHolderName\": \"Tessier-Ashpool Systems Ltd.\",\n    \"payoutInstrumentType\": \"bankAccount\",\n    \"swiftBic\": \"FSFCUS33\",\n    \"bankCode\": \"045110\",\n    \"branchCode\": \"Muswell Hill Branch\",\n    \"accountNumber\": \"2276581\",\n    \"accountType\": \"savings\",\n    \"iban\": \"GB33TASS12345678901234\",\n    \"bankName\": \"Freeside Financial Corporation\",\n    \"payoutInstrumentReference\": \"primaryBusinessAccount\",\n    \"currency\": \"EUR\",\n    \"address\": {\n      \"address1\": \"9105 Villa Straylight\",\n      \"address2\": \"Freeside\",\n      \"type\": \"business\",\n      \"city\": \"York\",\n      \"state\": \"NA\",\n      \"countryCode\": \"GB\",\n      \"postalCode\": \"L502 MK54\"\n    }\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 payoutInstrumentId = \"YOUR_payoutInstrumentId_PARAMETER\";\n$curl = curl_init();\n\n$payload = array(\n  \"accountHolderName\" => \"Tessier-Ashpool Systems Ltd.\",\n  \"payoutInstrumentType\" => \"bankAccount\",\n  \"swiftBic\" => \"FSFCUS33\",\n  \"bankCode\" => \"045110\",\n  \"branchCode\" => \"Muswell Hill Branch\",\n  \"accountNumber\" => \"2276581\",\n  \"accountType\" => \"savings\",\n  \"iban\" => \"GB33TASS12345678901234\",\n  \"bankName\" => \"Freeside Financial Corporation\",\n  \"payoutInstrumentReference\" => \"primaryBusinessAccount\",\n  \"currency\" => \"EUR\",\n  \"address\" => array(\n    \"address1\" => \"9105 Villa Straylight\",\n    \"address2\" => \"Freeside\",\n    \"type\" => \"business\",\n    \"city\" => \"York\",\n    \"state\" => \"NA\",\n    \"countryCode\" => \"GB\",\n    \"postalCode\" => \"L502 MK54\"\n  )\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 . \"/payoutInstruments/\" . payoutInstrumentId,\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'\npayout_instrument_id = 'YOUR_payoutInstrumentId_PARAMETER'\nurl = URI('https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/' + party_id + '/payoutInstruments/' + payout_instrument_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  accountHolderName: 'Tessier-Ashpool Systems Ltd.',\n  payoutInstrumentType: 'bankAccount',\n  swiftBic: 'FSFCUS33',\n  bankCode: '045110',\n  branchCode: 'Muswell Hill Branch',\n  accountNumber: '2276581',\n  accountType: 'savings',\n  iban: 'GB33TASS12345678901234',\n  bankName: 'Freeside Financial Corporation',\n  payoutInstrumentReference: 'primaryBusinessAccount',\n  currency: 'EUR',\n  address: {\n    address1: '9105 Villa Straylight',\n    address2: 'Freeside',\n    type: 'business',\n    city: 'York',\n    state: 'NA',\n    countryCode: 'GB',\n    postalCode: 'L502 MK54'\n  }\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      accountHolderName = \"Tessier-Ashpool Systems Ltd.\",\n      payoutInstrumentType = \"bankAccount\",\n      swiftBic = \"FSFCUS33\",\n      bankCode = \"045110\",\n      branchCode = \"Muswell Hill Branch\",\n      accountNumber = \"2276581\",\n      accountType = \"savings\",\n      iban = \"GB33TASS12345678901234\",\n      bankName = \"Freeside Financial Corporation\",\n      payoutInstrumentReference = \"primaryBusinessAccount\",\n      currency = \"EUR\",\n      address = new {\n        address1 = \"9105 Villa Straylight\",\n        address2 = \"Freeside\",\n        type = \"business\",\n        city = \"York\",\n        state = \"NA\",\n        countryCode = \"GB\",\n        postalCode = \"L502 MK54\"\n      }\n    });\n\n    using StringContent postData = new(json, Encoding.UTF8, \"application/json\");\n      var PartyId = \"YOUR_partyId_PARAMETER\";\n      var PayoutInstrumentId = \"YOUR_payoutInstrumentId_PARAMETER\";\n    using HttpResponseMessage request = await client.PutAsync(\"https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/\" + PartyId + \"/payoutInstruments/\" + PayoutInstrumentId, postData);\n    string response = await request.Content.ReadAsStringAsync();\n\n    Console.WriteLine(response);\n  }\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/openapi/payout-instruments/updatepayoutinstruments"},"children":["schema"]}," to modify your payout instrument."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete-a-payout-instrument","__idx":8},"children":["Delete a payout instrument"]},{"$$mdtype":"Tag","name":"p","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/beneficial-owners"},"children":["Manage beneficial owners"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/parties/balance-accounts"},"children":["Add balance accounts"]}," 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":"Add payout instrument","id":"add-payout-instrument","depth":1},{"value":"Create a payout instrument","id":"create-a-payout-instrument","depth":2},{"value":"Request/response example","id":"requestresponse-example","depth":3},{"value":"Schema","id":"schema","depth":3},{"value":"View a payout instrument","id":"view-a-payout-instrument","depth":2},{"value":"Request/response example","id":"requestresponse-example-1","depth":3},{"value":"Modify a payout instrument","id":"modify-a-payout-instrument","depth":2},{"value":"Request/response example","id":"requestresponse-example-2","depth":3},{"value":"Delete a payout instrument","id":"delete-a-payout-instrument","depth":2}],"frontmatter":{"breadcrumbs":{"hide":true},"seo":{"title":"Add payout instrument"}},"lastModified":"2026-08-03T06:56:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/parties/payout-instruments","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}