Method: offers.redeemOffer

  • External partners call this API to signal user acceptance of offer terms after receiving an activation code from offers.fetchPartnerEligibility.

  • The HTTP request uses a POST method to the specified Google API endpoint.

  • The request body requires the offer type, eSIM EID, device IMEI, and user email address.

  • A successful response body returns the activation code for profile downloading.

This API is called by external partners to signal that the user has accepted the terms of service for the offer. The partner calls this API after offers.fetchPartnerEligibility returns eligible and receives the activation code for the offer.

HTTP request

POST https://fiwholesaleadaptor.googleapis.com/v1/offers:redeemOffer

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "offerType": enum (OfferType),
  "eid": string,
  "imei": string,
  "email": string
}
Fields
offerType

enum (OfferType)

Required. The id of the offer to return with the device eligibility. If there is no matching offer found, a not found error will be returned.
eid

string

Required. The EID of the eSIM on the device used to validate offer eligibility.
imei

string

Required. The device identifier used to validate offer eligibility.
email

string

Required. The email address of the end user.

Response body

Response for OfferService.RedeemOffer.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "activationCode": string
}
Fields
activationCode

string

Profile activation code used to reference the profile in SM-DP+ server for profile downloading. In the case of certain partners, this is a static string in the form of 1$<smdp+FQDN>$.