Skip to main content

Create a transit pass

POST

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

Creates a transit ticket for a traveller from a transit template and returns its ID, barcode and download link (downloadLink). With enableSendEmailOrSms: true, the ticket is also sent by email or SMS (email or phoneNumber).

Good to know
  • The wallet must have the TRANSIT pass type enabled.

Request​

path parameters
  • transitId string required
    Transit template ID (`_id`).
header parameters
  • x-lang string
    Language for responses
    enum: en, frdefault: "en"
Body application/json required
  • departureDate string required
    ISO 8601 calendar date (YYYY-MM-DD)
    example: 2000-01-01
  • arrivalDate string required
    ISO 8601 calendar date (YYYY-MM-DD)
    example: 2000-01-01
  • departureTime string
    24-hour HH:mm
    pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$example: 00:00
  • arrivalTime string
    24-hour HH:mm
    pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$example: 01:00
  • originStationCode stringmaxLength: 3example: str
  • destinationStationCode stringmaxLength: 3example: str
  • expirationDate stringexample: 2000-01-01
  • flightNumber string
  • gate string
  • seat string
  • originName stringmaxLength: 13
  • destinationName stringmaxLength: 13
  • tripNumber string
  • tarif string
  • customBackFields object[]
    • key string
      Auto-generated server-side (slug derived from label + position index). Clients should NOT send this field — it is ignored and always regenerated.
    • label string required
    • value string required
    • type object required
  • enableSendEmailOrSms booleandefault: false
  • firstName string required
  • lastName string required
  • email string <email> required
  • phoneNumber string
  • barcode string

Responses​

Schema application/json
  • _id string required
  • downloadLink string
  • name string
  • barcode string

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