Aller au contenu principal

WalletSetting

wallet objectobligatoire
oneOf
namestringobligatoire
logostringobligatoire
iconstringobligatoire
androidLogostring
displayIdentifiantbooleanobligatoire
passBuilderPassTemplateIdstring
passBuilderBusinessIdstring
passBuilderTokenstring
identifierstringobligatoire
identifierQrstringobligatoire
addressstring
websitestringobligatoire
servicePhonestringobligatoire
businessPhonestringobligatoire
socialMedia objectobligatoire
linkedinstring
facebookstring
instagramstring
tiktokstring
twitterstring
youtubestring
snapchatstring
pintereststring
redditstring
whatsappstring
telegramstring
additionalContacts object[]obligatoire
  • Array [
  • titlestringobligatoire
    valuestringobligatoire
    kindstringobligatoire

    Valeurs possibles : [URL, PHONE, EMAIL]

  • ]
  • termsAndConditions objectobligatoire
    typestringobligatoire

    Valeurs possibles : [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringobligatoire
    rootDomainstringobligatoire
    timezonestring
    allowedPassesstring[]obligatoire

    Valeurs possibles : [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanobligatoire
    _idstringobligatoire
    createdAtstring<date-time>obligatoire
    updatedAtstring<date-time>obligatoire
    apiKeystringobligatoire
    communicationChannelstringobligatoire

    Valeurs possibles : [email, sms, all]

    smsConfig object
    smsTitlestringobligatoire
    usernamestringobligatoire
    passwordstringobligatoire
    emailConfig object
    typestringobligatoire

    Valeurs possibles : [SES, SMTP]

    portnumberobligatoire
    auth objectobligatoire
    userstringobligatoire
    passstringobligatoire
    hoststringobligatoire
    communicationRules object[]obligatoire
  • Array [
  • notificationTypestringobligatoire

    Valeurs possibles : [NEW_LOYALTY, UPDATE_LOYALTY, REMINDER_LOYALTY, EARNINGS_UPDATE, NEW_COMMUNICATION, EXPIRED_COMMUNICATION, NEW_EVENT, UPDATE_EVENT, NEW_COUPON, UPDATE_COUPON, WELCOME_INTERNAL_CLIENTS, WELCOME_CRM_CLIENTS, WELCOME_EXTERNAL_CLIENTS, WELCOME_COUPON, EXPIRED_COUPON, TRANSIT_TICKET, UPDATE_TRANSIT, HOTEL_RESERVATION, UPDATE_HOTEL_RESERVATION, CINEMA_TICKET]

    smsbooleanobligatoire
    emailbooleanobligatoire
    notificationbooleanobligatoire
  • ]
  • _idstringobligatoire
    createdAtstring<date-time>obligatoire
    updatedAtstring<date-time>obligatoire
    WalletSetting
    {
    "wallet": {
    "name": "string",
    "logo": "string",
    "icon": "string",
    "androidLogo": "string",
    "displayIdentifiant": true,
    "passBuilderPassTemplateId": "string",
    "passBuilderBusinessId": "string",
    "passBuilderToken": "string",
    "identifier": "string",
    "identifierQr": "string",
    "address": "string",
    "website": "string",
    "servicePhone": "string",
    "businessPhone": "string",
    "socialMedia": {
    "linkedin": "string",
    "facebook": "string",
    "instagram": "string",
    "tiktok": "string",
    "twitter": "string",
    "youtube": "string",
    "snapchat": "string",
    "pinterest": "string",
    "reddit": "string",
    "whatsapp": "string",
    "telegram": "string"
    },
    "additionalContacts": [
    {
    "title": "string",
    "value": "string",
    "kind": "URL"
    }
    ],
    "termsAndConditions": {
    "type": "PDF",
    "customUrl": "string",
    "pdfUrl": "string"
    },
    "webHookUrl": "string",
    "rootDomain": "string",
    "timezone": "string",
    "allowedPasses": [
    "ALL"
    ],
    "expiredCleanupEnabled": true,
    "_id": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    },
    "apiKey": "string",
    "communicationChannel": "email",
    "smsConfig": {
    "smsTitle": "string",
    "username": "string",
    "password": "string"
    },
    "emailConfig": {
    "type": "SES",
    "port": 0,
    "auth": {
    "user": "string",
    "pass": "string"
    },
    "host": "string"
    },
    "communicationRules": [
    {
    "notificationType": "NEW_LOYALTY",
    "sms": true,
    "email": true,
    "notification": true
    }
    ],
    "_id": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }

    Les nouveautés de l'API, une fois par mois

    Nouveaux endpoints, changements à prévoir, guides et cas d'usage. Pas de spam, désinscription en un clic.

    Signaler un problème technique

    Une erreur de l’API, un pass qui ne se met pas à jour, un e-mail qui n’arrive pas ? Décrivez le problème : notre équipe technique vous répond.

    Pour une réponse rapide, indiquez :

    • La méthode et l’endpoint (ex. POST /clients)
    • Le code d’erreur renvoyé (errorCode) et le corps envoyé
    • La date et l’heure de l’appel
    • Les identifiants concernés (client, modèle, pass)

    N’y mettez jamais de jeton d’API ni de mot de passe.

    Assistant IA

    Beta

    Chargement…

    Réponses générées par IA (Claude) : vérifiez les points importants.

    Connectez-vous pour utiliser l'assistant