Referrals

Get redemption status

Get the current status of a referral redemption. Use this endpoint to poll until the status is completed or failed.

get/v1/referral-redemptions/{redemptionId}

Request

  • Base URL
    https://api.apply.akahu.nz
  • URL
    https://api.apply.akahu.nz/v1/referral-redemptions/{redemptionId}
  • Auth
    HTTP bearer

Path parameters

redemptionIdstring required
Example:referral_redemption_tz4a98xxat96iws9zmbrgj3a

Response

Success

OR
OR

Example response

{
  "_id": "referral_redemption_tz4a98xxat96iws9zmbrgj3a"
}

Changes

No recorded changes to this operation across all 1 revision of this API.