Get a transit pass

GET

https://api-v2.test.eldowallet.fr/transits/:transitId/passes/:passId

Returns a transit ticket by its ID.

Good to know

• The wallet must have the TRANSIT pass type enabled.

Request

path parameters

• transitId string required
  Transit template ID (`_id`).
• passId string required
  Pass ID (`_id`).

header parameters

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

Responses

200

Schema application/json

• hotel oneOf required
  • Hotel
    • 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
    • title string required
    • hotelName string
    • description string
    • strip string
    • code string
    • advantages string[] required
    • colors object
      • labelColor string required
      • backgroundColor string required
      • foregroundColor string required
    • barcodeFormat stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
    • passBuilderPassTemplateId string
    • location object
      • longitude number
      • latitude number
      • relevantName string
      • relevantAddress string
    • _id string required
    • createdAt string <date-time> required
    • updatedAt string <date-time> required
  • option 2
• client oneOf
  • Client
    • wallet string
    • clientType oneOf
      • ClientType
        • storeCard oneOf required
          • StoreCard
          • option 2
        • name string required
        • isDefault boolean required
        • _id string required
        • createdAt string <date-time> required
        • updatedAt string <date-time> required
      • option 2
    • source string requiredenum: CRM, INTERNAL, EXTERNAL
    • barcode string
    • firstName string required
    • lastName string required
    • email string
    • companyName string
    • renewalDate string <date-time>
    • phoneNumber string
    • birthDate string <date-time>
    • admissionDate string <date-time>
    • gain number
    • gainHistory object[]
      • gain number required
      • date string <date-time> required
    • communicationPreferences object[]
      Per-event, per-channel communication preference overrides for this client (GDPR consent management). Same shape as `WalletSetting.communicationRules` — reused rather than duplicated. No entry for a given notificationType means enabled, mirroring `isCommunicationRuleEnabled`'s existing semantics. Change history is intentionally NOT embedded here — see `CommunicationPreferenceLog` — to keep this frequently-read document small.
      • notificationType string requiredenum: NEW_LOYALTY, UPDATE_LOYALTY, REMINDER_LOYALTY, EARNINGS_UPDATE, NEW_COMMUNICATION, EXPIRED_COMMUNICATION, NEW_EVENT, UPDATE_EVENT, NEW_COUPON, UPDATE_COUPON, WELCOME_INTERNAL_CLIENTS, WELCOME_CRM_CLIENTS, WELCOME_EXTERNAL_CLIENTS, WELCOME_COUPON, EXPIRED_COUPON, TRANSIT_TICKET, UPDATE_TRANSIT, HOTEL_RESERVATION, UPDATE_HOTEL_RESERVATION, CINEMA_TICKET
      • sms boolean required
      • email boolean required
      • notification boolean required
    • pushInformativeEnabled boolean
      Opt-out of manager-created "standard" push campaigns classified as informative.
    • pushCommercialEnabled boolean
      Opt-out of manager-created "standard" push campaigns classified as commercial.
    • _id string required
    • createdAt string <date-time> required
    • updatedAt string <date-time> required
  • option 2
• transit oneOf
  • Transit
    • 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
    • barcodeFormat string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
    • terms string required
    • emailSubscriptionMessage string
    • subscriptionMessage string
    • locations object[]
      • longitude number
      • latitude number
      • relevantName string
      • relevantAddress string
    • colors object required
      • labelColor string required
      • backgroundColor string required
      • foregroundColor string required
    • strip string
    • customerServiceNumber string
    • originStationCode string required
    • originName string required
    • destinationStationCode string required
    • destinationName string required
    • departureTime string required
    • arrivalTime string required
    • tarif string
    • details string required
    • number string required
    • type string requiredenum: Bus, Boat, Train, Air, Generic, Tram
    • gateName stringenum: N_CABINE, N_VOYAGE, PLAQUE
    • seatName stringenum: N_CABINE, N_VOYAGE, PLAQUE
    • security object
      • enableOneTimeUse boolean
      • disableIOSPassSharing boolean
      • disablePassLinkSharing boolean
      • disableMultipleHolders boolean
      • enableSecurityAnimation boolean
      • enableRotatingBarcode boolean
    • passBuilderPassTemplateId string
    • customBackFields string[]
      Template-level back field definitions (key + label + type). Per-pass values live on the Pass document.
    • displayOptions object
      • hideTarif boolean
      • hideStationCodes boolean
      • hideTripNumber boolean
    • iosHeader object
      • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
      • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
      • customLabel string
      • customValue string
    • _id string required
    • createdAt string <date-time> required
    • updatedAt string <date-time> required
  • option 2
• event oneOf
  • Event
    • status string requiredenum: PENDING, ACTIF, ENDEDdefault: "PENDING"
    • 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
    • barcodeType string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
    • name string required
    • locations object[] required
      • longitude number
      • latitude number
      • address string
      • locationName string
    • date object
      • startDate string <date-time>
      • endDate string <date-time>
      • doorOpeningHour string <date-time>
    • price number
    • gainUnit stringenum: NONE, EURO, USD, MAD, POINTS
    • description string
    • terms string
    • subscriptionMessage string required
    • emailSubscriptionMessage string required
    • contactPhone string
    • email string
    • website string
    • colors object required
      • labelColor string required
      • backgroundColor string required
      • foregroundColor string required
    • security object
      • enableOneTimeUse boolean
      • disableIOSPassSharing boolean
      • disablePassLinkSharing boolean
      • disableMultipleHolders boolean
      • enableSecurityAnimation boolean
      • enableRotatingBarcode boolean
    • passBuilderPassTemplateId string
    • strip string
    • PKTextAlignmentLeft stringenum: CHAIR, ACCESS, PRICE, ZONE, INACTIVE
    • PKTextAlignmentCenter stringenum: ROW, INACTIVE
    • PKTextAlignmentRight stringenum: INACTIVE, TYPE, SEAT, PLACE, ARMCHAIR, LOCATION, PORT
    • _id string required
    • createdAt string <date-time> required
    • updatedAt string <date-time> required
  • option 2
• storeCard oneOf
  • 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
          • 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
  • option 2
• wallet oneOf
  • 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
• coupon oneOf
  • Coupon
    • 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
    • barcodeFormat string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
    • name string required
    • description string required
    • promoCode string
    • value string
    • expirationDate string <date-time>
    • isMultipleInstance boolean required
    • isWelcomeCoupon boolean required
    • status string requiredenum: ACTIVE, INACTIVE, EXPIRED
    • source string requiredenum: INTERNAL, EXTERNAL, CRM, ALL
    • colors object required
      • labelColor string required
      • backgroundColor string required
      • foregroundColor string required
    • strip string
    • emailSubscriptionMessage string
    • subscriptionMessage string
    • security object
      • oneTimeToUseJwtLink boolean required
      • disableIOSPassSharing boolean
      • enableOneTimeUse boolean
      • disableMultipleHolders boolean
      • enableSecurityAnimation boolean
      • enableRotatingBarcode boolean
    • valueLabel string requiredenum: VALUE, AMOUNT, PRESTATION
    • iosHeader object
      • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
      • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
      • customLabel string
      • customValue string
    • passBuilderPassTemplateId string
    • _id string required
    • createdAt string <date-time> required
    • updatedAt string <date-time> required
  • option 2
• passBuilderPassId string
• passBuilderUpdatedAt string <date-time>
• shortId string
  4-char unique id for short links (base62), auto-generated on insert
• legacyShortId string
  V1 shortlinks.shortLinkId preserved for /p/:id redirects (variable length)
• kind string requiredenum: hotel, transit, event, storeCard, coupon
• firstName string
• lastName string
• email string
• barcode string
• phoneNumber string
• devices object[] required
  • deviceLibraryIdentifier string required
  • deviceType string requiredenum: ANDROID, IOS
  • registeredAt string <date-time> required
  • isDeleted boolean required
• activeIOSDeviceCount number required
• activeAndroidDeviceCount number required
• status string requiredenum: active, inactive, deleted, canceled, expired
• redeemedAt string <date-time>
• instanceId object
• instanceLinks object[] required
  • instanceId string required
  • link string required
  • name string
  • description string
• checkin string <date-time>
• checkout string <date-time>
• additionalBenefits string[]
• roomNumber string
• roomCode string
• gate string
• seat string
• originName string
• destinationName string
• originStationCode string
• destinationStationCode string
• departureTime string
• arrivalTime string
• tarif string
• tripNumber string
• departureDate string required
• arrivalDate string required
• expirationDate string <date-time>
• originalExpirationDate string <date-time>
  Stashed validity date before manual EXPIRED overwrites expirationDate
• admissionDate string <date-time>
• backFieldName string
• backFieldContent string
• customBackFields string[]
  Transit-specific structured back fields (replaces the scalar backFieldName/backFieldContent for transit passes)
• leftRow string
• centerRow string
• rightRow string
• promoCode string
• value string
• unit string
• description string
• bannerOverrideUrl string
• downloadedVia object
• shortLink string
  Short link for the pass inscription page (e.g. for QR codes) (not in database, computed on the fly)
• _id string required
• createdAt string <date-time> required
• updatedAt string <date-time> required

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