Bingex.User.ReferralInfo (Bingex v0.1.7)
Represents referral information for a user in BingX.
This module defines the structure and type for user referral data, providing a function to decode API responses into a structured format.
Summary
Types
@type t() :: %Bingex.User.ReferralInfo{ balance: float(), benefit_expiration: integer(), benefit_ratio: integer(), current_benefit: integer(), deposit?: boolean(), direct_referral?: boolean(), fee_ratio: integer(), has_trades?: boolean(), invite_code: binary(), invite_result: boolean(), inviter_sid: binary(), own_invite_code: binary(), registration_date: integer(), uid: binary(), user_level: binary(), verified_kyc?: boolean() }
Referral information for a user.
Fields:
balance
- The total balance associated with the referral.benefit_expiration
- The expiration timestamp of referral benefits.benefit_ratio
- The benefit percentage received from the referral.fee_ratio
- The commission fee ratio for the referral.current_benefit
- The currently available benefit amount.deposit?
- Indicates if the referred user has made a deposit.direct_referral?
- Indicates if the referral is a direct invitation.invite_code
- The invite code used for the referral.invite_result
- Whether the invitation was successful.inviter_sid
- The session ID of the inviter.verified_kyc?
- Whether the referred user has completed KYC verification.own_invite_code
- The referral’s own invite code.registration_date
- The timestamp of the referral’s registration.has_trades?
- Whether the referred user has executed any trades.uid
- The unique identifier of the referred user.user_level
- The current user level of the referral.