Delete shareholders

v1.0.0

Deletes shareholders associated with an account holder.

Input

{
  "type": "object",
  "required": [
    "accountHolderCode",
    "shareholderCodes"
  ],
  "properties": {
    "accountHolderCode": {
      "type": "string",
      "description": "The code of the Account Holder from which to delete the Shareholders."
    },
    "shareholderCodes": {
      "type": "array",
      "description": "The code(s) of the Shareholders to be deleted.",
      "items": {
        "type": "string"
      }
    }
  }
}

Output

{
  "type": "object",
  "properties": {
    "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."
    }
  }
}