Skip to main content

WalletCreateDto

webHookUrlstring

Comma-separated webhook URLs. Optional per-URL auth via fragment: https://host/hook#headers=Authorization:Bearer%20token

iconstring<binary>
logostring<binary>
androidLogostring<binary>
namestringrequired
identifierstring
identifierQrstring
addressstring
websitestring
servicePhonestring
businessPhonestring
socialMedia object
linkedinstring
tiktokstring
twitterstring
facebookstring
instagramstring
youtubestring
snapchatstring
pintereststring
redditstring
whatsappstring
telegramstring
additionalContacts object[]
  • Array [
  • titlestringrequired
    valuestringrequired
    kindstringrequired

    Possible values: [URL, PHONE, EMAIL]

  • ]
  • termsAndConditions object
    typestring

    Type of terms and conditions

    Possible values: [PDF, URL, NONE]

    Example: PDF
    customUrlstring<uri>

    Custom URL for terms and conditions (maps to generalRoleUrl)

    Example: https://example.com/terms
    pdfFilestring<binary>
    rootDomainstring
    timezonestring
    allowedPassesstring[]

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

    expiredCleanupEnabledboolean
    WalletCreateDto
    {
    "webHookUrl": "string",
    "icon": "string",
    "logo": "string",
    "androidLogo": "string",
    "name": "string",
    "identifier": "string",
    "identifierQr": "string",
    "address": "string",
    "website": "string",
    "servicePhone": "string",
    "businessPhone": "string",
    "socialMedia": {
    "linkedin": "string",
    "tiktok": "string",
    "twitter": "string",
    "facebook": "string",
    "instagram": "string",
    "youtube": "string",
    "snapchat": "string",
    "pinterest": "string",
    "reddit": "string",
    "whatsapp": "string",
    "telegram": "string"
    },
    "additionalContacts": [
    {
    "title": "string",
    "value": "string",
    "kind": "URL"
    }
    ],
    "termsAndConditions": {
    "type": "PDF",
    "customUrl": "https://example.com/terms",
    "pdfFile": "string"
    },
    "rootDomain": "string",
    "timezone": "string",
    "allowedPasses": [
    "ALL"
    ],
    "expiredCleanupEnabled": true
    }

    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