This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk-igaming / Referral

Referral ​

A referral from the history (GET /referrals/history). Referee data: the email only comes out masked and the gateway's referee_id is not exposed.

Properties ​

code ​

code: string

Referral code used.


completedAt ​

completedAt: string | null

When it was completed (ISO 8601, UTC); null while not completed.


createdAt ​

createdAt: string | null

When the referral was created (ISO 8601, UTC); null if the gateway does not send it.


expiresAt ​

expiresAt: string | null

When it expires (ISO 8601, UTC); null when it does not expire or the gateway does not send it.


id ​

id: string

Referral id.


refereeBonus ​

refereeBonus: number

Referee's bonus, in minor units.


refereeEmailMasked ​

refereeEmailMasked: string | null

Referee's masked email: first character of the local part and one * per remaining character, whole domain (ana@exemplo.com → a**@exemplo.com; a 1-character local part becomes *). null when the gateway sends empty or something that is not an email. The raw email is never exposed.


refereeName ​

refereeName: string | null

Referee's name, as the gateway sends it; null when empty. It is personal data: do not log it.


referrerBonus ​

referrerBonus: number

Referrer's bonus, in minor units.


status ​

status: ReferralStatus

Status.