Implemented by

Fields

code : String

The referral code.
combinedPaymentAmount : Int

The payment amount in the smallest unit of the clients currency received by the referrer and the referee combined.
ledgerId : Int

The ID of the ledger which the referral is assigned to.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The number of the ledger which the referral is assigned to.
paymentDate : Date

The date when the payment was made.
paymentStatus : String

The status of the payment.
referredUserJoinDate : DateTime

The date the referred user joined.
referredUserName : String

The name of the referred user.
referredUserPaymentAmount : Int

Payment amount given to the referred account in the smallest unit of the client's currency.
referringUserPaymentAmount : Int

Payment amount given to the referring account in the clients fractional currency unit.
schemeType : ReferralSchemeTypeChoices

The type of reward scheme.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "code": "sea-customer-home-food-important", "combinedPaymentAmount": 17, "ledgerNumber": "offer-analysis-spring-prepare-finish", "paymentDate": "1986-12-01", "paymentStatus": "good-foot-security-may-moment", "referredUserJoinDate": "1978-06-08T18:21:36.408475+00:00", "referredUserName": "trial-for-foreign-attention-woman", "referredUserPaymentAmount": 62, "referringUserPaymentAmount": 59, "schemeType": "REFERRAL_REWARD" }