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

« Previous Version 4 Next »


Show an Incentive Code

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

Redeem an Incentive Code

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

Request body


  "external_issuee_id": "312",
  "issuee_id": "1234-5678",
  "referring_application": "splat",
  "referring_application_ref_id" : "1234"  

Request Elements

Data Element


NoUnique external issuee id.
issuee_idNoVibes generated issuee_id


NoApplication issuing the code.


NoApplication reference id.


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.

Code Redemption

A code can only be redeemed once using the same issuee_id/external_issuee_id - code combination.

A code can be redeemed multiple times using different issuee_id when using a 'multi' pool.

  • No labels