{"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","oas-products/parties/@20250101/openapi.yaml":"oas-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.com/access","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.com/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/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"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/**/*"],"excludeFiles":[]},{"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/**/*"],"excludeFiles":[]},{"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/**/*"],"excludeFiles":[]},{"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/**/*"],"excludeFiles":[]},{"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/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"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/**/*"],"excludeFiles":[]},{"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/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"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/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"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"]},": 14 May 2025"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"danger","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This documentation is for preview purposes only."]}]},{"$$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.com/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.com/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":"oas-products/parties/@20250101/openapi.yaml","operationId":"createPayoutInstruments","parameters":{},"environments":{}},"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.com/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":"oas-products/parties/@20250101/openapi.yaml","operationId":"getPayoutInstrument","parameters":{},"environments":{}},"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.com/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":"oas-products/parties/@20250101/openapi.yaml","operationId":"updatePayoutInstruments","parameters":{},"environments":{}},"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":"2025-11-26T14:54:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/parties/payout-instruments","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}