SfServicersAuthRequest

API version of ServicersAuthRequest

Required Fields

servicerId

string, min 1 characters

The unique identifier of the servicer to integrate with.

landingPageType

string, min 1 characters

Enum: “signup” “login” The initial integration page to display. This may be ignored, depending on the integration.

Optional Fields

successRedirectUri

string, nullable

An optional field specifing the URI that the browser will be redirected to at the end of the OAuth flow. If not specified, the browser will be redirected to the Payments Acceptance Service marketplace UI.

failureRedirectUri

string, nullable

An optional field that the browser will be redirect to at the end of the OAuth flow. If a success redirect URI is included but no failure URI, the browser will be redirected to the success URI in case of errors. A failureReason query parameters will be included in case of errors; see above for possible values. Including a failure URI but no success URI will generate a 400 error.