platformshostedonboardingpage

type ErrorFieldType struct {
	// The validation error code.
	ErrorCode int32 `json:"errorCode,omitempty"`
	// A description of the validation error.
	ErrorDescription string     `json:"errorDescription,omitempty"`
	FieldType        *FieldType `json:"fieldType,omitempty"`
}

type FieldType struct {
	// The full name of the property.
	Field string `json:"field,omitempty"`
	// The type of the field.
	FieldName string `json:"fieldName,omitempty"`
	// The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
	ShareholderCode string `json:"shareholderCode,omitempty"`
}

type GetOnboardingUrlRequest struct {
	// The account holder code you provided when you created the account holder.
	AccountHolderCode string `json:"accountHolderCode"`
	// The platform name which will show up in the welcome page.
	PlatformName string `json:"platformName,omitempty"`
	// The URL where the sub-merchant will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the sub-merchant will be redirected back to the default return URL configured in your platform account.
	ReturnUrl string `json:"returnUrl,omitempty"`
}

type GetOnboardingUrlResponse struct {
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The reference of a request.  Can be used to uniquely identify the request.
	PspReference string `json:"pspReference"`
	// The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 15 seconds and can only be used once.
	RedirectUrl string `json:"redirectUrl,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
	// Indicates whether the request is processed synchronously or asynchronously.  Depending on the request's platform settings, the following scenarios may be applied: * **sync:** The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable. * **async:** The request is queued and will be executed when the providing service is available in the order in which the requests are received. * **asyncOnError:** The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.
	SubmittedAsync bool `json:"submittedAsync"`
}

type PlatformsHostedOnboardingPage common.Service