Skip to main content

Update the store card

PATCH

https://api-v2.test.eldowallet.fr/store-cards

Updates the wallet's store card template (design, texts, strip image, validity, gain unit…) and applies the changes to the cards already issued. Accepts application/json or multipart/form-data (to upload the strip image). Returns the updated store card.

Good to know
  • Body is multipart/form-data: nested objects (colors, security, locations…) are sent as a JSON string, booleans as "true"/"false". Images: PNG or JPEG, 1 KB to 5 MB.

Request​

header parameters
  • x-lang string
    Language for responses
    enum: en, frdefault: "en"
Body multipart/form-data required
  • strip string <binary>
  • cardType stringenum: STORE_CARD, MEMBER_CARD
  • programName string
  • barcodeType stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • colors object
    • backgroundColor string required
    • labelColor string required
    • foregroundColor string required
  • validity object
    • expirationType string requiredenum: NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD
    • expirationDate string <date-time>
    • expirationAfterPeriod string
    • expirationOption stringenum: AT_CREATION_DATE, END_OF_MONTH
    • expirationPeriodType stringenum: YEARS, MONTHS, WEEKS
  • descriptions object[]
    • title string required
    • value string required
  • openingHours string
  • oneTimeToUse boolean
  • sharingProhibited boolean
  • sharingProhibitedAndroid boolean
  • displayIdentifiant boolean
  • displayWalletName boolean
  • keysHasChanged string[]
  • startRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • middleRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • endRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • iosHeader object
    • labelEnum string requiredenum: TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE
    • valueEnum string requiredenum: TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE
    • customLabel string
    • customValue string
  • gainLabel stringenum: GAIN, GAINS, CAGNOTE, POINTS
  • gainUnit stringenum: NONE, EURO, USD, MAD, POINTS
Body application/json required
  • strip string <binary>
  • cardType stringenum: STORE_CARD, MEMBER_CARD
  • programName string
  • barcodeType stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • colors object
    • backgroundColor string required
    • labelColor string required
    • foregroundColor string required
  • validity object
    • expirationType string requiredenum: NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD
    • expirationDate string <date-time>
    • expirationAfterPeriod string
    • expirationOption stringenum: AT_CREATION_DATE, END_OF_MONTH
    • expirationPeriodType stringenum: YEARS, MONTHS, WEEKS
  • descriptions object[]
    • title string required
    • value string required
  • openingHours string
  • oneTimeToUse boolean
  • sharingProhibited boolean
  • sharingProhibitedAndroid boolean
  • displayIdentifiant boolean
  • displayWalletName boolean
  • keysHasChanged string[]
  • startRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • middleRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • endRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • iosHeader object
    • labelEnum string requiredenum: TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE
    • valueEnum string requiredenum: TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE
    • customLabel string
    • customValue string
  • gainLabel stringenum: GAIN, GAINS, CAGNOTE, POINTS
  • gainUnit stringenum: NONE, EURO, USD, MAD, POINTS

Responses​

Schema application/json
  • wallet oneOf required
    • Wallet
      • name string required
      • logo string required
      • icon string required
      • androidLogo string
      • displayIdentifiant boolean required
      • passBuilderPassTemplateId string
      • passBuilderBusinessId string
      • passBuilderToken string
      • identifier string required
      • identifierQr string required
      • address string
      • website string required
      • servicePhone string required
      • businessPhone string required
      • socialMedia object required
        • linkedin string
        • facebook string
        • instagram string
        • tiktok string
        • twitter string
        • youtube string
        • snapchat string
        • pinterest string
        • reddit string
        • whatsapp string
        • telegram string
      • additionalContacts object[] required
        • title string required
        • value string required
        • kind string requiredenum: URL, PHONE, EMAIL
      • termsAndConditions object required
        • type string requiredenum: PDF, URL, NONE
        • customUrl string
        • pdfUrl string
      • webHookUrl string required
      • rootDomain string required
      • timezone string
      • allowedPasses string[] requiredenum: ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL
      • expiredCleanupEnabled boolean required
      • _id string required
      • createdAt string <date-time> required
      • updatedAt string <date-time> required
    • option 2
  • cardType string requiredenum: STORE_CARD, MEMBER_CARD
  • displayIdentifiant boolean required
  • displayWalletName boolean
  • strip string required
  • passBuilderPassTemplateId string
  • programName string
  • keysHasChanged string[]
  • startRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • middleRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • endRow stringenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
  • iosHeader object
    • labelEnum string requiredenum: TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE
    • valueEnum string requiredenum: TYPE, GAIN, FULLNAME, CUSTOM_TEXT, INACTIVE
    • customLabel string
    • customValue string
  • barcodeType string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • descriptions object[] required
    • title string required
    • value string required
  • openingHours string required
  • colors object required
    • labelColor string required
    • backgroundColor string required
    • foregroundColor string required
  • oneTimeToUse boolean required
  • sharingProhibited boolean required
  • sharingProhibitedAndroid boolean required
  • validity object required
    • expirationType string requiredenum: NO_EXPIRATION, AT_DATETIME, AFTER_PERIOD
    • expirationDate string <date-time>
    • expirationAfterPeriod string
    • expirationPeriodType stringenum: YEARS, MONTHS, WEEKS
    • expirationOption stringenum: AT_CREATION_DATE, END_OF_MONTH
  • gainLabel string requiredenum: GAIN, GAINS, CAGNOTE, POINTS
  • gainUnit string requiredenum: NONE, EURO, USD, MAD, POINTS
  • offerLabel string required
  • enableDisplayIdentifiant boolean required
  • gainFormatMigrated boolean required
    Marks whether the PassBuilder template and all existing passes have been migrated to the new gain format where the unit symbol is embedded in the pass attribute value (e.g. "50 Pts") rather than in the template field. False (or absent) means the old format is still in use.
  • _id string required
  • createdAt string <date-time> required
  • updatedAt string <date-time> required

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