Get store card details

GET

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

Returns a summary of the store card, handy for building a client form: card type (cardType), available client types (clientTypes), expiration date computed from the card's validity (expirationDate), card row contents (startRow, middleRow, endRow) and the wallet's communication channel. isUnlimited is true when the card never expires.

Request

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

Schema application/json

• cardType string requiredenum: STORE_CARD, MEMBER_CARD
• clientTypes object[] required
  • storeCard oneOf required
    • StoreCard
      • 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
          • additionalContacts object[] required
          • termsAndConditions object required
          • 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
    • option 2
  • name string required
  • isDefault boolean required
  • _id string required
  • createdAt string <date-time> required
  • updatedAt string <date-time> required
• expirationDate string <date-time> required
• startRow string requiredenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
• middleRow string requiredenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
• endRow string requiredenum: CREATION_DATE, EXPIRATION_DATE, BIRTHDATE, GAIN, CLUB, ASSOCIATION, ORGANISATION, ENTREPRISE, N_LICENCE, N_ADHERENT, N_MEMBER, MEMBER, N_IMMATRICULATION, INACTIVE, ADMISSION_DATE
• communicationChannel string requiredenum: email, sms, all
• isUnlimited boolean

401

UNAUTHORIZED

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

404

MODEL_NOT_FOUND

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email