GET
/api/v2/users/{userId}/referrals/rewardsReturns the user's referral reward ledger (welcome, qualification and top-up rewards with delivery stage).
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (path) | integer (int32) | Yes | |
| programId (query) | string (uuid) | No | |
| page (query) | unknown | No | |
| pageSize (query) | unknown | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Id | string (uuid) | Yes | |
| EventType | string | Yes | |
| BeneficiaryRole | string | Yes | |
| LevelCode | string | Yes | |
| BasisAmount | unknown | Yes | |
| BasisCurrency | string | Yes | |
| Amount | unknown | Yes | |
| Currency | string | Yes | |
| DeliveryMode | string | Yes | |
| Status | string | Yes | |
| Stage | string | Yes | |
| CreditId | string (uuid) | Yes | |
| VoucherId | string (uuid) | Yes | |
| FriendAlias | string | Yes | |
| OccurredAt | string (date-time) | Yes | |
| CreatedAt | string (date-time) | Yes | |
| PaidAt | string (date-time) | Yes | |
| Explanation | object | No | |
| Balance | object | No | |
| Holds | array of ReferralRewardHoldResponse | No |
Example request
curl -X GET "https://{base_url}/api/v2/users/{userId}/referrals/rewards" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.