referral_customer_event_preview_complete

Name

Type

Description

total_award_amountNumberThe total amount that will be awarded for that referral customer event in system currency
total_award_alternative_amountNumber

The total amount that will be awarded for that referral customer event in alternative currency and only if the awarded amount will be in alternative currency

rewards_participant_id

String

The ID of the referral customer event's rewards participant

rewards_participant_nameString

The full name of the retrieved rewards participant

wallet_balanceNumber

The current wallet balance of the customer in wallet currency

wallet_alternative_balanceNumber

The current wallet balance of the customer in wallet alternative

voucher_types_setSet of Voucher Types Objects

The set of type of the voucher that will be awarded instantly if such a referral customer event is performed

 

Referred Objects Response Data

 voucher_type response data object
NameType Description
IdStringThe ID of the retrieved voucher type
nameStringThe Name of the retrieved voucher type
alternative_codeStringThe Alternative Code of the retrieved voucher type
value_optionsString

Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE

From CRM.COM R13.1.0 and onwards for voucher types of classification equal to "Electronic Voucher" the supported option is VARIABLE

From CRM.COM R14.0.0 and onwards for voucher types of classification equal to "Refund Voucher" the supported option is VARIABLE

classificationString

The Classification of the retrieved voucher type

Available from CRM.COM R13.1.0

descriptionStringThe Description of the retrieved voucher type