Get Loyalty Configuration

This endpoint provides information such as settings, features and requirements based on the account's configuration.

Field nameTypeDescription
enabledboolIndicates whether a loyalty provider is active for this channel link.
providerNamestringThe display name of the active loyalty provider.
externalSignUpUrlstring | nullSome providers will only support a external sign-up process. The channel can then redirect customers to this URL.
featuresobjectHolds information on the features and requirements for the active loyalty provider.
features.supportsSSOboolIndicates whether the loyalty provider supports SSO.
features.supportsExternalSignUpUrlboolIndicates whether the loyalty provider supports external sign-up url.
features.supportsWalletPointsBalanceboolIndicates whether the loyalty provider supports a point-based earning/spending system.
features.supportsWalletCashBalanceboolIndicates whether the loyalty provider supports a cash-based earning/spending system.
features.supportsBOGOFProgramsboolIndicates whether the loyalty provider supports buy-one-get-one-free programs.
features.supportsFreeItemProgramsboolIndicates whether the loyalty provider supports free item programs.
features.supportsFlatProgramsboolIndicates whether the loyalty provider flat-off-order programs
features.requiresEmailboolIndicates whether the loyalty provider requires this field for creating a user.
features.requiresPhoneNumberboolIndicates whether the loyalty provider requires this field for creating a user.
features.supportsDynamicConfigurationboolIndicates whether the loyalty provider is able to retrieve configuration from the loyalty partner at runtime, such as cashback settings, wallet support for cash/points, etc.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!