Coupon

wallet objectrequired

oneOf

• Wallet
• string

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

barcodeFormatstringrequired

Possible values: [AZTEC, CODE_128, PDF_417, QR_CODE, NONE]

namestringrequired

descriptionstringrequired

promoCodestring

valuestring

expirationDatestring<date-time>

isMultipleInstancebooleanrequired

isWelcomeCouponbooleanrequired

statusstringrequired

Possible values: [ACTIVE, INACTIVE, EXPIRED]

sourcestringrequired

Possible values: [INTERNAL, EXTERNAL, CRM, ALL]

colors objectrequired

labelColorstringrequired

backgroundColorstringrequired

foregroundColorstringrequired

stripstring

emailSubscriptionMessagestring

subscriptionMessagestring

security object

oneTimeToUseJwtLinkbooleanrequired

disableIOSPassSharingboolean

enableOneTimeUseboolean

disableMultipleHoldersboolean

enableSecurityAnimationboolean

enableRotatingBarcodeboolean

valueLabelstringrequired

Possible values: [VALUE, AMOUNT, PRESTATION]

iosHeader object

labelEnumstringrequired

Possible values: [FULLNAME, CUSTOM_TEXT, INACTIVE]

valueEnumstringrequired

Possible values: [FULLNAME, CUSTOM_TEXT, INACTIVE]

customLabelstring

customValuestring

passBuilderPassTemplateIdstring

_idstringrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

Coupon

{
  "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"
  },
  "barcodeFormat": "AZTEC",
  "name": "string",
  "description": "string",
  "promoCode": "string",
  "value": "string",
  "expirationDate": "2024-07-29T15:51:28.071Z",
  "isMultipleInstance": true,
  "isWelcomeCoupon": true,
  "status": "ACTIVE",
  "source": "INTERNAL",
  "colors": {
    "labelColor": "string",
    "backgroundColor": "string",
    "foregroundColor": "string"
  },
  "strip": "string",
  "emailSubscriptionMessage": "string",
  "subscriptionMessage": "string",
  "security": {
    "oneTimeToUseJwtLink": true,
    "disableIOSPassSharing": true,
    "enableOneTimeUse": true,
    "disableMultipleHolders": true,
    "enableSecurityAnimation": true,
    "enableRotatingBarcode": true
  },
  "valueLabel": "VALUE",
  "iosHeader": {
    "labelEnum": "FULLNAME",
    "valueEnum": "FULLNAME",
    "customLabel": "string",
    "customValue": "string"
  },
  "passBuilderPassTemplateId": "string",
  "_id": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}