ApplicationModeError
errorCodehttpStatusapplicationIdstatusBalanceNotFoundError
errorCodehttpStatuspersonalCodestatusCashBackRedemptionSettingsResponse
expirationminimumRedemptionAmountMontant minimal de cashback (dans la devise applicable) qu'un utilisateur doit accumuler avant qu'une rédemption soit autorisee. Les demandes sous ce seuil sont rejetees.
earningCapsMontant total maximal de cashback (dans la devise applicable) qu'un utilisateur peut gagner pendant la periode definie. Les gains au-dela de ce plafond ne sont pas credites.
ContactAndPersonalCodeResponse
contactInformation de contact du membre. Il s'agit soit d'une adresse courriel, soit d'un numero de telephone, selon la methode de contact preferee du membre.
personalCodeCode personnel alphanumerique unique assigne au membre pour l'identification et la verification.
EntityNotFoundError
errorCodehttpStatusentityNameentityIdMemberBalanceResponse
balanceSolde actuel de points de fidélité du membre. Cette valeur represente le total des points disponibles pour la rédemption.
balanceCashValueÉquivalent monétaire du solde actuel de points du membre, exprimé dans la devise de base du programme.
loyaltyProgramTypeType de programme de fidélité auquel le membre est inscrit. Valeurs typiques : 'points', 'cashback', etc.
personalCodeIdentifiant unique du membre, tel qu'un code d'adhesion ou un code personnel.
totalEarnedNombre total de points de fidélité ou valeur que le membre a gagnes depuis son inscription au programme.
totalRedeemedNombre total de points de fidélité ou valeur que le membre a echanges contre des récompenses ou avantages.
totalReservedNombre total de points de fidélité ou valeur actuellement reserves pour des transactions en attente et non disponibles pour la rédemption.
MemberRequest
firstNamePrenom du membre.
lastNameNom du membre.
languageLangue preferee du membre (ex. 'en', 'fr').
dateOfBirthDate de naissance du membre au format ISO 8601 (ex. 1990-01-01T00:00:00Z).
emailAdresse courriel du membre. Doit etre dans un format courriel valide.
phoneNumberNumero de telephone du membre au format international.
assignedReferralCodeCode de referencement personnalise a assigner. Genere automatiquement s'il est omis. Doit etre unique dans l'application.
OrderItemRequest
keyCle ou identifiant unique de l'article de commande.
nameNom ou description de l'article de commande.
quantityQuantite de l'article commande.
unitPricePrix unitaire de l'article.
PagingParameter
orderByorderByFieldpagesizePointRedemptionSettingsResponse
expirationminimumPointRequiredForRedemptionNombre minimum de points qu'un utilisateur doit accumuler avant d'etre admissible a l'echange de récompenses.
minimumPointRequiredCashValueValeur monétaire (dans la devise applicable) correspondant au minimum de points requis pour la rédemption.
ActivityRequest
personalCodeCode personnel unique identifiant le membre.
typeamountMontant monétaire associé à l'activité.
referenceRéférence unique permettant d'associer cette activité à un système externe ou à un identifiant tiers.
occurredAtDate et heure UTC auxquelles l'activité a eu lieu. Format : ISO 8601.
descriptionOptionnel. Fournit du contexte ou des détails supplémentaires sur l'activité.
Optionnel. Détails structurés spécifiques au type d'activité. La forme de cet objet dépend du champ type : utilisez PurchaseDetails quand type est Purchase, TransferDetails quand type est Transfer, VisitDetails quand type est Visit, et ReviewDetails quand type est Review. Omettez ce champ si aucun détail supplémentaire n'est disponible.
redemptionCodeOptionnel. Code de rédemption associé à l'activité, le cas échéant.
redemptionAmountOptionnel. Portion du montant à échanger à l'aide d'une récompense ou d'un bon, le cas échéant.
PurchaseDetails
channelListe optionnelle des articles achetés, utile pour les analyses produit. Maximum 500 articles.
terminalIdIdentifiant de la caisse ou du terminal où l'achat a été traité.
PurchaseItem
keyClé ou identifiant unique de l'article.
nameNom ou description de l'article.
quantityQuantité de l'article. Doit être supérieure à 0.
unitPricePrix unitaire de l'article. Doit être égal ou supérieur à 0.
VisitDetails
locationIdIdentifiant unique du site visité, utile pour les scénarios multi-établissements.
locationNameNom d'affichage du site visité.
sourceSource du check-in. Valeurs acceptées : QrCode, Nfc, Manual, App.
VisitSource
Source du check-in. Valeurs acceptées : QrCode, Nfc, Manual, App.
ReviewDetails
ratingNote attribuée dans l'avis, sur une échelle de 1 à 5.
platformPlateforme sur laquelle l'avis a été soumis (ex. : 'Google', 'inapp', 'WhatsApp').
hasCommentIndique si l'avis contient un commentaire textuel. Le texte du commentaire n'est pas conservé pour des raisons de conformité RGPD.
TransferDetails
originCountryCode ISO 3166-1 alpha-2 du pays d'origine (ex. : 'CI', 'SN', 'ML').
destinationCountryCode ISO 3166-1 alpha-2 du pays de destination.
recipientPhone^\+?[1-9]\d{6,14}$Numéro de téléphone du destinataire au format international (ex. : +2250700000000). Anonymisé dans les analyses publiques.
operatorOpérateur Mobile Money utilisé pour le transfert (ex. : 'Orange Money', 'Wave', 'MTN MoMo').
feesFrais de transfert facturés au membre. Doit être égal ou supérieur à 0.
feesCurrency^[A-Z]{3}$Code devise ISO 4217 pour les frais de transfert (ex. : XOF, GHS). Doit comporter exactement 3 lettres majuscules.
TransactionHistoryResponse
createdOnloyaltyProgramTypevalueVoucherRequest
personalCodeloyaltyProgramTypecashValue