Adyen Delete Legal Arrangements API

openapi: 3.2.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Account Delete Legal Arrangements API
  description: This API is used for the classic integration.
  x-timestamp: '2023-05-30T15:27:20Z'
  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/Account/v6
tags:
- name: deleteLegalArrangements
paths:
  /deleteLegalArrangements:
    post:
      tags:
      - deleteLegalArrangements
      summary: Adyen Delete Legal Arrangements
      description: Deletes legal arrangements and/or legal arrangement entities associated with an account holder.
      operationId: post-deleteLegalArrangements
      x-groupName: Verification
      x-sortIndex: 6
      x-methodName: deleteLegalArrangements
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              arrangements:
                $ref: '#/components/examples/post-deleteLegalArrangements-arrangements'
              entities:
                $ref: '#/components/examples/post-deleteLegalArrangements-entities'
            schema:
              $ref: '#/components/schemas/DeleteLegalArrangementRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                arrangements:
                  $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-200'
                entities:
                  $ref: '#/components/examples/post-deleteLegalArrangements-entities-200'
              schema:
                $ref: '#/components/schemas/GenericResponse'
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              examples:
                post-deleteLegalArrangements202Example:
                  summary: Default post-deleteLegalArrangements 202 response
                  x-microcks-default: true
                  value:
                    invalidFields:
                    - example_value
                    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:
              examples:
                arrangements:
                  $ref: '#/components/examples/post-deleteLegalArrangements-arrangements-400'
                entities:
                  $ref: '#/components/examples/post-deleteLegalArrangements-entities-400'
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-deleteLegalArrangements401Example:
                  summary: Default post-deleteLegalArrangements 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:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-deleteLegalArrangements422Example:
                  summary: Default post-deleteLegalArrangements 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-deleteLegalArrangements500Example:
                  summary: Default post-deleteLegalArrangements 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:
  examples:
    post-deleteLegalArrangements-entities:
      summary: Delete legal arrangement entities
      description: Example request for deleting legal arrangement entities
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
        legalArrangements:
        - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c
          legalArrangementEntityCodes:
          - 755881d3-d6b0-4b34-8ace-1caceb8add63
    post-deleteLegalArrangements-arrangements-200:
      summary: Legal arrangement deleted
      value:
        invalidFields: []
        pspReference: '8816080397613514'
    generic-403:
      summary: Response code 401. Forbidden.
      value:
        status: 403
        errorCode: '10_003'
        message: Failed to authorize user
        errorType: security
    post-deleteLegalArrangements-arrangements-400:
      summary: Response code 400. Bad Request.
      value:
        invalidFields:
        - errorCode: 34
          errorDescription: An invalid legalArrangementCode code is provided for value 'cdf92f5a-a114-4ce6-8f19-c3f6ec83141c'
          fieldType:
            field: AccountHolderDetails.LegalArrangements.legalArrangementCode
            fieldName: legalArrangementCode
        pspReference: '9916613322577326'
    post-deleteLegalArrangements-entities-400:
      summary: Response code 400. Bad Request.
      value:
        invalidFields:
        - errorCode: 34
          errorDescription: An invalid legalArrangementEntityCode code is provided for value 'c92bb932-4867-4cef-bf9d-4ecde37745cf'
          fieldType:
            field: AccountHolderDetails.LegalArrangements.LegalArrangementsEntities.legalArrangementEntityCode
            fieldName: legalArrangementEntityCode
        pspReference: '9916613324987358'
    generic-400:
      summary: Response code 400. Bad Request.
      value:
        status: 400
        errorCode: '702'
        message: 'Unexpected input: I'
        errorType: validation
    post-deleteLegalArrangements-entities-200:
      summary: Legal arrangement entities deleted
      value:
        invalidFields: []
        pspReference: '8816080397613514'
    post-deleteLegalArrangements-arrangements:
      summary: Delete legal arrangements
      description: Example request for deleting legal arrangements
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
        legalArrangements:
        - legalArrangementCode: cdf92f5a-a114-4ce6-8f19-c3f6ec83141c
  schemas:
    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
    DeleteLegalArrangementRequest:
      properties:
        accountHolderCode:
          description: The code of the account holder.
          type: string
        legalArrangements:
          description: List of legal arrangements.
          items:
            $ref: '#/components/schemas/LegalArrangementRequest'
          type: array
      required:
      - accountHolderCode
      - legalArrangements
      type: object
    GenericResponse:
      properties:
        invalidFields:
          x-addedInVersion: '5'
          description: Contains field validation errors that would prevent requests from being processed.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        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
    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
    LegalArrangementRequest:
      properties:
        legalArrangementCode:
          description: The code of the legal arrangement to be deleted. If you also send `legalArrangementEntityCodes`, only the entities listed will be deleted.
          type: string
        legalArrangementEntityCodes:
          description: List of legal arrangement entities to be deleted.
          items:
            type: string
          type: array
      required:
      - legalArrangementCode
      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
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http
x-groups:
- Account holders
- Accounts
- Verification