A User referral object represents a referral relationship between two Customers .

The Sender is the user who gives their referral code to others for signing up. The Recipient is the user who entered that code to sign up.

There are two statuses for a user referral: claimed and redeemed. The claimed status represents when the recipient has entered 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 of the referral. Theredeemed status represents 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 referral credit is given when the recipient customers is created. This means that the claim and redeem of user referral happen simultaneously. For the add_balance redemption event, credits are given 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`