Skip to main content

StoreCardUpdateDto

stripstring<binary>
cardTypestring

Possible values: [STORE_CARD, MEMBER_CARD]

programNamestring
barcodeTypestring

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

colors object
backgroundColorstringrequired
labelColorstringrequired
foregroundColorstringrequired
validity object
expirationTypestringrequired

Possible values: [NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD]

expirationDatestring<date-time>
expirationAfterPeriodstring
expirationOptionstring

Possible values: [AT_CREATION_DATE, END_OF_MONTH]

expirationPeriodTypestring

Possible values: [YEARS, MONTHS, WEEKS]

descriptions object[]
  • Array [
  • titlestringrequired
    valuestringrequired
  • ]
  • openingHoursstring
    oneTimeToUseboolean
    sharingProhibitedboolean
    sharingProhibitedAndroidboolean
    displayIdentifiantboolean
    displayWalletNameboolean
    keysHasChangedstring[]
    startRowstring

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

    middleRowstring

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

    endRowstring

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

    iosHeader object
    labelEnumstringrequired

    Possible values: [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

    valueEnumstringrequired

    Possible values: [TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE]

    customLabelstring
    customValuestring
    gainLabelstring

    Possible values: [GAIN, GAINS, CAGNOTE, POINTS]

    gainUnitstring

    Possible values: [NONE, EURO, USD, MAD, POINTS]

    StoreCardUpdateDto
    {
    "strip": "string",
    "cardType": "STORE_CARD",
    "programName": "string",
    "barcodeType": "AZTEC",
    "colors": {
    "backgroundColor": "string",
    "labelColor": "string",
    "foregroundColor": "string"
    },
    "validity": {
    "expirationType": "NO_EXPIRATION",
    "expirationDate": "2024-07-29T15:51:28.071Z",
    "expirationAfterPeriod": "string",
    "expirationOption": "AT_CREATION_DATE",
    "expirationPeriodType": "YEARS"
    },
    "descriptions": [
    {
    "title": "string",
    "value": "string"
    }
    ],
    "openingHours": "string",
    "oneTimeToUse": true,
    "sharingProhibited": true,
    "sharingProhibitedAndroid": true,
    "displayIdentifiant": true,
    "displayWalletName": true,
    "keysHasChanged": [
    "string"
    ],
    "startRow": "CREATION_DATE",
    "middleRow": "CREATION_DATE",
    "endRow": "CREATION_DATE",
    "iosHeader": {
    "labelEnum": "TYPE",
    "valueEnum": "TYPE",
    "customLabel": "string",
    "customValue": "string"
    },
    "gainLabel": "GAIN",
    "gainUnit": "NONE"
    }

    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