ClientType

storeCard objectobligatoire

oneOf

• StoreCard
• string

wallet objectobligatoire

oneOf

• Wallet
• string

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

cardTypestringobligatoire

Valeurs possibles : [STORE_CARD, MEMBER_CARD]

displayIdentifiantbooleanobligatoire

displayWalletNameboolean

stripstringobligatoire

passBuilderPassTemplateIdstring

programNamestring

keysHasChangedstring[]

startRowstring

Valeurs possibles : [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

middleRowstring

Valeurs possibles : [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

endRowstring

Valeurs possibles : [CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE]

iosHeader object

labelEnumstringobligatoire

Valeurs possibles : [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

valueEnumstringobligatoire

Valeurs possibles : [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

customLabelstring

customValuestring

barcodeTypestringobligatoire

Valeurs possibles : [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

descriptions object[]obligatoire

Array [

titlestringobligatoire

valuestringobligatoire

]

openingHoursstringobligatoire

colors objectobligatoire

labelColorstringobligatoire

backgroundColorstringobligatoire

foregroundColorstringobligatoire

oneTimeToUsebooleanobligatoire

sharingProhibitedbooleanobligatoire

sharingProhibitedAndroidbooleanobligatoire

validity objectobligatoire

expirationTypestringobligatoire

Valeurs possibles : [NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD]

expirationDatestring<date-time>

expirationAfterPeriodstring

expirationPeriodTypestring

Valeurs possibles : [YEARS, MONTHS, WEEKS]

expirationOptionstring

Valeurs possibles : [AT_CREATION_DATE, END_OF_MONTH]

gainLabelstringobligatoire

Valeurs possibles : [GAIN, GAINS, CAGNOTE, POINTS]

gainUnitstringobligatoire

Valeurs possibles : [NONE, EURO, USD, MAD, POINTS]

offerLabelstringobligatoire

enableDisplayIdentifiantbooleanobligatoire

gainFormatMigratedbooleanobligatoire

Indique si le modèle PassBuilder et tous les passes existants ont été migrés vers le nouveau format de gain, où le symbole de l'unité est intégré à la valeur de l'attribut du pass (par exemple « 50 Pts ») plutôt qu'au champ du modèle. false (ou absent) signifie que l'ancien format est toujours utilisé.

_idstringobligatoire

createdAtstring<date-time>obligatoire

updatedAtstring<date-time>obligatoire

namestringobligatoire

isDefaultbooleanobligatoire

_idstringobligatoire

createdAtstring<date-time>obligatoire

updatedAtstring<date-time>obligatoire

ClientType

{
  "storeCard": {
    "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"
    },
    "cardType": "STORE_CARD",
    "displayIdentifiant": true,
    "displayWalletName": true,
    "strip": "string",
    "passBuilderPassTemplateId": "string",
    "programName": "string",
    "keysHasChanged": [
      "string"
    ],
    "startRow": "CREATION_DATE",
    "middleRow": "CREATION_DATE",
    "endRow": "CREATION_DATE",
    "iosHeader": {
      "labelEnum": "TYPE",
      "valueEnum": "TYPE",
      "customLabel": "string",
      "customValue": "string"
    },
    "barcodeType": "AZTEC",
    "descriptions": [
      {
        "title": "string",
        "value": "string"
      }
    ],
    "openingHours": "string",
    "colors": {
      "labelColor": "string",
      "backgroundColor": "string",
      "foregroundColor": "string"
    },
    "oneTimeToUse": true,
    "sharingProhibited": true,
    "sharingProhibitedAndroid": true,
    "validity": {
      "expirationType": "NO_EXPIRATION",
      "expirationDate": "2024-07-29T15:51:28.071Z",
      "expirationAfterPeriod": "string",
      "expirationPeriodType": "YEARS",
      "expirationOption": "AT_CREATION_DATE"
    },
    "gainLabel": "GAIN",
    "gainUnit": "NONE",
    "offerLabel": "string",
    "enableDisplayIdentifiant": true,
    "gainFormatMigrated": true,
    "_id": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "name": "string",
  "isDefault": true,
  "_id": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}