Adyen · Schema

GetOnboardingUrlResponse

GetOnboardingUrlResponse schema from Adyen API

PaymentsFinancial ServicesFintech

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

hosted-onboarding-get-onboarding-url-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/hosted-onboarding-get-onboarding-url-response-schema.json",
  "title": "GetOnboardingUrlResponse",
  "description": "GetOnboardingUrlResponse schema from Adyen API",
  "type": "object",
  "properties": {
    "invalidFields": {
      "x-addedInVersion": "5",
      "description": "Information about any invalid fields.",
      "items": {
        "$ref": "#/components/schemas/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"
    }
  }
}