Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Contents

Get Redemptions for an Incentive Code

 

GET /companies/:id/incentives/codes/:code/redemptions

 

Response

An array of all redemptions for the given code.

Redeem an Incentive Code

POST /companies/:id/incentives/codes/:code/redemptions

Request body

{
  "external_issuee_id": "312",
  "issuee_id": "1234-5678",
  "referring_application": "system",
  "referring_application_ref_id" : "1234"  
}

 

Request Elements

Data Element
Required
Description

external_issuee_id

NoUnique external issuee id.
issuee_idNoVibes generated issuee_id

referring_application

NoApplication issuing the code.

referring_application_ref_id

NoApplication reference id.

Response

It returns a redemption entity if the code was successfully redeemed.

An HTTP error code 422 is returned in the following cases:

  • When using an invalid issuee_id or external_issuee_id
  • When using a 'unique' pool type and the code has already been redeemed.
  • No labels