A User Referral object represents a referral relationship between Customers .
Sender is a user who gives their referral code to others for sign up. Recipient is the user who uses that code to sign up. For instance, if User A shares their code with User B for sign up, User A becomes the sender and User B the recipient.
There are two statuses for a user referral: claimed and redeemed. claimed is when the recipient has used the referral code, but has not yet triggered the redemption event. The redemption event is when the referral credit is given to both the recipient and the sender (if applicable). redeemed is when the redemption event has occurred and the referral credits have been distributed.
There are two types of redemption events that are currently supported: create_user and add_balance. For create_user, the redemption of credit occurs when the recipient user object is created. This means that the claim and redeem of user referral happen simultaneously. For add_balance, credits are redeemed when the recipient adds a balance greater than or equal to the redemptionThresholdAmount.
User Referral Attributes
| Field | Type | Description | Example value |
|---|---|---|---|
id | string | Unique identifier for the user referral. | 2aa3d415-8256-4d0e-97a1-7cd0a09e0230 |
senderId | string | Identifier of the sender customer. | 83ac5214-5c2b-4d41-83a2-ffc58903f392 |
recipientId | string | Identifier of the recipient customer. | |
senderCreditAmount | integer | The credit amount that the sender receives when this user referral is redeemed. The integer amount is in the lowest denomination of the merchant currency code. | 500 (equivalent to $5 USD) |
recipientCreditAmount | integer | The credit amount that the recipient receives when this user referral is redeemed. The integer amount is in the lowest denomination of the merchant currency code. | 500 (equivalent to $5 USD) |
redemptionEvent | string | The redemption event specification. Possible values are: - create_user- add_balance | |
redemptionThresholdAmount | integer | The threshold of amount used for specific redemptionEvent. The integer amount is in the lowest denomination of the merchant currency code. | |
status | string | The user referral status. Possible values are: - claimed- redeemed |