# Make a single payout

Endpoint: POST /accountPayouts
Version: 2025-01-01
Security: BasicAuth

## Header parameters:

  - `WP-CorrelationId` (string)
    A unique identifier used to trace and correlate a request across systems. Must be a GUID.
    Example: "15cd16b2-7b82-41cb-9b11-21be9dacad88"

  - `WP-Timestamp` (string)

  - `WP-Api-Version` (string)
    The version of the API you are using.
    Example: "2025-01-01"

  - `Idempotency-Key` (string)
    A unique key to identify the request. This is used to prevent duplicate processing of the same request.
    Example: "1234567890"

  - `Content-Type` (string)
    Specifies the media type of the resource or the data being sent. This field informs the server or client how to interpret the body of the request or response.
    Example: "application/json"

## Request fields (application/json):

  - `merchant` (object)

  - `merchant.entity` (string, required)
    Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.
    Example: "default"

  - `instruction` (object)

  - `instruction.countryCode` (string, required)
    ISO 3166-1 Alpha-2 country code of the payout destination.

  - `instruction.expandableKeyValuePairs` (object,null)
    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.

  - `instruction.channel` (string,null)
    Preferable channel for the payout. Multiple values can be added with a comma-separator, to indicate order of preference.
    Enum: "ACH SD", "ACH ND", "WIRE", "DOM WIRE", "INSTANT", "Algorand", "Arbitrum", "Avalanche", "Ethereum", "Polygon", "Solana", "Stellar", "Tron", "PAYPAL"

  - `instruction.quoteId` (string,null)
    ID of the FX quote 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".

  - `instruction.scheduleDate` (string,null)
    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.

  - `instruction.source` (object)

  - `instruction.source.accountNumber` (string,null)
    Use this to pay your sellers from your own account. A typical use case is a credit note to your seller. The account number must sit within your entity.

  - `instruction.beneficiaryBankDetails` (object)
    The bank details of the beneficiary. {% admonition type="info" name="Note" %} View our [bank coverage guide](/products/marketplaces/coverage/bank) for country specific requirements.{% /admonition %}

  - `instruction.beneficiaryBankDetails.iban` (string,null)
    Beneficiary IBAN. You must either provide iban or accountNumber.

  - `instruction.beneficiaryBankDetails.branchCode` (string,null)
    Beneficiary account branch code.

  - `instruction.beneficiaryBankDetails.bankCode` (string,null)
    Beneficiary account bank code.

  - `instruction.beneficiaryBankDetails.swiftBic` (string,null)
    Beneficiary bank account SWIFT/BIC.

  - `instruction.beneficiaryBankDetails.bankName` (string,null)
    Beneficiary bank name.

  - `instruction.beneficiaryBankDetails.accountType` (string,null)
    Type of the account.
    Enum: "checking", "savings", "moneyMarket", "certificateOfDeposit", "vista", "other"

  - `instruction.beneficiaryBankDetails.accountNumber` (string,null)
    Beneficiary bank account number.

  - `instruction.beneficiaryBankDetails.payoutInstrumentId` (string,null)
    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 Parties API.

  - `instruction.beneficiaryBankDetails.payoutInstrumentReference` (string,null)
    Your reference for this payoutInstrument, must be unique within an entity.

  - `instruction.beneficiaryBankDetails.address` (object)

  - `instruction.beneficiaryBankDetails.address.city` (string,null)
    City of the address.

  - `instruction.beneficiaryBankDetails.address.state` (string,null)
    State of the address.

  - `instruction.beneficiaryBankDetails.address.countryCode` (string,null)
    ISO 3166-1 Alpha-2 country code of the address.

  - `instruction.beneficiaryBankDetails.address.address1` (string,null)
    Address line 1.

  - `instruction.beneficiaryBankDetails.address.address2` (string,null)
    Address line 2.

  - `instruction.beneficiaryBankDetails.address.postalCode` (string,null)
    PostalCode of the address.

  - `instruction.value` (object)

  - `instruction.value.sourceCurrency` (string, required)
    Source [currency code](/products/reference/supported-countries-currencies#currency-codes) for the payout (if different to targetCurrency, Foreign Exchange (FX) is applied).

  - `instruction.value.sourceAmount` (number,null)
    Source amount. If targetAmount is not stated, this amount is used. Must be a positive value up to 2 decimal places.  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.

  - `instruction.value.targetCurrency` (string,null)
    Target ISO 4217 alpha-3 currency codes for the payout (if different to sourceCurrency, Foreign Exchange (FX) is applied).

  - `instruction.value.targetAmount` (number,null)
    Target amount. If sourceAmount is not specified, this amount is used. Must be a positive value up to 2 decimal places.  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.

  - `instruction.parties` (array)

  - `instruction.parties.partyId` (string,null)
    Id of the party for the payment request. This field is currently not used.
    Example: "1E016F5E-9D4A-49E7-B44C-A4C8AAE8290D"

  - `instruction.parties.partyType` (string, required)
    Party type
    Enum: "beneficiary", "payer"

  - `instruction.parties.partyReference` (string,null)
    Your reference for this party, must be unique within an entity. Allowed values a-z, A-Z, 0-9, spaces and hyphens. Only supply either partyReference or personalDetails.

  - `instruction.parties.customerReference` (string,null)
    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.

  - `instruction.parties.personalDetails` (object)
    Only supply either partyReference or personalDetails.

  - `instruction.parties.personalDetails.companyName` (string,null)
    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".

  - `instruction.parties.personalDetails.firstName` (string,null)
    First name of the party. Mandatory where type is "person" or "soletrader". See formatting rules.

  - `instruction.parties.personalDetails.middleName` (string,null)
    Middle name of the party (applicable when type is "person" or "soletrader"). See formatting rules.

  - `instruction.parties.personalDetails.lastName` (string,null)
    Last name of the party. Mandatory where type is "person" or "soletrader". See formatting rules.

  - `instruction.parties.personalDetails.dateOfBirth` (string,null)
    Date of birth.
    Example: "2024-01-01"

  - `instruction.parties.personalDetails.email` (string,null)
    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.

  - `instruction.parties.personalDetails.title` (string,null)
    Title for the person. Only supply when type is "person" or "sole trader".
    Enum: "mr", "miss", "mrs", "ms", "mx", "dr", "misc"

  - `instruction.parties.personalDetails.type` (string,null)
    Entity description of the party, type is required when partyType is beneficiary
    Enum: "company", "person", "institution", "government", "soletrader", "other"

  - `instruction.parties.personalDetails.phones` (array,null)

  - `instruction.parties.personalDetails.phones.number` (string,null)
    Phone number of the party. Mandatory if you have provided prefix. Special characters are restricted.

  - `instruction.parties.personalDetails.phones.prefix` (string,null)
    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\"

  - `instruction.parties.personalDetails.identityDocuments` (array,null)

  - `instruction.parties.personalDetails.identityDocuments.issuingInstitution` (string,null)
    Issuing institution that provided identification type. Cannot be provided if the conditional fields in the identity section are missing.

  - `instruction.parties.personalDetails.identityDocuments.issuingCountry` (string)
    ISO 3166-1 Alpha-2 country code of identification type origin. Mandatory if identityDocuments.type/identityDocuments.number is populated.

  - `instruction.parties.personalDetails.identityDocuments.type` (string,null)
    Type of identification. Mandatory if identityDocuments.number is populated.
    Enum: "passport", "taxId", "nationalInsurance", "driverLicence", "companyVatNumber", "citizenshipCard", "nationalId", "workPermit", "employmentPass", "studentPass", "permanentResidentCard", "companyRegistrationNumber", "other"

  - `instruction.parties.personalDetails.identityDocuments.validFrom` (string,null)
    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.

  - `instruction.parties.personalDetails.identityDocuments.validTo` (string,null)
    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.

  - `instruction.parties.personalDetails.identityDocuments.number` (string, required)
    Identification number that is presented in the identification type. Mandatory if identityDocuments.type is populated.

  - `instruction.parties.personalDetails.dateOfIncorporation` (string,null)
    Date of the Incorporation of the Company. Not allowed if for a person or sole trader.
    Example: "2024-01-01"

  - `instruction.narrative` (object)

  - `instruction.narrative.line1` (string,null)
    Reference that may appear on beneficiary statements.

  - `instruction.purposeOfPayment` (object)

  - `instruction.purposeOfPayment.code` (string, required)
    The code that represents the purpose of the payout. This is mandatory for some payout routes - please check "Purpose of Payment codes".

  - `instruction.purposeOfPayment.description` (string, required)
    Description for purpose of payout.

  - `instruction.transactionType` (string,null)
    Type of transaction. This is mandatory for some payout routes - please check country specific requirements.
    Enum: "customerToCustomer", "businessToBusiness", "government", "reversal", "return", "customerToBusiness", "businessToCustomer"

  - `instruction.beneficiaryWalletDetails` (object)

  - `instruction.beneficiaryWalletDetails.walletIdentifierType` (string)
    Enum: "walletId", "email", "phoneNumber"

  - `instruction.beneficiaryWalletDetails.walletIdentifier` (string,null)
    Beneficiary wallet identifier.

  - `transactionReference` (string, required)
    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. Special characters are allowed.

  - `notificationUrl` (string,null)
    Currently not in use.

## Response 200 fields (application/json):

  - `payoutRequestId` (string)
    Payout Request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters.

  - `idempotencyKey` (any)
    Unique reference from the request header of the same name.

  - `entity` (string)
    Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.

## Response 202 fields (application/json):

  - `payoutRequestId` (string)
    Payout Request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters.

  - `idempotencyKey` (any)
    Unique reference from the request header of the same name.

  - `entity` (string)
    Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.

## Response 400 fields (application/json):

  - `errorName` (string,null)

  - `message` (string,null)

  - `validationErrors` (array,null)

  - `validationErrors.jsonPath` (string,null)

## Response 401 fields (application/json):

  - `errorName` (string,null)

  - `message` (string,null)

  - `validationErrors` (array,null)

  - `validationErrors.jsonPath` (string,null)

## Response 403 fields (application/json):

  - `errorName` (string,null)

  - `message` (string,null)

  - `validationErrors` (array,null)

  - `validationErrors.jsonPath` (string,null)

## Response 500 fields (application/json):

  - `errorName` (string,null)

  - `message` (string,null)

  - `validationErrors` (array,null)

  - `validationErrors.jsonPath` (string,null)