Skip to main content

WalletSetting

wallet objectrequired
oneOf
namestringrequired
logostringrequired
iconstringrequired
androidLogostring
displayIdentifiantbooleanrequired
passBuilderPassTemplateIdstring
passBuilderBusinessIdstring
passBuilderTokenstring
identifierstringrequired
identifierQrstringrequired
addressstring
websitestringrequired
servicePhonestringrequired
businessPhonestringrequired
socialMedia objectrequired
linkedinstring
facebookstring
instagramstring
tiktokstring
twitterstring
youtubestring
snapchatstring
pintereststring
redditstring
whatsappstring
telegramstring
additionalContacts object[]required
  • Array [
  • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
  • termsAndConditions objectrequired
    typestringrequired

    Possible values: [PDF, URL, NONE]

    customUrlstring
    pdfUrlstring
    webHookUrlstringrequired
    rootDomainstringrequired
    timezonestring
    allowedPassesstring[]required

    Possible values: [ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL]

    expiredCleanupEnabledbooleanrequired
    _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    apiKeystringrequired
    communicationChannelstringrequired

    Possible values: [email, sms, all]

    smsConfig object
    smsTitlestringrequired
    usernamestringrequired
    passwordstringrequired
    emailConfig object
    typestringrequired

    Possible values: [SES, SMTP]

    portnumberrequired
    auth objectrequired
    userstringrequired
    passstringrequired
    hoststringrequired
    communicationRules object[]required
  • Array [
  • notificationTypestringrequired

    Possible values: [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]

    smsbooleanrequired
    emailbooleanrequired
    notificationbooleanrequired
  • ]
  • _idstringrequired
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    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"
    }

    API news, once a month

    New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

    Report a technical problem

    An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

    For a fast answer, include:

    • The method and endpoint (e.g. POST /clients)
    • The error code returned (errorCode) and the body sent
    • The date and time of the call
    • The identifiers involved (customer, template, pass)

    Never include an API token or a password.

    AI assistant

    Beta

    Loading…

    AI-generated answers (Claude): double-check important details.

    Sign in to use the assistant