Incentive Code Issuance API Methods

Get Issuances for an Incentive Code

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

Response

An array of all issuances for the given code.

Issue an Incentive Code

POST /companies/:id/incentives/pools/:pool_id/issuances
{
  "external_issuee_id": "312",
  "code": "aabb-ccdd",
  "referring_application": "system",
  "referring_application_ref_id" : "1234"
}

Request Elements

Data Element	Required	Description
external_issuee_id	No	Unique external issuee ID.
code	No	If provided, a specific code is issued.
referring_application	Only in pools requiring a campaign_registration.	Application issuing the code.
referring_application_ref_id	Only in pools requiring a campaign_registration.	Application reference ID.

Response

It returns an issuance entity if there was an available code.

An HTTP error code 422 is returned if there are not enough available codes to issue.

Code Issuance

The same code is issued when using the same issuee_id. An issuance entity is created after each successful issuance request.