Close an account holder

v1.0.0

Changes the to Closed. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a Closed , the payments are sent to your liable account.

Input

{
  "type": "object",
  "required": [
    "accountHolderCode"
  ],
  "properties": {
    "accountHolderCode": {
      "type": "string",
      "description": "The code of the Account Holder to be closed."
    }
  }
}

Output

{
  "type": "object",
  "properties": {
    "accountHolderStatus": {
      "type": "object",
      "description": "The new status of the Account Holder.",
      "required": [
        "status"
      ],
      "properties": {
        "events": {
          "type": "array",
          "description": "A list of events scheduled for the account holder.",
          "items": {
            "type": "object",
            "properties": {
              "event": {
                "type": "string",
                "description": "The event.\n>Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.\nFor more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).",
                "enum": [
                  "InactivateAccount",
                  "RefundNotPaidOutTransfers"
                ]
              },
              "executionDate": {
                "type": "string",
                "format": "date-time",
                "description": "The date on which the event will take place."
              },
              "reason": {
                "type": "string",
                "description": "The reason why this event has been created."
              }
            }
          }
        },
        "payoutState": {
          "type": "object",
          "description": "The payout state of the account holder.",
          "properties": {
            "allowPayout": {
              "type": "boolean",
              "description": "Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts."
            },
            "disableReason": {
              "type": "string",
              "description": "The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why."
            },
            "disabled": {
              "type": "boolean",
              "description": "Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, `allowPayout` will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, `allowPayout` may or may not be enabled, depending on other factors."
            },
            "notAllowedReason": {
              "type": "string",
              "description": "The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen."
            },
            "payoutLimit": {
              "type": "object",
              "description": "The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.",
              "required": [
                "currency",
                "value"
              ],
              "properties": {
                "currency": {
                  "type": "string",
                  "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)."
                },
                "value": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes)."
                }
              }
            },
            "tierNumber": {
              "type": "integer",
              "format": "int32",
              "description": "The payout tier that the account holder occupies."
            }
          }
        },
        "processingState": {
          "type": "object",
          "description": "The processing state of the account holder.",
          "properties": {
            "disableReason": {
              "type": "string",
              "description": "The reason why processing has been disabled."
            },
            "disabled": {
              "type": "boolean",
              "description": "Indicates whether the processing of payments is allowed."
            },
            "processedFrom": {
              "type": "object",
              "description": "The lower bound of the processing tier (i.e., an account holder must have processed at least this amount of money in order to be placed into this tier).",
              "required": [
                "currency",
                "value"
              ],
              "properties": {
                "currency": {
                  "type": "string",
                  "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)."
                },
                "value": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes)."
                }
              }
            },
            "processedTo": {
              "type": "object",
              "description": "The upper bound of the processing tier (i.e., an account holder must have processed less than this amount of money in order to be placed into this tier).",
              "required": [
                "currency",
                "value"
              ],
              "properties": {
                "currency": {
                  "type": "string",
                  "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes)."
                },
                "value": {
                  "type": "integer",
                  "format": "int64",
                  "description": "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes)."
                }
              }
            },
            "tierNumber": {
              "type": "integer",
              "format": "int32",
              "description": "The processing tier that the account holder occupies."
            }
          }
        },
        "status": {
          "type": "string",
          "description": "The status of the account holder.\n>Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.",
          "enum": [
            "Active",
            "Closed",
            "Inactive",
            "Suspended"
          ]
        },
        "statusReason": {
          "type": "string",
          "description": "The reason why the status was assigned to the account holder."
        }
      }
    },
    "invalidFields": {
      "type": "array",
      "description": "Contains field validation errors that would prevent requests from being processed.",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32",
            "description": "The validation error code."
          },
          "errorDescription": {
            "type": "string",
            "description": "A description of the validation error."
          },
          "fieldType": {
            "type": "object",
            "description": "The type of error field.",
            "properties": {
              "field": {
                "type": "string",
                "description": "The full name of the property."
              },
              "fieldName": {
                "type": "string",
                "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",
                  "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"
                ]
              },
              "shareholderCode": {
                "type": "string",
                "description": "The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder."
              }
            }
          }
        }
      }
    },
    "pspReference": {
      "type": "string",
      "description": "The reference of a request. Can be used to uniquely identify the request."
    },
    "resultCode": {
      "type": "string",
      "description": "The result code."
    }
  }
}