Adyen · Schema

GetOnboardingUrlResponse

PaymentsFinancial ServicesFintechAgentic CommercePoint-of-SalePayment Processing

Properties

Name Type Description
invalidFields array Information about any invalid fields.
pspReference string The reference of a request. Can be used to uniquely identify the request.
redirectUrl string The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 30 seconds and can only be used once.
resultCode string The result code.
View JSON Schema on GitHub

JSON Schema

adyen-get-onboarding-url-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-get-onboarding-url-response-schema.json",
  "title": "GetOnboardingUrlResponse",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adyen-getonboardingurl-api-openapi.yml#/components/schemas/GetOnboardingUrlResponse",
  "properties": {
    "invalidFields": {
      "x-addedInVersion": "5",
      "description": "Information about any invalid fields.",
      "items": {
        "$ref": "#/$defs/ErrorFieldType"
      },
      "type": "array"
    },
    "pspReference": {
      "description": "The reference of a request. Can be used to uniquely identify the request.",
      "type": "string"
    },
    "redirectUrl": {
      "description": "The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 30 seconds and can only be used once.",
      "type": "string"
    },
    "resultCode": {
      "description": "The result code.",
      "type": "string"
    }
  },
  "type": "object",
  "$defs": {
    "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": "#/$defs/FieldType"
        }
      },
      "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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/adyen-get-onboarding-url-response"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.