SfServicerResponse

API version of Servicer

Methods

The following API methods use this data model.

• Retrieve Available Servicers

  Optional Fields

  servicerId

string, nullable

The unique identifier for servicer.

name

string, nullable

Name of the servicer organisation.

dashboardUrl

string, nullable

URL for the dashboard of the servicer.

capabilities

string[], nullable

Items Enum: “card” “direct-debit” An array of payment types supported by the provider in the companys country.

accountLinkingSupported

boolean, nullable

Whether this provider supports an OAuth style flow for linking accounts.

accountCreationSupported

boolean, nullable

Whether this provider supports direct creation of an account without user intervention.

paymentInstrumentsSupported

boolean, nullable

Boolean field indicating whether the servicer supports reusable payment instruments (for example, card tokens and direct debit mandates).

rank

int32, nullable

An integer >= 0 indicating the ordering of the provider. Lower numbers mean a higher priority.

operatingCountries

string[], nullable

Countries where this Servicer operates.

oauthType

string, nullable

Enum: “AUTH_CODE” “CLIENT_REFERRAL” Represents an oauth type

apiEndpoint

string, nullable

Endpoint for the given connector API.