Skip to content
/
Retrieve a referral code...

Retrieve a referral code redemption

Request

Retrieve a single anonymised redemption row for one of the caller organisation's codes.

Security
oauth2(Required scopes: referral:read)
Path
redemption_idstringprdm[A-Z\d]{26}required

The ID of the redemption.

Example:prdm01JZQ8V5T7MKXR9NBCDEFGHJ4B
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
Accept-Languagestring

Indicates the natural language and locale that the client prefers.

curl -i -X GET \
  https://developers.ev.energy/_mock/ev.energy-api-v2/referral_code_redemptions/prdm01JZQ8V5T7MKXR9NBCDEFGHJ4B \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a single redemption.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
Bodyapplication/json
idstringprdm[A-Z\d]{26}read-onlyrequired

Unique identifier for the redemption. Never the driver's identifier.

Example:"prdm01JZQ8V5T7MKXR9NBCDEFGHJ4B"
urlstring, (uri)read-onlyrequired
Example:"https://api.ev.energy/v2/referral_code_redemptions/prdm01JZQ8V5T7MKXR9NBCDEFGHJ4B"
referral_codestring, (uri)read-only

Reference to the code that was redeemed.

Example:"https://api.ev.energy/v2/referral_codes/prom01JZQ8V5T7MKXR9NBCDEFGHJ4A"
codestringread-only

The code string, denormalised so a ledger renders without a second read.

Example:"SPRING24"
stagestringread-onlyrequired

REDEEMED — the driver signed up with the code. QUALIFIED — the driver has since completed the qualifying charge, which is what earns commission.

Enum:"REDEEMED""QUALIFIED"
Example:"QUALIFIED"
redeemed_atstring, (date-time)read-only
Example:"2026-07-10T08:30:00Z"
qualified_atstring or null, (date-time)read-only

When the qualifying charge finished. Null while the redemption is still in progress, and also on a QUALIFIED redemption whose qualifying session has no recorded finish time.

Example:"2026-07-18T19:04:00Z"
Response
{
  "id": "prdm01JZQ8V5T7MKXR9NBCDEFGHJ4B",
  "url": "https://api.ev.energy/v2/referral_code_redemptions/prdm01JZQ8V5T7MKXR9NBCDEFGHJ4B",
  "referral_code": "https://api.ev.energy/v2/referral_codes/prom01JZQ8V5T7MKXR9NBCDEFGHJ4A",
  "code": "SPRING24",
  "stage": "QUALIFIED",
  "redeemed_at": "2026-07-10T08:30:00Z",
  "qualified_at": "2026-07-18T19:04:00Z"
}