GET/api/v2/referrals/credits

GET /api/v2/referrals/credits

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
status (query)stringNo
page (query)unknownNo
pageSize (query)unknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
UserIdunknownYes
UserEmailstringYes
DestinationstringYes
AmountunknownYes
CurrencystringYes
StatusstringYes
AttemptsunknownYes
LastErrorstringYes
NextAttemptAtstring (date-time)Yes
ProviderReferencestringYes
ProviderConfirmedAtstring (date-time)Yes
CreatedAtstring (date-time)Yes
UpdatedAtstring (date-time)Yes
RewardIdsarray of string (uuid)Yes

Example request

curl -X GET "https://{base_url}/api/v2/referrals/credits" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.