{"templateId":"markdown","versions":[{"version":"v2","label":"v2","link":"/products/account-payouts/v2/single-payout","default":false,"active":false,"folderId":"7d817e0b"},{"version":"20250101","label":"2025-01-01 (Latest)","link":"/products/account-payouts/single-payout","default":true,"active":true,"folderId":"7d817e0b"}],"sharedDataIds":{"sidebar":"sidebar-products/account-payouts/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/account-payouts/openapi","oas-products/account-payouts/@20250101/openapi.yaml":"oas-products/account-payouts/@20250101/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","tabs","tab","openapi-code-sample","json-schema","admonition"]},"custom_product":"Account Payouts","type":"markdown"},"seo":{"title":"Make a single account payout | Account Payouts API","description":"Make a single payout to an account.","siteUrl":"https://docs.worldpay-bsh.securedataplatform.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-bsh.securedataplatform.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":"strong","attributes":{},"children":["Last updated"]},": 25 June 2026 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/account-payouts/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"make-a-single-payout","__idx":0},"children":["Make a single payout"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make a single payout to an account using our Account Payouts endpoint."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request","__idx":1},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay-bsh.securedataplatform.com/accountPayouts"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Account Payout customers","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"account-payout-request-example","__idx":2},"children":["Account Payout request example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/account-payouts/@20250101/openapi.yaml","operationId":"PostPayout","exampleKey":"Full account payout request with payer","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Marketplaces","disable":false},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"marketplace-request-example","__idx":3},"children":["Marketplace request example"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/account-payouts/@20250101/openapi.yaml","operationId":"PostPayout","exampleKey":"Marketplace account payout request including payout instrument","parameters":{},"environments":{}},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-schema","__idx":4},"children":["Request schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.IndividualPayout"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.IndividualPayout"},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Merchant":{"required":["entity"],"type":"object","properties":{"entity":{"maximum":32,"minimum":1,"type":"string","description":"Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.","example":"default"}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Source":{"type":"object","properties":{"accountNumber":{"maximum":16,"minimum":16,"type":"string","description":"Specifies which account should fund the payout, overriding the default account for your `entity`. Common uses include paying sellers from your own account (e.g. credit notes) or choosing among multiple accounts in the same currency. The account must belong to your `entity`.","nullable":true}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.BankAddress":{"type":"object","properties":{"city":{"maximum":35,"minimum":1,"type":"string","description":"City of the address.","nullable":true},"state":{"maximum":35,"minimum":2,"type":"string","description":"State of the address.","nullable":true},"countryCode":{"maximum":2,"minimum":2,"type":"string","description":"<a href=\"/products/reference/supported-countries-currencies#iso-country-codes\">ISO 3166-1 Alpha-2 country code</a> of the address.","nullable":true},"address1":{"maximum":35,"minimum":1,"type":"string","description":"Address line 1.","nullable":true},"address2":{"maximum":35,"minimum":1,"type":"string","description":"Address line 2.","nullable":true},"postalCode":{"maximum":20,"minimum":1,"type":"string","description":"PostalCode of the address.","nullable":true}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.BankDetails":{"type":"object","description":"The bank details of the beneficiary.\n\n  **Note:** View our [bank coverage guide](/products/marketplaces/coverage/bank) for country specific requirements.","properties":{"iban":{"maximum":34,"minimum":1,"type":"string","description":"Beneficiary IBAN. You must either provide `iban` or `accountNumber`.","nullable":true},"branchCode":{"maximum":35,"minimum":1,"type":"string","description":"Beneficiary account branch code.","nullable":true},"bankCode":{"maximum":35,"minimum":1,"type":"string","description":"Beneficiary account bank code.","nullable":true},"swiftBic":{"maximum":11,"minimum":8,"type":"string","description":"Beneficiary bank account SWIFT/BIC.","nullable":true},"bankName":{"maximum":35,"minimum":1,"type":"string","description":"Beneficiary bank name.","nullable":true},"accountType":{"enum":["checking","savings","moneyMarket","certificateOfDeposit","vista","other"],"type":"string","description":"Type of the account.","nullable":true},"accountNumber":{"maximum":64,"minimum":0,"type":"string","description":"Beneficiary bank account number.","nullable":true},"payoutInstrumentId":{"type":"string","description":"A unique ID generated by us, holding the beneficiary bank details. You receive this in the response after successfully creating a payout instrument in our <a href=\"/products/parties/openapi/payout-instruments\">Parties API</a>.","nullable":true},"payoutInstrumentReference":{"type":"string","description":"Your reference for this `payoutInstrument`, must be unique within an entity.","nullable":true},"address":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.BankAddress"}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.CurrencyInfo":{"required":["sourceCurrency"],"type":"object","properties":{"sourceCurrency":{"maximum":3,"minimum":3,"type":"string","description":"Source [currency code](/products/reference/supported-countries-currencies#currency-codes) for the payout (if different to `targetCurrency`, Foreign Exchange (FX) is applied)."},"sourceAmount":{"maximum":10,"minimum":1,"type":"number","description":"Source amount. If `targetAmount` is not stated, this amount is used. Must be a positive value up to 2 decimal places. <br><br> **Important:** Do not include `sourceAmount` and `targetAmount` in the same request, only send one or the other. The request will fail if both are supplied.","format":"double","nullable":true},"targetCurrency":{"maximum":3,"minimum":3,"type":"string","description":"Target <a href=\"/products/reference/supported-countries-currencies#currency-codes\">ISO 4217 alpha-3 currency codes</a> for the payout (if different to `sourceCurrency`, Foreign Exchange (FX) is applied).","nullable":true},"targetAmount":{"maximum":10,"minimum":1,"type":"number","description":"Target amount. If `sourceAmount` is not specified, this amount is used. Must be a positive value up to 2 decimal places. <br><br> **Important:** Do not include `sourceAmount` and `targetAmount` in the same request, only send one or the other. The request will fail if both are supplied.","format":"double","nullable":true}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Phone":{"type":"object","properties":{"number":{"maximum":20,"minimum":1,"type":"string","description":"Phone number of the party. Mandatory if you have provided `prefix`. Special characters are restricted.","nullable":true},"prefix":{"maximum":3,"minimum":1,"type":"string","description":"Phone dialing country code of the party. Mandatory if you have provided `phoneNumber`. Special characters are restricted. International country calling code following ITU-T standard. Must be 1-3 digits e.g. \\\"44\\\" or \\\"420\\\"","nullable":true}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Identity":{"type":"object","properties":{"issuingInstitution":{"type":"string","description":"Issuing institution that provided identification type. Cannot be provided if the conditional fields in the identity section are missing.","nullable":true},"issuingCountry":{"type":"string","description":"<a href=\"/products/reference/supported-countries-currencies#iso-country-codes\">ISO 3166-1 Alpha-2 country code</a> of identification type origin. Mandatory if `identityDocuments.type`/`identityDocuments.number` is populated."},"type":{"enum":["passport","taxId","nationalInsurance","driverLicence","companyVatNumber","citizenshipCard","nationalId","workPermit","employmentPass","studentPass","permanentResidentCard","companyRegistrationNumber","other"],"type":"string","description":"Type of identification. Mandatory if `identityDocuments.number` is populated.","nullable":true},"validFrom":{"maximum":10,"minimum":10,"type":"string","description":"Identification type start date. Must be a Gregorian calendar date with ISO 8601 format YYYY-MM-DD. Cannot be provided if conditional fields in the identity section are missing.","nullable":true},"validTo":{"maximum":10,"minimum":10,"type":"string","description":"Identification type end date. Must be a Gregorian calendar date with ISO 8601 format YYYY-MM-DD. Cannot be provided if conditional fields in the identity section are missing.","nullable":true},"number":{"maximum":35,"minimum":1,"type":"string","description":"Identification number that is presented in the identification type. Mandatory if `identityDocuments.type` is populated."}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PersonalDetails":{"type":"object","properties":{"companyName":{"maximum":140,"minimum":1,"type":"string","description":"Name of the party if not an individual. Mandatory where `type` is \"company\", \"institution\" or \"government\" (Government). Must not be provided when `type` is \"person\" or \"soletrader\".","nullable":true},"firstName":{"maximum":50,"minimum":1,"type":"string","description":"First name of the party. Mandatory where `type` is \"person\" or \"soletrader\". See <a href=\"/products/reference/formatting#name-field-formatting-account-payouts-api\">formatting rules</a>.","nullable":true},"middleName":{"maximum":50,"minimum":1,"type":"string","description":"Middle name of the party (applicable when `type` is \"person\" or \"soletrader\"). See <a href=\"/products/reference/formatting#name-field-formatting-account-payouts-api\">formatting rules</a>.","nullable":true},"lastName":{"maximum":50,"minimum":1,"type":"string","description":"Last name of the party. Mandatory where `type` is \"person\" or \"soletrader\". See <a href=\"/products/reference/formatting#name-field-formatting-account-payouts-api\">formatting rules</a>.","nullable":true},"fullName":{"type":"string","nullable":true,"readOnly":true},"dateOfBirth":{"maximum":10,"minimum":10,"pattern":"yyyy-MM-dd","type":"string","description":"Date of birth.","nullable":true,"example":"1984-01-01"},"email":{"type":"string","description":"Email address of the party. This field will be available for use as part of the future enhancements to the Account Payouts API in 2025. Must be a valid email address format.","nullable":true},"title":{"maximum":3,"enum":["mr","miss","mrs","ms","mx","dr","misc"],"type":"string","description":"Title for the person. Only supply when `type` is \"person\" or \"sole trader\".","nullable":true},"type":{"enum":["company","person","institution","government","soletrader","other"],"type":"string","description":"Entity description of the party, type is required when partyType is beneficiary","nullable":true},"phones":{"type":"array","items":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Phone"},"nullable":true},"identityDocuments":{"type":"array","items":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Identity"},"nullable":true},"dateOfIncorporation":{"maximum":10,"minimum":10,"pattern":"yyyy-MM-dd","type":"string","description":"Date of the Incorporation of the Company. Not allowed if for a person or sole trader.","nullable":true,"example":"2024-01-01"}},"additionalProperties":false,"description":"Only supply either `partyReference` or `personalDetails`."},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PartyAddress":{"type":"object","properties":{"city":{"maximum":35,"minimum":1,"type":"string","description":"City of the address.","nullable":true},"state":{"maximum":35,"minimum":2,"type":"string","description":"State of the address.","nullable":true},"countryCode":{"maximum":2,"minimum":2,"type":"string","description":"<a href=\"/products/reference/supported-countries-currencies#iso-country-codes\">ISO 3166-1 Alpha-2 country code</a> of the address.","nullable":true},"address1":{"maximum":35,"minimum":1,"type":"string","description":"Address line 1.","nullable":true},"address2":{"maximum":35,"minimum":1,"type":"string","description":"Address line 2.","nullable":true},"postalCode":{"maximum":20,"minimum":1,"type":"string","description":"PostalCode of the address.","nullable":true},"type":{"enum":["home","business","poBox","other"],"type":"string","description":"Type of party address.","nullable":true},"residentialStatus":{"enum":["resident","nonResident","other"],"type":"string","description":"Type of residency.","nullable":true}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Party":{"required":["partyType"],"type":"object","properties":{"partyId":{"maximum":36,"minimum":36,"type":"string","description":"Id of the party for the payment request. This field is currently not used.","nullable":true,"example":"1E016F5E-9D4A-49E7-B44C-A4C8AAE8290D"},"partyType":{"enum":["beneficiary","payer"],"type":"string","description":"Party type."},"partyReference":{"maximum":64,"minimum":3,"type":"string","description":"Your reference for this party. Must be unique within an entity. Allowed values are a-z, A-Z, 0-9, spaces and hyphens. \n\n Only supply either `partyReference` or `personalDetails`.\n\n <b>Note:</b> Do not provide for beneficiaries, or for crypto or wallet payouts. Supply `personalDetails` instead.","nullable":true},"customerReference":{"maximum":35,"minimum":1,"type":"string","description":"The reference of the payer: Domain ID, Account Number, Tax ID, BIC, Internal Customer ID or any other numerical or alphanumerical unique identifier of the customer where the payment request has originated. Special characters are restricted.","nullable":true},"personalDetails":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PersonalDetails"},"address":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PartyAddress"}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Narrative":{"type":"object","properties":{"line1":{"maximum":50,"minimum":6,"type":"string","description":"Reference that may appear on beneficiary statements.","nullable":true}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PurposeOfPayment":{"type":"object","description":"Details about the purpose of the payment.\n\n **Note:** View our [bank coverage guide](/products/marketplaces/coverage/bank) for country specific requirements.","properties":{"code":{"enum":["WPPAYR","WPPENS","WPFAMT","WPUBIL","WPSTDY","WPTAXS","WPGDDS","WPCHAR","WPMDCS","WPSAVS","WPPROP","WPSCVE","WPSHAR","WPIVST","WPTKAG","WPTOUR","WPREMT","WPMOVR","WPSUPP","WPCAPI","WPCHRG","WPTRAN","WPSALR","WPDIVD","WPLOAN","WPISER","WPFSER","WPCARD","WPRENT","WPEXPE","WPTRNF","WPBONS","WPOTHR"],"type":"string","description":"The code that represents the purpose of the payout. This is mandatory for some payout routes.","x-enumDescriptions":{"WPPAYR":"Payment of payroll.","WPPENS":"Pension payment.","WPFAMT":"Family maintenance.","WPUBIL":"Payment to common utility provider.","WPSTDY":"Payment of study/tuition costs.","WPTAXS":"Payment of taxes.","WPGDDS":"Purchase sale of goods.","WPCHAR":"Payment for charity reasons.","WPMDCS":"Payment for medical care services.","WPSAVS":"Payment to savings/retirement account.","WPPROP":"Payment of property purchase.","WPSCVE":"Purchase sale of services.","WPSHAR":"Payment of shares.","WPIVST":"Payment of an investment (interest).","WPTKAG":"Tourism (invoiced tickets/travel agency costs).","WPTOUR":"Tourism (other).","WPREMT":"Remittances.","WPMOVR":"Payment of movable property rental.","WPSUPP":"Supplier payment.","WPCAPI":"Payment of capital contribution.","WPCHRG":"Charges/ fees.","WPTRAN":"Payment for transportation.","WPSALR":"Payment of salaries.","WPDIVD":"Dividends.","WPLOAN":"Loans.","WPISER":"Payment of insurance services.","WPFSER":"Payment for financial services.","WPCARD":"Card payments.","WPRENT":"Rental Payments.","WPEXPE":"Payment of expenses","WPTRNF":"Transfer of funds.","WPBONS":"Bonus/compensation.","WPOTHR":"Other."}},"description":{"maximum":35,"minimum":1,"type":"string","description":"Description for purpose of payout. This is mandatory for some payout routes."}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.WalletDetails":{"type":"object","properties":{"walletIdentifierType":{"enum":["walletId","email","phoneNumber"],"type":"string","description":""},"walletIdentifier":{"maximum":64,"minimum":0,"type":"string","description":"Beneficiary wallet identifier.","nullable":true}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PayoutInstruction":{"required":["countryCode"],"type":"object","properties":{"countryCode":{"maximum":2,"minimum":2,"type":"string","description":"<a href=\"/products/reference/supported-countries-currencies#iso-country-codes\">ISO 3166-1 Alpha-2 country code</a> of the payout destination."},"expandableKeyValuePairs":{"type":"object","description":"JSON object of key-value pairs used to supply additional data. The keys and values that you might need to process an account payout to a specific destination, are communicated during the on-boarding process. Duplicate key names are not allowed.","nullable":true},"channel":{"enum":["ach sd","ach nd","wire","dom wire","instant","arbitrum","base","binance","ethereum","polygon","solana","paypal"],"type":"string","description":"Preferable channel for the payout. Multiple values can be added with a comma-separator, to indicate order of preference.","nullable":true},"quoteId":{"type":"string","description":"ID of the <a href=\"/products/fx\">FX quote</a> for the request. This must be a valid, active quote which is for the same source and target currencies as the payout request. It must have valid `intent` of \"FORWARD FX\" or \"PAYOUT\".","nullable":true},"scheduleDate":{"maximum":10,"minimum":10,"type":"string","description":"Scheduled date of the payout request. Must be a Gregorian calendar date with ISO format 8601 YYYY-MM-DD. This field is currently not used.","nullable":true},"source":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Source"},"beneficiaryBankDetails":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.BankDetails"},"value":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.CurrencyInfo"},"parties":{"type":"array","description":"The details of the party.\n\n **Note:** View our [bank coverage guide](/products/marketplaces/coverage/bank) for country specific requirements.","items":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Party"}},"narrative":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Narrative"},"purposeOfPayment":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PurposeOfPayment"},"transactionType":{"enum":["customerToCustomer","businessToBusiness","government","reversal","return","customerToBusiness","businessToCustomer"],"type":"string","description":"Type of transaction. This is mandatory for some payout routes - please check <a href=\"/products/marketplaces/coverage/bank\">country specific requirements</a>.","nullable":true},"beneficiaryWalletDetails":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.WalletDetails"}},"additionalProperties":false},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.IndividualPayout":{"required":["transactionReference"],"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Merchant"},"instruction":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PayoutInstruction"},"transactionReference":{"maximum":50,"minimum":6,"type":"string","description":"Reference for the payout request provided by you. We recommend you specify a value which is unique across all of your payouts to ensure you receive the right data throughout the payout lifecycle. <a href=\"/products/marketplaces/coverage/bank/additionalinfo#special-characters\">Special characters</a> are allowed."},"notificationUrl":{"maximum":250,"type":"string","description":"Currently not in use.","nullable":true}},"additionalProperties":false}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response","__idx":5},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response to your Payout request is the same for standard Account Payout and Marketplaces flows."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-example","__idx":6},"children":["Success example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"payoutRequestId\": \"PZ000EC4\",\n  \"idempotencyKey\": \"idopKey\",\n  \"entity\": \"default\"\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-schema","__idx":7},"children":["Response schema"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"openapi.yaml#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.SuccessResponseV3"},"options":{"schemaExpansionLevel":0},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.SuccessResponseV3"},"WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.SuccessResponseV3":{"type":"object","properties":{"payoutRequestId":{"type":"string","description":"Payout Request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters."},"idempotencyKey":{"description":"Unique reference from the request header of the same name."},"entity":{"type":"string","description":"Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay."}},"additionalProperties":false}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can see more errors and responses in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/account-payouts/openapi/single-payout/postpayout#single-payout/postpayout/response&c=200"},"children":["API reference"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payout-routing","__idx":8},"children":["Payout routing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We offer intelligent routing with built-in redundancy to maximize payout success rates. By default, we handle routing and fail-over automatically. However, if you want full control over how payouts are routed and how failover occurs, you can use the optional properties ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source.accountNumber"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channel"]}," in your payout request payload."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source.accountNumber"]}," - decides which of your merchant accounts (ledgers) is debited for the payout"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channel"]}," - defines which payout routes we should use and in what priority order"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both properties are optional, but using them gives you greater control over:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["routing logic"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["fail-over behavior in case of partner issues or incorrect beneficiary data"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"control-the-funding-source-with-sourceaccountnumber","__idx":9},"children":["Control the funding source with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source.accountNumber"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default we set up each merchant account with one account per currency. If you don't specify the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source.accountNumber"]}," we debit the default account for the payout currency."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you want multiple ledgers for the same currency, you must specify the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source.accountNumber"]}," in the payout request."," ","We can configure these accounts during onboarding or later through our support team."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Important"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Additional accounts require unique funding references for each ledger."," ","The account number format is 16 digits."," ","You can retrieve account details and balances via the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/balance/"},"children":["Balance API"]},"."," ","When you specify ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source.accountNumber"]}," we will:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["validate ownership of the account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["ensure the account currency matches the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sourceCurrency"]}," in your request"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"control-routing-and-failover-with-channel","__idx":10},"children":["Control routing and failover with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channel"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you do not specify a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channel"]}," we use standard routing and failover logic."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the channel property to define:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["which routes we can use"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the priority order for failover"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"available-channels-for-account-payouts","__idx":11},"children":["Available channels for account payouts"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ach sd"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ach nd"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["wire"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dom wire"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instant"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["arbitrum"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["base"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["binance"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ethereum"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["polygon"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["solana"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paypal"]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your available channels depend on your onboarding configuration. Contact your Implementation Manager for further information."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"examples","__idx":12},"children":["Examples"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Channel"},"children":["Channel"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Single channel"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["We attempt real-time payout only. If it fails, funds are reversed to your ledger."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Multiple channels with priority"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instant"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ach sd"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["We try real-time first, then ACH same day if real-time fails."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reverse priority"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ach sd"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["We try ACH same day first, then real-time"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can be flexible based on your payout model and SLAs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"future-enhancements","__idx":13},"children":["Future enhancements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Coming soon"]}]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["specify the delivery date in your request"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["automatic failover to faster routes if cut-off times are missed"]}]},{"$$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/account-payouts/account-events/"},"children":["Event webhooks"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/account-payouts/testing/"},"children":["Testing"]}]}]},"headings":[{"value":"Make a single payout","id":"make-a-single-payout","depth":1},{"value":"Request","id":"request","depth":2},{"value":"Account Payout request example","id":"account-payout-request-example","depth":3},{"value":"Marketplace request example","id":"marketplace-request-example","depth":3},{"value":"Request schema","id":"request-schema","depth":3},{"value":"Response","id":"response","depth":2},{"value":"Success example","id":"success-example","depth":3},{"value":"Response schema","id":"response-schema","depth":3},{"value":"Payout routing","id":"payout-routing","depth":2},{"value":"Control the funding source with source.accountNumber","id":"control-the-funding-source-with-sourceaccountnumber","depth":3},{"value":"Control routing and failover with channel","id":"control-routing-and-failover-with-channel","depth":3},{"value":"Available channels for account payouts","id":"available-channels-for-account-payouts","depth":4},{"value":"Examples","id":"examples","depth":4},{"value":"Future enhancements","id":"future-enhancements","depth":3}],"frontmatter":{"seo":{"title":"Make a single account payout | Account Payouts API","description":"Make a single payout to an account."}},"lastModified":"2026-06-22T15:50:44.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/account-payouts/single-payout","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}