Skip to main content

Aksal Black Tier

This endpoint allows Aksal to retrieve the discount tier associated with an Aksal Black card number.

Authentication

  • Uses signature authentication
HeaderDescription
X-SIGNATUREThe signature header of the request

See 2-security.md for signature generation details.

Endpoint

GET /api/v1/partner/aksal/black-card/<card_number>/tier
ParameterTypeDescription
card_numberstringThe Aksal Black card number

Sample Request

GET https://app.kenzup.com/api/v1/partner/aksal/black-card/AKSAL-BLACK-0001/tier

Response

Status Code: 200

{
"discount_pct": 15.00,
"label_fr": "Tier Or",
"label_ar": "الدرجة الذهبية",
"label_en": "Gold Tier",
"description_fr": "Bénéficiez de 15% de réduction sur tous vos achats Aksal.",
"description_ar": "استمتع بخصم 15% على جميع مشترياتك في أكسال.",
"description_en": "Enjoy 15% off on all your Aksal purchases."
}
FieldTypeDescription
discount_pctdecimalDiscount percentage for this tier. Can be null if not yet configured.
label_frstringTier name in French
label_arstringTier name in Arabic
label_enstringTier name in English
description_frstringTier description in French. Can be null.
description_arstringTier description in Arabic. Can be null.
description_enstringTier description in English. Can be null.

Status Code: 404

Returned when the card number is not found, the customer is not enrolled in Aksal Black, or no tier has been assigned yet.

{
"detail": "No tier assigned for this card."
}

Status Code: 403

Returned when the signature is invalid or the client_id is not authorized.