Adyen payoutAccountHolder API

openapi: 3.2.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Fund Payout Account Holder API
  description: This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead. The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.
  x-timestamp: '2023-05-30T15:27:19Z'
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Fund/v6
tags:
- name: payoutAccountHolder
paths:
  /payoutAccountHolder:
    post:
      tags:
      - payoutAccountHolder
      summary: Adyen Pay Out from an Account to the Account Holder
      description: Pays out a specified amount from an account to the bank account of account holder.
      operationId: post-payoutAccountHolder
      x-groupName: General
      x-sortIndex: 3
      x-methodName: payoutAccountHolder
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              oneOff:
                $ref: '#/components/examples/post-payoutAccountHolder-oneOff'
            schema:
              $ref: '#/components/schemas/PayoutAccountHolderRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutAccountHolderResponse'
              examples:
                post-payoutAccountHolder200Example:
                  summary: Default post-payoutAccountHolder 200 response
                  x-microcks-default: true
                  value:
                    bankAccountUUID: '500123'
                    invalidFields:
                    - example_value
                    merchantReference: REF-001
                    payoutSpeed: STANDARD
                    pspReference: REF-001
                    resultCode: CODE123
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutAccountHolderResponse'
              examples:
                post-payoutAccountHolder202Example:
                  summary: Default post-payoutAccountHolder 202 response
                  x-microcks-default: true
                  value:
                    bankAccountUUID: '500123'
                    invalidFields:
                    - example_value
                    merchantReference: REF-001
                    payoutSpeed: STANDARD
                    pspReference: REF-001
                    resultCode: CODE123
          description: Accepted - the request has been accepted for processing, but the processing has not been completed.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-payoutAccountHolder400Example:
                  summary: Default post-payoutAccountHolder 400 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-payoutAccountHolder401Example:
                  summary: Default post-payoutAccountHolder 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-payoutAccountHolder403Example:
                  summary: Default post-payoutAccountHolder 403 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-payoutAccountHolder422Example:
                  summary: Default post-payoutAccountHolder 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-payoutAccountHolder500Example:
                  summary: Default post-payoutAccountHolder 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    PayoutAccountHolderRequest:
      properties:
        accountCode:
          description: The code of the account from which the payout is to be made.
          type: string
        accountHolderCode:
          description: 'The code of the Account Holder who owns the account from which the payout is to be made.

            The Account Holder is the party to which the payout will be made.'
          type: string
        amount:
          description: 'An object containing the currency and value of the payout.

            If the account has multiple currencies, specify the currency to be used.

            If the `bankAccountUUID` is provided in the request, the currency supported by the bank is used.

            If the `payoutMethodCode` is provided in the request, the specified payout method is selected.'
          $ref: '#/components/schemas/Amount'
        bankAccountUUID:
          description: 'The unique ID of the Bank Account held by the Account Holder to which the payout is to be made.

            If left blank, a bank account is automatically selected.'
          type: string
        description:
          description: 'A description of the payout. Maximum 200 characters.

            Allowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,''+ ";**'
          maxLength: 200
          type: string
        merchantReference:
          x-addedInVersion: '2'
          description: A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
          type: string
        payoutMethodCode:
          x-addedInVersion: '5'
          description: 'The unique ID of the payout method held by the Account Holder to which the payout is to be made.

            If left blank, a payout instrument is automatically selected.'
          type: string
        payoutSpeed:
          x-addedInVersion: '5'
          default: STANDARD
          description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.'
          enum:
          - INSTANT
          - SAME_DAY
          - STANDARD
          type: string
      required:
      - accountHolderCode
      - accountCode
      type: object
    FieldType:
      properties:
        field:
          description: The full name of the property.
          type: string
        fieldName:
          description: The type of the field.
          enum:
          - accountCode
          - accountHolderCode
          - accountHolderDetails
          - accountNumber
          - accountStateType
          - accountStatus
          - accountType
          - address
          - balanceAccount
          - balanceAccountActive
          - balanceAccountCode
          - balanceAccountId
          - bankAccount
          - bankAccountCode
          - bankAccountName
          - bankAccountUUID
          - bankBicSwift
          - bankCity
          - bankCode
          - bankName
          - bankStatement
          - branchCode
          - businessContact
          - cardToken
          - checkCode
          - city
          - companyRegistration
          - constitutionalDocument
          - controller
          - country
          - countryCode
          - currency
          - currencyCode
          - dateOfBirth
          - description
          - destinationAccountCode
          - document
          - documentContent
          - documentExpirationDate
          - documentIssuerCountry
          - documentIssuerState
          - documentName
          - documentNumber
          - documentType
          - doingBusinessAs
          - drivingLicence
          - drivingLicenceBack
          - drivingLicenceFront
          - drivingLicense
          - email
          - firstName
          - formType
          - fullPhoneNumber
          - gender
          - hopWebserviceUser
          - houseNumberOrName
          - iban
          - idCard
          - idCardBack
          - idCardFront
          - idNumber
          - identityDocument
          - individualDetails
          - infix
          - jobTitle
          - lastName
          - lastReviewDate
          - legalArrangement
          - legalArrangementCode
          - legalArrangementEntity
          - legalArrangementEntityCode
          - legalArrangementLegalForm
          - legalArrangementMember
          - legalArrangementMembers
          - legalArrangementName
          - legalArrangementReference
          - legalArrangementRegistrationNumber
          - legalArrangementTaxNumber
          - legalArrangementType
          - legalBusinessName
          - legalEntity
          - legalEntityType
          - logo
          - merchantAccount
          - merchantCategoryCode
          - merchantHouseNumber
          - merchantReference
          - microDeposit
          - name
          - nationality
          - originalReference
          - ownerCity
          - ownerCountryCode
          - ownerDateOfBirth
          - ownerHouseNumberOrName
          - ownerName
          - ownerPostalCode
          - ownerState
          - ownerStreet
          - passport
          - passportNumber
          - payoutMethod
          - payoutMethodCode
          - payoutSchedule
          - pciSelfAssessment
          - personalData
          - phoneCountryCode
          - phoneNumber
          - postalCode
          - primaryCurrency
          - reason
          - registrationNumber
          - returnUrl
          - schedule
          - shareholder
          - shareholderCode
          - shareholderCodeAndSignatoryCode
          - shareholderCodeOrSignatoryCode
          - shareholderType
          - shareholderTypes
          - shopperInteraction
          - signatory
          - signatoryCode
          - socialSecurityNumber
          - sourceAccountCode
          - splitAccount
          - splitConfigurationUUID
          - splitCurrency
          - splitValue
          - splits
          - stateOrProvince
          - status
          - stockExchange
          - stockNumber
          - stockTicker
          - store
          - storeDetail
          - storeName
          - storeReference
          - street
          - taxId
          - tier
          - tierNumber
          - transferCode
          - ultimateParentCompany
          - ultimateParentCompanyAddressDetails
          - ultimateParentCompanyAddressDetailsCountry
          - ultimateParentCompanyBusinessDetails
          - ultimateParentCompanyBusinessDetailsLegalBusinessName
          - ultimateParentCompanyBusinessDetailsRegistrationNumber
          - ultimateParentCompanyCode
          - ultimateParentCompanyStockExchange
          - ultimateParentCompanyStockNumber
          - ultimateParentCompanyStockNumberOrStockTicker
          - ultimateParentCompanyStockTicker
          - unknown
          - value
          - verificationType
          - virtualAccount
          - visaNumber
          - webAddress
          - year
          type: string
        shareholderCode:
          description: The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
          type: string
      type: object
    ErrorFieldType:
      properties:
        errorCode:
          description: The validation error code.
          format: int32
          type: integer
        errorDescription:
          description: A description of the validation error.
          type: string
        fieldType:
          description: The type of error field.
          $ref: '#/components/schemas/FieldType'
      type: object
    ServiceError:
      properties:
        errorCode:
          description: The error code mapped to the error message.
          type: string
        errorType:
          description: The category of the error.
          type: string
        message:
          description: A short explanation of the issue.
          type: string
        pspReference:
          description: The PSP reference of the payment.
          type: string
        status:
          description: The HTTP response status.
          format: int32
          type: integer
      type: object
    PayoutAccountHolderResponse:
      properties:
        bankAccountUUID:
          description: The unique ID of the Bank Account to which the payout was made.
          type: string
        invalidFields:
          x-addedInVersion: '5'
          description: Contains field validation errors that would prevent requests from being processed.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        merchantReference:
          x-addedInVersion: '2'
          description: The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.
          type: string
        payoutSpeed:
          x-addedInVersion: '5'
          default: STANDARD
          description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.'
          enum:
          - INSTANT
          - SAME_DAY
          - STANDARD
          type: string
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
      type: object
    Amount:
      properties:
        currency:
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
          maxLength: 3
          minLength: 3
          type: string
        value:
          description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          format: int64
          type: integer
      required:
      - value
      - currency
      type: object
  examples:
    post-payoutAccountHolder-oneOff:
      summary: One-off payout
      value:
        accountCode: '118731451'
        amount:
          currency: EUR
          value: 99792
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
        description: 12345 – Test
        bankAccountUUID: 000b81aa-ae7e-4492-aa7e-72b2129dce0c
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http
x-groups:
- General
- Migration