Adyen · Schema

FieldType

PaymentsFinancial ServicesFintech

Properties

Name Type Description
field string The full name of the property.
fieldName string The type of the field.
shareholderCode string The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
View JSON Schema on GitHub

JSON Schema

adyen-fieldtype-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FieldType",
  "title": "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"
}