Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrorFieldType ¶
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"`
}
ErrorFieldType struct for ErrorFieldType
type FieldType ¶
type FieldType struct {
// The full name of the property.
Field string `json:"field,omitempty"`
// The type of the field.
FieldName string `json:"fieldName,omitempty"`
ShareholderCode string `json:"shareholderCode,omitempty"`
}
FieldType struct for FieldType
type GetOnboardingUrlRequest ¶
type GetOnboardingUrlRequest struct {
// The account holder code you provided when you created the account holder.
AccountHolderCode string `json:"accountHolderCode"`
// Indicates if editing checks is allowed even if all the checks have passed.
EditMode bool `json:"editMode,omitempty"`
// 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"`
// The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default. For a list supported languages, refer to [Change the page language](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page#change-page-language).
ShopperLocale string `json:"shopperLocale,omitempty"`
}
GetOnboardingUrlRequest struct for GetOnboardingUrlRequest
type GetOnboardingUrlResponse ¶
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,omitempty"`
// 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.
RedirectUrl string `json:"redirectUrl,omitempty"`
// The result code.
ResultCode string `json:"resultCode,omitempty"`
}
GetOnboardingUrlResponse struct for GetOnboardingUrlResponse
type PlatformsHostedOnboardingPage ¶
PlatformsHostedOnboardingPage PlatformsHostedOnboardingPage service
func (PlatformsHostedOnboardingPage) GetOnboardingUrl ¶
func (a PlatformsHostedOnboardingPage) GetOnboardingUrl(req *GetOnboardingUrlRequest, ctxs ..._context.Context) (GetOnboardingUrlResponse, *_nethttp.Response, error)
PostGetOnboardingUrl Get a link to a Hosted Onboarding Page. Returns a link to a Hosted Onboarding Page (HOP) to be used by a specific account holder. Each account holder represents a single sub-merchant. For more information on how to use HOP, refer to [Hosted Onboarding Page](https://docs.adyen.com/platforms/onboarding-and-verification/hosted-onboarding-page).
- @param request GetOnboardingUrlRequest - reference of GetOnboardingUrlRequest).
- @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return GetOnboardingUrlResponse