Account

Rassemble les actions possibles liées au compte authentifié d'un usager.

Login Customer

POST

/feed/account/login.json

Flux login

Request Parameters

firebase_token: string Token Firebase		Required
sHMAC: string HMAC key		Required
network_id: ?int Identifiant Réseau
user_id: ?string Identifiant de l'utilisateur
universal: ?int 1 si Ticket Universel
lang: ?string Langue de l'application de l'utilisateur
provider: ?string Authentication provider
client: ?string Client identifier	Example nouvelle_aquitaine
oauth_client: ?string Oauth client identifier	Example zr2qug5lyuuir9ghgy4udf
withWallet: ?int Si le wallet doit être retourné dans la réponse	Example 1
originAgent: ?string Type d'origine de connexion	Example eshop-v3.4.3
originType: ?string Agent de l'origine de connexion	Example ESHOP
forceProfiles: ?int Permet de forcer ou non le profiling	Example 1
authAsGuest: ?int 1 -> Authentifie l'utilisateur en tant qu'invité	Example 1

Authenticate Customer

POST

/feed/account/authenticate.json

Authentifie un client

Response Payload Example

{
  "token": "abc...",
  "customerId": 123,
  "identity": {
    "providerId": 123,
    "providerUserRef": "abc123",
    "providerCachePayload": null,
    "createdAt": "2024-12-06T14:28:51.000000Z",
    "updatedAt": "2024-12-06T14:28:51.000000Z",
    "canDissociate": true
  },
  "customer": {
    "id": 123,
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@email.fr",
    "emailBouncedAt": "2024-12-06T14:28:51.000000Z",
    "emailBouncedUntil": "2024-12-06T14:28:51.000000Z",
    "emailBouncedReason": "TEMPORARY_MAILBOX_FULL",
    "phone": "0123456789",
    "birthDate": "2024-12-06T14:28:51.000000Z",
    "avatarUrl": "https://...",
    "lastVerificationEmailSentAt": "2024-12-06T14:28:51.000000Z",
    "verifiedAt": "2024-12-06T14:28:51.000000Z",
    "anonymizationRequestedAt": "2024-12-06T14:28:51.000000Z",
    "identities": [
      {
        "providerId": 123,
        "providerUserRef": "abc123",
        "providerCachePayload": null,
        "createdAt": "2024-12-06T14:28:51.000000Z",
        "updatedAt": "2024-12-06T14:28:51.000000Z",
        "canDissociate": true
      },
      ...
    ]
  }
}

Request Parameters

networkId: int Internal ID of the network				Required
authProviderToken: string The authentication provider token				Required
sHMAC: string The HMAC signature of the request				Required
clientSlug: ?string The client slug
authProviderId: ?int Internal ID of the authentication provider
provider: ?string The authentication provider
originAgent: ?string The origin agent
originType: ?string The origin type
locale: ?string The user locale
authAsGuest: ?int Whether to authenticate as a guest
oauthClient: ?string The OAuth client identifier
withCustomer: ?int Whether to include the customer in the response

Logout Customer

POST

/feed/account/logout.json

Silently attempts to invalidate authenticated session

Request Parameters

user_id: string

Identifiant de l'utilisateur

Required

userToken: string

Token de sécurité

Required

sHMAC: string

HMAC key

Required

update

POST

/feed/account/update.json

Flux de mise à jour d'un utilisateur

Request Parameters

userToken: string Token de sécurité		Required
sHMAC: string HMAC key		Required
userId: ?string Identifiant de l'utilisateur	Example 6407
userName: ?string Nom d'utilisateur
userLastname: ?string Prénom utilisateur
userPhoneNumber: ?string Numéro de téléphone
userMail: ?string Adresse e-mail
userBirthday: ?datetime Date de naissance
address: ?json Adresse de l'utilisateur
userPictureUrl: ?string Photo de profil
userPaymentId: ?string Coordonnées bancaires de l'utilisateur
metadatas: ?json
parent: ?json Infos du parent
networkId: ?int Identifiant Réseau	Example 166
withWallet: ?int Si le wallet doit être retourné dans la réponse	Example 1
authAsGuest: ?int 0 -> Authentifie l'utilisateur en tant que client connecté, 1 -> Authentifie l'utilisateur en tant qu'invité	Example 1

createProfile

POST

/feed/account/createProfile.json

Flux création d'un profil

Request Parameters

userToken: string Token de sécurité		Required
userName: string Nom d'utilisateur		Required
userLastname: string Prénom utilisateur		Required
sHMAC: string HMAC key		Required
network_id: ?string Identifiant Réseau
userPhoneNumber: ?string Numéro de téléphone
userBirthday: ?datetime Date de naissance
userStatus: ?string Le statut du profile
locale: ?string Locale de l'utilisateur	Example fr_FR

getUser

POST
GET

/feed/account/getUser.json

Récupération d'un utilisateur en fonction du token

Request Parameters

userToken: string Token de sécurité		Required
sHMAC: string HMAC key		Required
userId: ?int Identifiant du l'utilisateur ou du profil	Example 4567
networkId: ?int Identifiant Réseau	Example 166

Get Identities

/feed/account/identities.json

Récupère les identités d'un utilisateur

Response Payload Example

{
  "identities": [
    {
      "providerId": 123,
      "providerUserRef": "abc123",
      "providerCachePayload": null,
      "createdAt": "2024-12-06T14:28:51.000000Z",
      "updatedAt": "2024-12-06T14:28:51.000000Z",
      "canDissociate": true
    },
    ...
  ]
}

Request Parameters

networkId: int

Internal ID of the network

Required

userToken: string

The authentication token of the user

Required

sHMAC: string

The HMAC signature of the request

Required

Create an Identity

POST

/feed/account/createIdentity.json

Crée une identité pour l'utilisateur connecté

Response Payload Example

{
  "identity": {
    "providerId": 123,
    "providerUserRef": "abc123",
    "providerCachePayload": null,
    "createdAt": "2024-12-06T14:28:51.000000Z",
    "updatedAt": "2024-12-06T14:28:51.000000Z",
    "canDissociate": true
  }
}

Request Parameters

networkId: int Internal ID of the network				Required
authProviderToken: string The authentication provider token				Required
userToken: string The authentication token of the user				Required
sHMAC: string The HMAC signature of the request				Required
authProviderId: ?int Internal ID of the authentication provider

Delete Identity

DELETE

/feed/account/deleteIdentity.json

Supprime une identité de l'utilisateur connecté

Response Payload Example

{
  "success": true
}

Request Parameters

authProviderId: int Internal ID of the authentication provider				Required
userToken: string The authentication token of the user				Required
sHMAC: string The HMAC signature of the request				Required
authProviderToken: ?string The authentication provider token

getWallet

POST
GET

/feed/account/getWallet.json

Récupération d'un utilisateur en fonction du token

Request Parameters

userToken: string Token de sécurité	Example 878SDF99QGS7689	Required
sHMAC: string HMAC key		Required
userId: ?int Identifiant optionnel du profil	Example 12
unstack: ?int 1 to prevent stacking ticket	Example 1
type: ?string Type de ticket à récupérer ("to_use", "in_use" or "deleted")	Example to_use
networkId: ?int Identifiant du réseau	Example 64
client: ?string Slug du client	Example modalis
displayFullscreenVersion: ?int Version du displayToken retourné	Example 2
displayFullscreenDevicePublicId: ?string ID publique du device pour les display tokens "Fullscreen"	Example a7a2e2ed-36d1-446e-bd75-76cd94b46a9d
displayFullscreenDevicePublicKey: ?string Clé publique du device pour les display tokens "Fullscreen" (encodée en base64url)	Example MDEyMzQ1Njc4OUFCQ0RFRg

Set Network Favorites

POST

/feed/account/setFavorites.json

Définit la liste de réseaux favoris de l'usager

Request Parameters

sHMAC: string

HMAC key

Required

userToken: string

Token de securité

Required

userNetworks: mixed

Réseaux favoris

Example

[1,2]

Required

getCards

POST
GET

/feed/account/getCards.json

Récupération des cartes liées au wallet de l'utilisateur

Request Parameters

userToken: string Token de securité		Required
sHMAC: string HMAC key		Required
network_id: ?int Identifiant réseau
methods: ?json Liste de types de moyens de paiements à retourner. ("TRANFER", "CARD")	Example ["CARD"]
stack: ?json Active le rassemblement des cartes par leur numéro (defaults to true)	Example true / false

unregisterCard

POST

/feed/account/unregisterCard.json

Désassocie une carte du wallet de l'utilisateur

Request Parameters

cardId: string

ID de la carte à supprimer

Example

1b0b1a5feddf48df955a409b9a32c026

Required

userToken: string

Token de securité

Required

sHMAC: string

HMAC key

Required

registerCard

POST

/feed/account/registerCard.json

Génère une URL de formulaire de création d'alias (Payzen-only for now)

Request Parameters

networkId: int ID du réseau en cours	Example 473	Required
userToken: string Token de securité	Example 1b0b1a5feddf48df955a409b9a32c026	Required
sHMAC: string HMAC key	Example sd7g4s687hetdu6rd8q4sfse6gd4	Required
type: ?string Type de moyen de paiement (CARD ou TRANSFER)	Example TRANSFER

updateCard

POST

/feed/account/updateCard.json

Modifie les détails de paiement associés à un alias (Payzen-only for now)

Request Parameters

networkId: int ID du réseau en cours	Example 473	Required
userToken: string Token de securité	Example 1b0b1a5feddf48df955a409b9a32c026	Required
cardId: int ID du moyen de paiement	Example 45	Required
sHMAC: string HMAC key	Example sd7g4s687hetdu6rd8q4sfse6gd4	Required

setCardBookmark

/feed/account/setCardBookmark.json

Définit une carte comme favorite

Request Parameters

cardId: int ID de la carte	Example 45	Required
userToken: string Token de session utilisateur		Required
userId: int Identifiant de l'utilisateur	Example 4567	Required
sHMAC: string Clé HMAC	Example sd7g4s687hetdu6rd8q4sfse6gd4	Required

removeCardBookmark

/feed/account/removeCardBookmark.json

Supprime une carte des favoris

Request Parameters

cardId: int ID de la carte	Example 45	Required
userToken: string Token de session utilisateur		Required
userId: int Identifiant de l'utilisateur	Example 4567	Required
sHMAC: string Clé HMAC	Example sd7g4s687hetdu6rd8q4sfse6gd4	Required

Returns basic data about authenticated token

GET
POST

/feed/account/introspectToken.json

(mainly for external authentication purposes and auth checks)

Request Parameters

userToken: string

Token de securité

Required

sHMAC: string

HMAC key

Required

Attempts to link a media to a user

POST

/feed/account/registerMedia.json

Tente d'associer un media à l'utilisateur connecté

Request Parameters

userToken: string Token de session utilisateur		Required
mediaCode: string Token de session utilisateur		Required
mediaProviderId: int ID du provider du media		Required
mediaBirthDate: string Date de naissance de l'utilisateur pour vérification		Required
userId: ?int Identifiant du l'utilisateur ou du profil	Example 4567
networkId: ?int Identifiant du réseau

unregisterMedia

DELETE

/feed/account/unregisterMedia.json

Désassocie un media d'un utilisateur

Request Parameters

mediaId: int Identifiant du media à déassocier		Required
userToken: string Token de session utilisateur		Required
sHMAC: string Clé HMAC	Example sd7g4s687hetdu6rd8q4sfse6gd4	Required
userId: ?int Identifiant du l'utilisateur ou du profil	Example 4567

Retrieves a list of a customer's linked medias

/feed/account/getMedias.json

Récupère une liste des medias associés à l'utilisateur

Request Parameters

userToken: string

Token de session utilisateur

Required

userId: ?int

Identifiant du l'utilisateur ou du profil

Example

4567

networkId: ?int

Identifiant du réseau

Joins currently authenticated user to a network

POST

/feed/account/joinNetwork.json

Associe l'utilisateur à un réseau

Request Parameters

userToken: string

Token de session utilisateur

Required

networkId: int

Identifiant du réseau

Required

resetPassword

POST

/feed/account/resetPassword.json

Envoyer un mail de réinitialisation de mot de passe

Request Parameters

email: string

Email dont le mot de passe est à réinitialiser

Example

jd@airweb.fr

Required

networkId: int

Identifiant du réseau

Example

Required

locale: ?string

Langue de l'utilisateur

Example

fr_FR

confirmAnonymizationRequest

POST
DELETE

/feed/account/confirmAnonymizationRequest.json

Demande l'anonymization du compte de l'utilisateur

Request Parameters

userToken: string

Token de securité

Example

1b0b1a5feddf48df955a409b9a32c026

Required

sHMAC: string

HMAC key

Example

sd7g4s687hetdu6rd8q4sfse6gd4

Required

locale: ?string

Langue de l'utilisateur

Example

fr_FR

Generates the URL for the account anonymization modal and retrieves a signed URL.

/feed/account/requestAnonymizationModalUrl.json

Génère l'URL de la webview d'anonymisation de compte

Request Parameters

userToken: string Token de securité	Example 1b0b1a5feddf48df955a409b9a32c026	Required
sHMAC: string HMAC key	Example sd7g4s687hetdu6rd8q4sfse6gd4	Required
redirectUrl: ?string Lien de redirection	Example https://myredirecturl.com
networkId: ?int Identifiant du réseau	Example 64

reactivate

POST

/feed/account/reactivate.json

Réactive un compte

Request Parameters

userToken: string

Token de securité

Example

1b0b1a5feddf48df955a409b9a32c026

Required

sHMAC: string

HMAC key

Example

sd7g4s687hetdu6rd8q4sfse6gd4

Required

sendVerificationEmail

POST

/feed/account/sendVerificationEmail.json

Envoie un email de vérification de compte

Request Parameters

userToken: string Token de securité	Example 1b0b1a5feddf48df955a409b9a32c026	Required
sHMAC: string HMAC key	Example sd7g4s687hetdu6rd8q4sfse6gd4	Required
networkId: ?int Identifiant du réseau	Example 166
clientId: ?string Identifiant du client
client: ?string Slug du client
locale: ?string Langue de l'utilisateur	Example fr_FR

verify

POST

/feed/account/verify.json

Vérifie le compte d'un utilisateur

Request Parameters

code: string

Code de vérification

Example

code123

Required

disableProfile

/feed/account/disableProfile.json

Désactive un profil

Request Parameters

userId: int

Identifiant du profil

Example

4567

Required

userToken: string

Token de securité

Example

1b0b1a5feddf48df955a409b9a32c026

Required

sHMAC: string

Clé HMAC

Example

sd7g4s687hetdu6rd8q4sfse6gd4

Required

getTicketAttestation

/feed/account/getTicketAttestation.json

Récupère le code de contrôle d'un titre V1

Request Parameters

ticketId: string Identifiant du ticket	Example 1234	Required
sHMAC: string HMAC key	Example abc	Required
userToken: string Token de sécurité	Example d7bb15b970e503e8dd67b0b5f907ba18	Required
providerId: ?int Identifiant du générateur de code de contrôle	Example 680
providerSlug: ?string Référence du générateur de code de contrôle	Example ThalesTBM
mediaType: ?string Type du media demandant l'attestation	Example PASS
mediaCode: ?string Code du media demandant l'attestation	Example 57721656
mediaKey: ?string Clé publique du media demandant l'attestation	Example 57721656

Get Transfer History

/feed/account/getTransferHistory.json

Gets a global overview of the history of transfers for the authenticated customer or one of its profiles.

Will return an array of transfers and an array of customers related to those transfers for ease of display implementation.

Request Parameters

userId: int Identifiant du profil	Example 4567	Required
userToken: string Token de sécurité	Example d7bb15b970e503e8dd67b0b5f907ba18	Required
sHMAC: string HMAC key	Example abc	Required
networkId: ?string Liste des réseaux concernés	Example 23,47,387

searchLocalMediaForSignin

/feed/account/searchLocalMediaForSignin.json

Recherche les médias locaux pour une connexion

Request Parameters

mediaNumber: string Numéro de la carte	Example 00112233445566778899AA	Required
mediaCustomerBirthDate: string Date de naissance du propriétaire de la carte	Example 1980-01-01	Required
sHMAC: string HMAC key	Example abc	Required
networkId: ?int Identifiant du réseau	Example 64

signinWithToken

POST

/feed/account/signinWithToken.json

Association d'un compte utilisateur Airweb avec son compte firebase

Request Parameters

signinToken: string JWT généré via la route Account/searchLocalMediaForSignin		Required
firebaseToken: string Token firebase pour s'authentifier		Required
sHMAC: string HMAC key	Example abc	Required
email: ?string Email du compte firebase	Example test@airweb.fr

Link Profile From Token

POST

/feed/account/linkProfileFromToken.json

Association d'un compte utilisateur à un compte parent

Response Payload Example

{
  "success": true
}

Request Parameters

signinToken: string

JWT généré via la route Account/searchLocalMediaForSignin

Required

userToken: string

Token de sécurité

Example

d7bb15b970e503e8dd67b0b5f907ba18

Required

sHMAC: string

HMAC key

Example

abc

Required

touch

POST

/feed/account/touch.json

Actualise la date de la dernière activité d'un client

Request Parameters

userToken: string

Token de sécurité

Example

d7bb15b970e503e8dd67b0b5f907ba18

Required

sHMAC: string

HMAC key

Example

abc

Required

Get Belongings

/feed/account/getBelongings.json

Récupère une liste détaillée des possessions de l'usager à inclure dans son portefeuille

Response Payload Example

{
  "belongings": [
    {
      "id": 12345,
      "type": null,
      "label": "Entité Quelconque",
      "createdAt": "2024-01-01T01:02:03.456"
    },
    {
         "id": 12345,
      "type": "RESERVATION",
      "label": "Réservation",
      "reservation": {
        "type": "TRIP",
        "message": null,
        "tripSeatCount": null,
        "tripDepartureDate": "2020-01-01T00:00:00+00:00",
        "tripDepartureLocationRef": "FIRST",
        "tripDepartureLocationLabel": "Premier Arrêt",
        "tripArrivalDate": "2020-01-01T00:30:00+00:00",
        "tripArrivalLocationRef": "SECOND",
        "tripArrivalLocationLabel": "Second Arrêt"
      },
      "createdAt": "2024-01-01T01:02:03.456"
    },
    // ...
  ]
}

Request Parameters

sHMAC: string HMAC key	Example abc	Required
userToken: string Token de sécurité	Example d7bb15b970e503e8dd67b0b5f907ba18	Required
userId: int Identifiant du profil	Example 4567	Required
type: ?json Type de possessions à récupérer (TICKET, RESERVATION, ...)	Example RESERVATION
networkId: ?json Liste d'identifiants de réseaux à inclure	Example [123,456]
client: ?string Slug du client	Example modalis

Get Belonging Barcodes

/feed/account/getBelongingBarcodes.json

Récupère un tableau de CB2D associés à la possession de l'usager spécifiée

ATTENTION: le contenu de la propriété data est encodé en base64 afin d'éviter tout souci d'unicode lié au JSON. Le contenu de la propriété devra être décodé avant d'être transformé en image.

Response Payload Example

{
  "barcodes": [
    {
      "format": "AZTEC",
      "data": "dHlwPVIKcnR5PVRSSVAKdGRkPTE3MDQwNjcyMDAKdGRsPVNFQ09ORAp0YWQ9MTcwNDA2OTAwMAp0YWw9VEhJUkQKdHNjPTIKcGM9RVVSCnBhPTIwMApleHA9MTcxNTYyMjY1Mw==",
      "text": "Code Exemple Aztec"
    },
    {
      "format": "QRCODE",
      "data": "Q09ORAp0YWQ9MTcwNDA2OTAwMAp0YWw9VEhJUkQKdHNjPTIKeHA9MTcxNTYyMjY1Mw==",
      "text": "Code Exemple QR"
    },
    // ...
  ]
}

Request Parameters

sHMAC: string HMAC key	Example abc	Required
userToken: string Token de sécurité	Example d7bb15b970e503e8dd67b0b5f907ba18	Required
userId: int Identifiant du profil	Example 4567	Required
belongingId: int Identifiant de la possession pour laquelle récupérer les CB2D	Example 12345	Required
devicePublicKey: ?string Une clé publique du device. Peut-être utilisé pour signer le CB2D exclusivement pour 1 device.	Example <à définir>

Actions

useCode

/feed/actions/useCode.json

Désactive un code d'action et renvoie le contenu de sa payload

Request Parameters

code: string

Code d'action

Example

00cd6812-534d-11ed-bdb2-3aaa1656be25

Required

action: string

Type d'action

Example

LEGACY_PASSWORD_CHANGE

Required

Adyen

ipn

POST

/feed/adyen/ipn.json

Flux de notification Adyen

Request Parameters

eventCode: string Évenèment ayant provoqué la notification	Example AUTHORISATION	Required
success: string Succès de l'évenèment	Example true	Required
pspReference: string Réfèrence de la transaction Adyen	Example 8825543930046772	Required
merchantReference: string Identifiant de la commande	Example 2490688361554392928	Required

redirect

/feed/adyen/redirect.json

Redirection de fin de paiement Adyen

Request Parameters

authResult: string

Résultat du paiement

Example

AUTHORISED

Required

merchantReference: string

Identifiant de la commande

Example

2490688361554392928

Required

Authentication

Get An Authorization State

POST

/feed/authentication/authorizationState.json

Génère un state d'autorisation pour un réseau et un fournisseur d'authentification donnés

Response Payload Example

{
  "state": "00da51c6-e6d5-11ed-916c-2av7a90ff1d7"
}

Request Parameters

networkId: int Internal ID of the network				Required
authProviderId: int Internal ID of the authentication provider				Required
redirectUri: string The URI to redirect to after authorization				Required
sHMAC: string The HMAC signature of the request				Required

Exchange An Authorization State

POST

/feed/authentication/exchangeAuthorizationCode.json

Échange un code d'autorisation contre un jeton d'accès

Response Payload Example

{
  "tokenType": "Bearer",
  "accessToken": "abc...",
  "refreshToken": "def...",
  "expiresIn": 3600,
  "idToken": "ghi..."
}

Request Parameters

code: string

The authorization code to exchange

Required

state: string

The state to validate the request

Required

sHMAC: string

The HMAC signature of the request

Required

Document

getDocuments

POST
GET

/feed/document/getDocuments.json

Récupérer les types de documents justificatifs pour un réseau

Request Parameters

networkId: int

l'Identifiant du réseau

Required

sHMAC: string

HMAC key

Required

locale: ?string

Langue de traduction

Example

fr_FR

createDocumentsSubmission

POST

/feed/document/createDocumentsSubmission.json

Création d'une demande

Request Parameters

userToken: string Access token de l’utilisateur		Required
item_id: string Identifiant du produit		Required
document_ids: json Liste des documents constituant la demande		Required
sHMAC: string HMAC key		Required
userId: ?int Identifiant du l'utilisateur ou du profil	Example 4567
originAgent: ?string Agent de l'origine de connexion	Example eshop-v3.4.3
originType: ?string Type d'origine de connexion. Case sensitive	Example ESHOP

updateDocumentsSubmission

POST

/feed/document/updateDocumentsSubmission.json

Modification d'une demande

Request Parameters

userToken: string Access token de l’utilisateur		Required
submission_id: string Identifiant de la demande		Required
document_ids: json Liste des documents à modifier dans la demande		Required
sHMAC: string HMAC key		Required
userId: ?int Identifiant du l'utilisateur ou du profil	Example 4567

getUserDocuments

POST
GET

/feed/document/getUserDocuments.json

Récupérer les pièces justificatives d'un utilisateur

Request Parameters

userToken: string Access token de l’utilisateur				Required
sHMAC: string HMAC key				Required
userId: ?int Identifiant de l'utilisateur ou profil
networkId: ?int ID du réseau

getUserDocumentSubmissions

POST
GET

/feed/document/getUserDocumentSubmissions.json

Récupération des soumissions documents de l'utilisateur

Request Parameters

userToken: string Access token de l’utilisateur		Required
sHMAC: string HMAC key		Required
userId: ?int Identifiant de l'utilisateur ou profil
networkId: ?int ID d'un réseau
activeProductOnly: ?int Active un filtre pour ne renvoyer que les demandes des produits actifs	Example 1

Get Document File Download URL

/feed/document/fileDownloadUrl.json

Given a document ID, resolves a download URL from storage provider

Request Parameters

sHMAC: string

HMAC key

Required

userToken: string

Access token de l’utilisateur

Required

documentId: string

Identifiant unique du document

Required

Fac

Instant payment notification

POST

/feed/fac/ipn.json

Notification de paiement

Request Parameters

Response: string

Notification

Required

TransactionIdentifier: string

Identifiant de transaction

Required

SpiToken: string

Token d'authentification

Required

Files

Upload a file

POST

/feed/files/upload.json

This is a temporary route to handle uploads before migrating entierly to GCP

Request Parameters

id: ?string

Identifiant du fichier

file: ?file

Données du fichier

token: ?string

Token d'autorisation

FNMPay

Instant payment notification

POST

/feed/fnmpay/ipn.json

Notification de paiement

Request Parameters

paymentId: string Identifiant de paiement				Required
orderId: string Numéro de commande				Required
amount: int Montant du paiement				Required
transactionCode: string Résultat du paiement				Required
currency: ?string Devise du paiement
descriptionCode: ?string Description du résultat du paiement
executedAt: ?string Date d'exécution du paiement
state: ?string État du paiement
brand: ?string Marque de la carte de paiement
transactionType: ?string Type de transaction
customer: ?json Informations du client
walletId: ?string Identifiant du portefeuille du client
token: ?string Identifiant de la carte de paiement
cardExpDate: ?string Date d'expiration de la carte de paiement
maskedPan: ?string Numéro de carte de paiement masqué

GlobalPayments

redirect

POST

/feed/globalpayments/redirect.json

Redirection de fin de paiement Global Payments

Request Parameters

MERCHANT_ID: string

GlobalPayments merchant ID

Required

ACCOUNT: string

Merchant sub-account

Required

Intelligence

sendGeolocation

POST

/feed/intelligence/sendGeolocation.json

Envoi de la geolocalisation

Request Parameters

userToken: string Token de sécurité	Example f3fce111bb549fd2f6ff01015d76925a	Required
lat: string Latitude	Example 48.830410	Required
lng: string Longitude	Example 2.218771	Required
action: string Action (Liste: BUY)	Example BUY	Required
sHMAC: string HMAC key		Required
network_id: ?int Identifiant du réseau	Example 5

Media

uploadMedia

POST

/feed/media/uploadMedia.json

Uploader la photo du profil utilisateur

Request Parameters

media: file

Image à uploader au format File

Required

userToken: string

Token de connexion

Required

user_id: string

Identifiant utilisateur

Required

uploadDocument

POST

/feed/media/uploadDocument.json

[DEPRECATED] Uploader les documents justificatifs

Request Parameters

document: file Document ou Image à uploader au format File		Required
document_type: string Type du document ou Image à uploader	Example 1	Required
userToken: string Token de connexion		Required
user_id: string Identifiant utilisateur		Required

Moneris

callback

POST

/feed/moneris/callback.json

Intermediate callback route

Request Parameters

payload: string

Payload

Example

tg44W+GLZqEzR5ndx+PTA5LCxaxUO5Wc9gpS33M9XeAiC1iehnnLKm9cUSg8SF7pK

Required

signature: string

Signature

Example

azert12345

Required

NAPS Payment Gateway

This is a description

NAPS IPN

POST
GET

/feed/naps/ipn.json

Route to be called directly by NAPS servers on transaction

Request Parameters

repauto: string Statut de la transaction	Example 00	Required
idcommande: string Identifiant de la commande	Example 181827	Required
montant: string Montant de la transaction	Example 8.00	Required
numTrans: string Numéro de la transaction	Example 205463	Required
numAuto: string Numéro d'autorisation	Example 181827	Required
signature: string Signature de la transaction	Example 284e8c08921e9cfec9dc63b7aa57de79	Required

NAPS Webview Callback

POST
GET

/feed/naps/callback.json

Intermediate callback to avoid badly encoded URLs

Request Parameters

codecmr: string

ID commerçant

Example

181827

Required

error: ?string

Type d'erreur

Example

timeout

data: ?string

Payload chiffrée de la transaction

Example

284e8c08921e9cfec9dc63b7aa57de79284e8c08921e9cfec9dc63b7aa57de79284e8c08921e9cfec9dc63b7aa57de79

Networks

getNetworks

GET
POST

/feed/networks/getNetworks.json

Flux Réseau : liste de tous les réseaux

Request Parameters

universal: ?int

1 si Ticket Universel

Example

client: ?string

Client identifier

Example

nouvelle_aquitaine

getNetworkConfiguration

GET
POST

/feed/networks/getNetworkConfiguration.json

Retourne la configuration du réseau

Request Parameters

domain: ?string

Nom de domaine d'accès

id: ?int

L'identifiant du réseau

getProfileStatus

GET
POST

/feed/networks/getProfileStatus.json

Flux Réseau : liste des statut défini par le réseau

Request Parameters

network_id: int

l'identifiant du réseau

Required

getNetworkStops

/feed/networks/getNetworkStops.json

Retourne tous les arrêts du réseau

Request Parameters

network_id: int

Identifiant du réseau

Example

Required

getSchoolConfiguration

/feed/networks/getSchoolConfiguration.json

Retourne la configuration spécifique aux boutiques scolaires

Request Parameters

networkId: int

Identifiant du réseau

Example

Required

Get Network Public Auth Configuration

/feed/networks/getAuthenticationConfiguration.json

Gets public auth configuration for integration

Request Parameters

networkId: int

Identifiant du réseau

Example

Required

Get Network Public Qualification Validation Configuration

/feed/networks/getQualificationValidationConfiguration.json

Gets public qualification validation configurations for integration

Request Parameters

networkId: int

Identifiant du réseau

Example

166

Required

Get Network Collect Sites

/feed/networks/collectSites.json

Gets collect sites for a given network

Request Parameters

id: int

Identifiant du réseau

Example

Required

Search Network Target Customer

/feed/networks/searchTargetCustomers.json

Searches through the network customers for action targets

Could be used for transfers, external order recipients, ...

Response Payload Example

{
  "customers": [
    {
      "id": "1841",
      "avatarUrl": "https://pictures.ticket.airweb.fr/avatars/1841-1234.jpg",
      "email": "customer@email.com",
      "firstName": "Jean-Michel",
      "lastName": "Voyageur"
    },
    // ...
  ]
}

Request Parameters

userId: int Identifiant du compte usager utilisé	Example 4567	Required
userToken: string Token de session de l'usager	Example d7bb15b970e503e8dd67b0b5f907ba18	Required
networkId: string Identifiants des réseaux dans lesquel rechercher	Example 12,498	Required
sHMAC: string HMAC key	Example abc	Required
searchCustomerId: ?string Filtre par identifiant interne	Example 8645940
searchCustomerEmail: ?string Filtre par adresse email	Example customer@airweb.fr
searchLimit: ?int Limite du nombre de résultats	Example 10

Get Network Orbs

/feed/networks/orbs.json

Gets control circles for next days.

Request Parameters

userToken: string

Token de sécurité

Required

This is the order namespace

Place an order

POST

/feed/order/placeOrder.json

Préparation de la commande

Request Parameters

sHMAC: string HMAC key				Required
user_id: string
userToken: string
wallet: JSON
shipping: int
shipping_address: JSON
fields: JSON
installments: int
register_card: int
cardId: string
dematerializedTickets: JSON
subscriptionTickets: JSON
odTickets: JSON
ticketsRecipients: JSON
lang: string
voucher: string
provider: string
provider_oid: string
payment_provider: string
payment_method: string
origin_type: string
origin_agent: string
deviceCode: string

Compute the amount of an order

POST

/feed/order/computeAmount.json

Calcul du montant de la commande

Request Parameters

sHMAC: string HMAC key				Required
userToken: string
wallet: JSON
odTickets: JSON
voucher: string

Print an order V2

POST

/feed/order/printOrder.json

service permettant de générer une facture V2

Request Parameters

orderId: string

userToken: string

locale: ?string

Locale pour la traduction

Example

fr_FR

Print an order V3

POST

/feed/order/printOrderV3.json

service permettant de générer une facture V3

Request Parameters

orderId: string

userToken: string

locale: ?string

Locale pour la traduction

Example

fr_FR

Returns order history

POST
GET

/feed/order/history.json

Récuperer l'historique des commandes

Request Parameters

userToken: string

token de session

Required

networkId: ?int

Identifiant d'un réseau

Example

Gets a list of orders

/feed/order/getOrders.json

Récuperer les détails des commandes de l'utilisateur

Request Parameters

orderId: string

userToken: string

networkId: string

Redeem a voucher

POST

/feed/order/redeemVoucher.json

Redeem a voucher

Request Parameters

userToken: string
voucher: string
networkId: string
sHMAC: string
support: ?string Support du produit			Example DEMATERIALIZED
issuer: ?string Issuer pour la commande qui sera générée			Example airweb

Create an order

POST

/feed/order/create.json

New proper way to create an order

Request Parameters

userToken: string

Customer authentication token

Example

abcdef123

Required

networkId: string

Internal ID of the network the order is addressed to

Example

45

Required

articles: OrderArticleRequest

An array of articles with necessary data

Required

⌄

productId: int

A valid ID of a product to order

Example

1234

Required

quantity: ?int

The number of products you need

support: ?string

The type of support the article should be issued on

Enum

"PHYSICAL" "MEDIA" "COLLECT" "DEMATERIALIZED"

Default

"DEMATERIALIZED"

fields: ?object

A key-value object of fields

startingAt: ?string

Ticket start date

endingAt: ?string

Ticket end date

mediaCode: ?string

The code of a media to link the article to

mediaId: ?int

The internal ID of a media to link the article to

customerId: ?int

Recipient user ID

isSubscription: ?bool

Whether the article should be considered as a subscription

reservation: ?OrderArticleReservationRequest

⌄

token: ?string

seats: ?int

prmSeats: ?int

userProvider: ?string

payment: ?OrderPaymentRequest

Payment information object

⌄

cardId: int				Required
cardCode: string				Required
method: ?string
provider: ?string
register: ?bool
installmentNumber: ?int
installmentRecurrence: ?int (?)
redirection: ?string URL the payment should redirect to after process (success or error)
currency: ?string

shipping: ?OrderShippingRequest

Optional shipping data in case of shipping support

⌄

lines: string[] An array of lines constituting the body of the address				Required
zip: string ZIP/Postal Code of the recipient				Required
city: string Destination city				Required
state: ?string Country and/or state of residence
line1: ?string				Deprecated
line2: ?string				Deprecated
line3: ?string				Deprecated

collect: ?OrderCollectRequest

Optional collect data in case of collect support

⌄

siteId: ?int

Network collect site identifier

vouchers: ?string[]

An optional array of voucher/coupons

issuer: ?string

issuerOid: ?string

originType: ?string

originAgent: ?string

deviceCode: ?string

locale: ?string

Optional locale to be used in payment process

Verify Order

POST

/feed/order/verify.json

Verifies an Order request and computes the expected totals.

Possible errors are:

ORDER_ARTICLES_MISSING
ORDER_ARTICLE_PRODUCT_MISSING
ORDER_ARTICLE_PRODUCT_INVALID
ORDER_ARTICLE_PRODUCT_FORBIDDEN
ORDER_ARTICLE_RECIPIENT_INVALID
ORDER_ARTICLE_RECIPIENT_FORBIDDEN
ORDER_ARTICLE_RECIPIENT_AVATAR_MISSING
ORDER_ARTICLE_RECIPIENT_BIRTHDATE_MISSING
ORDER_ARTICLE_RECIPIENT_BILLING_ADDRESS_MISSING
ORDER_ARTICLE_SHIPPING_ADDRESS_MISSING
GUEST_ORDER_NOT_ALLOWED
DEVICE_CODE_REQUIRED
ORDER_ARTICLE_FIELD_MISSING
ORDER_ARTICLE_RESERVATION_NEEDED
ORDER_ARTICLE_RESERVATION_TOKEN_INVALID
ORDER_ARTICLE_RESERVATION_SEATS_INVALID
ORDER_ARTICLE_RESERVATION_ERROR
ORDER_ARTICLE_MEDIA_INVALID
ORDER_ARTICLE_MEDIA_FORBIDDEN
ORDER_ARTICLE_MEDIA_MISSING
ORDER_ARTICLE_CUSTOMER_MAX_OWNED_REACHED
ORDER_ARTICLE_CUSTOMER_INVALID
ORDER_ARTICLE_DOCUMENT_MISSING
ORDER_ARTICLE_DOCUMENT_INVALID
ORDER_ARTICLE_DOCUMENT_NOT_VALID_YET
ORDER_ARTICLE_SUBSCRIPTION_UNAVAILABLE
ORDER_ARTICLE_PROVIDER_RESERVATION_HOLD_NOT_FOUND
ORDER_ARTICLE_PROVIDER_RESERVATION_ERROR
ORDER_ARTICLE_PROVIDER_PRODUCT_UNSELLABLE
ORDER_ARTICLE_PROVIDER_UNAVAILABLE
ORDER_ARTICLE_PROVIDER_ERROR
ORDER_ARTICLE_TOKEN_INVALID
ORDER_ARTICLE_CUSTOMER_MAX_OWNED_REACHED
ORDER_SHIPPING_ADDRESS_INVALID
ORDER_AMOUNT_LIMIT_EXCEEDED
ORDER_PAYMENT_INSTALLMENT_CONFLICT
ORDER_PAYMENT_METHOD_CONFLICT
ORDER_PAYMENT_SUBSCRIPTION_CONFLICT
ORDER_PAYMENT_NETWORK_SUBSCRIPTION_NOT_ALLOWED

Request Parameters

userToken: string

Required

networkId: string

Internal ID of the network the order is addressed to

Required

articles: OrderArticleRequest

Required

⌄

productId: int

A valid ID of a product to order

Example

1234

Required

quantity: ?int

The number of products you need

support: ?string

The type of support the article should be issued on

Enum

"PHYSICAL" "MEDIA" "COLLECT" "DEMATERIALIZED"

Default

"DEMATERIALIZED"

fields: ?object

A key-value object of fields

startingAt: ?string

Ticket start date

endingAt: ?string

Ticket end date

mediaCode: ?string

The code of a media to link the article to

mediaId: ?int

The internal ID of a media to link the article to

customerId: ?int

Recipient user ID

isSubscription: ?bool

Whether the article should be considered as a subscription

reservation: ?OrderArticleReservationRequest

⌄

token: ?string

seats: ?int

prmSeats: ?int

vouchers: string[]

An optionnal array of voucher/coupons

Required

deviceCode: string|null

Required

collect: ?OrderCollectRequest

Optional collect data in case of collect support

⌄

siteId: ?int

Network collect site identifier

payment: ?OrderPaymentRequest

Payment information object

⌄

cardId: int				Required
cardCode: string				Required
method: ?string
provider: ?string
register: ?bool
installmentNumber: ?int
installmentRecurrence: ?int (?)
redirection: ?string URL the payment should redirect to after process (success or error)
currency: ?string

shipping: ?OrderShippingRequest

Optional shipping data in case of shipping support

⌄

lines: string[] An array of lines constituting the body of the address				Required
zip: string ZIP/Postal Code of the recipient				Required
city: string Destination city				Required
state: ?string Country and/or state of residence
line1: ?string				Deprecated
line2: ?string				Deprecated
line3: ?string				Deprecated

Verify Order (with details)

POST

/feed/order/verifyDetailed.json

Verifies an Order request and computes the expected totals.

Will return detailed informations about errors in the order.

Possible errors are:

ORDER_ARTICLES_MISSING
ORDER_ARTICLE_PRODUCT_MISSING
ORDER_ARTICLE_PRODUCT_INVALID
ORDER_ARTICLE_PRODUCT_FORBIDDEN
ORDER_ARTICLE_RECIPIENT_INVALID
ORDER_ARTICLE_RECIPIENT_FORBIDDEN
ORDER_ARTICLE_RECIPIENT_AVATAR_MISSING
ORDER_ARTICLE_RECIPIENT_BIRTHDATE_MISSING
ORDER_ARTICLE_RECIPIENT_BILLING_ADDRESS_MISSING
ORDER_ARTICLE_SHIPPING_ADDRESS_MISSING
GUEST_ORDER_NOT_ALLOWED
DEVICE_CODE_REQUIRED
ORDER_ARTICLE_FIELD_MISSING
ORDER_ARTICLE_RESERVATION_NEEDED
ORDER_ARTICLE_RESERVATION_TOKEN_INVALID
ORDER_ARTICLE_RESERVATION_SEATS_INVALID
ORDER_ARTICLE_RESERVATION_ERROR
ORDER_ARTICLE_MEDIA_INVALID
ORDER_ARTICLE_MEDIA_FORBIDDEN
ORDER_ARTICLE_MEDIA_MISSING
ORDER_ARTICLE_CUSTOMER_MAX_OWNED_REACHED
ORDER_ARTICLE_CUSTOMER_INVALID
ORDER_ARTICLE_DOCUMENT_MISSING
ORDER_ARTICLE_DOCUMENT_INVALID
ORDER_ARTICLE_DOCUMENT_NOT_VALID_YET
ORDER_ARTICLE_SUBSCRIPTION_UNAVAILABLE
ORDER_ARTICLE_PROVIDER_RESERVATION_HOLD_NOT_FOUND
ORDER_ARTICLE_PROVIDER_RESERVATION_ERROR
ORDER_ARTICLE_PROVIDER_PRODUCT_UNSELLABLE
ORDER_ARTICLE_PROVIDER_UNAVAILABLE
ORDER_ARTICLE_PROVIDER_ERROR
ORDER_ARTICLE_TOKEN_INVALID
ORDER_SHIPPING_ADDRESS_INVALID
ORDER_AMOUNT_LIMIT_EXCEEDED
ORDER_PAYMENT_INSTALLMENT_CONFLICT
ORDER_PAYMENT_METHOD_CONFLICT
ORDER_PAYMENT_SUBSCRIPTION_CONFLICT
ORDER_PAYMENT_NETWORK_SUBSCRIPTION_NOT_ALLOWED

Request Parameters

userToken: string

Required

networkId: string

Internal ID of the network the order is addressed to

Required

articles: OrderArticleRequest

Required

⌄

productId: int

A valid ID of a product to order

Example

1234

Required

quantity: ?int

The number of products you need

support: ?string

The type of support the article should be issued on

Enum

"PHYSICAL" "MEDIA" "COLLECT" "DEMATERIALIZED"

Default

"DEMATERIALIZED"

fields: ?object

A key-value object of fields

startingAt: ?string

Ticket start date

endingAt: ?string

Ticket end date

mediaCode: ?string

The code of a media to link the article to

mediaId: ?int

The internal ID of a media to link the article to

customerId: ?int

Recipient user ID

isSubscription: ?bool

Whether the article should be considered as a subscription

reservation: ?OrderArticleReservationRequest

⌄

token: ?string

seats: ?int

prmSeats: ?int

vouchers: string[]

An optionnal array of voucher/coupons

Required

deviceCode: string|null

Required

collect: ?OrderCollectRequest

Optional collect data in case of collect support

⌄

siteId: ?int

Network collect site identifier

payment: ?OrderPaymentRequest

Payment information object

⌄

cardId: int				Required
cardCode: string				Required
method: ?string
provider: ?string
register: ?bool
installmentNumber: ?int
installmentRecurrence: ?int (?)
redirection: ?string URL the payment should redirect to after process (success or error)
currency: ?string

shipping: ?OrderShippingRequest

Optional shipping data in case of shipping support

⌄

lines: string[] An array of lines constituting the body of the address				Required
zip: string ZIP/Postal Code of the recipient				Required
city: string Destination city				Required
state: ?string Country and/or state of residence
line1: ?string				Deprecated
line2: ?string				Deprecated
line3: ?string				Deprecated

Paperwork

lastSubmissionByProducts

/feed/paperwork/lastSubmissionByProducts.json

Récupérer la liste des dernière demandes de validation de pièces justificatives pour chaque produit

Request Parameters

userId: int Identifiant de l'utilisateur	Example 6333	Required
networkId: ?int Identifiant du réseau	Example 64
clientId: ?int Identifiant du client	Example 6
client: ?string Slug de l'application région	Example modalis
productId: ?int Identifiant du produit	Example 6333
locale: ?string Locale de l'utilisateur	Example fr_FR
activeProductOnly: ?int Active un filtre pour ne renvoyer que les demandes des produits actifs	Example 1

Creates A Paperwork Document

POST

/feed/paperwork/createDocument.json

Crée un document pour un utilisateur

Response Payload Example

{
  "document": {
    "id": 123,
    "paperworkTypeId": 456,
    "url": "gcs:6e5dd9e2-6b03-11ed-a8d9-8e575aecb6qb.jpg",
    "status": "PENDING',
    "providerId": 720,
    "providerQualificationRef": "aqw-414",
    "createdAt": "2025-03-24T16:31:27Z",
    "startingAt": "2025-03-24T16:31:27Z",
    "expiresAt": "2025-08-13T07:45:00Z",
    "deletedAt": null,
  }
}

Request Parameters

paperworkTypeId: int Internal ID of the paperwork type				Required
userToken: string User authentication token				Required
sHMAC: string The HMAC signature of the request				Required
file: ?array The file to upload
qualificationProviderId: ?int Internal ID of the qualification provider
qualificationProviderInput: ?string Form or access token to be provided to the provider for qualification validation
userId: ?int Internal ID of the user

Payment

acknowledge

POST

/feed/payment/acknowledge.json

Acknowledge a payment

Request Parameters

status: string Transaction status (SUCCESS, ERROR, or CANCELLED)				Required
providerTid: string Provider transaction ID				Required
accessToken: string Access API token				Required
sHMAC: string HMAC key				Required
orderId: ?string Order ID
installmentId: ?string Installment ID
provider: ?string Transaction provider
paymentMethod: ?string Payment method
paymentInfo: ?string An informative text concerning the payment of the order

Payzen

ipn

POST

/feed/payzen/ipn.json

Flux de notification PayZen

Request Parameters

signature: string Signature	Example be661508f4f13c70259b4058af1b3b3e61c4d037	Required
vads_order_id: ?string Identifiant de la commande	Example 474111475508838
vads_trans_id: ?string Identifiant de la transaction	Example 000001
vads_trans_status: ?string Résultat du paiement
vads_url_check_src: ?string Évènement déclencheur
vads_payment_config: ?string Type du paiement : comptant ou en plusieurs fois
vads_identifier: ?string Identifiant de la carte de paiement
vads_sequence_number: ?int Numéro de séquence de la transaction

smartFormIpn

POST

/feed/payzen/smartFormIpn.json

Flux de notification PayZen pour les paiements passés par la solution SmartForm

Request Parameters

kr-hash-key: string Type de clé pour signer le kr-answer				Required
kr-hash-algorithm: string Algorithme utilisé pour calculer le hash				Required
kr-answer: string Objet contenant le résultat du paiement, encodé en JSON				Required
kr-answer-type: string Type de l'objet JSON contenu dans kr-answer				Required
kr-hash: string Hash de l'objet JSON stocké dans kr-answer pour authentifier l'authenticité de la réponse				Required

smartFormWebViewConfig

/feed/payzen/smartFormWebViewConfig.json

Récupère le certificat à retourner lors de la verification d’Apple Pay

Request Parameters

sHMAC: string

Signature HMAC de la requête

Required

domain: string

Domaine de l'application

Required

Products

getProducts

POST
GET

/feed/products/getProducts.json

Flux - Les items du shop

Request Parameters

sHMAC: string HMAC key		Required
network_id: ?int l'Identifiant du réseau
userToken: ?string le token utilisateur
lang: ?string Langue	Example fr
type: ?string [DEPRECATED] destination mobile et/ou web	Example 1
sale_channels: ?json canal de vente	Example ["AIRWEB_TICKET_ESHOP","AIRWEB_TICKET_APP","AIRWEB_TIXIPASS"]
tixipass: ?int 1 si tixiPASS ; n'est pris en compte que si l'utilsateur est déconnecté	Example 1
od: ?int 1 si origin destination	Example 1
tags: ?json Tableau de tags à rechercher	Example ["urban", "scolar"]
od_origin_stop: ?string Arrêt de départ
od_destination_stop: ?string Arrêt de destination
od_via_key: ?string Clé du trajet alternatif
od_timestamp: ?int Date/heure souhaitée de voyage
client: ?string Client Slug

Compute Journey Price

/feed/products/computeJourneyPrice.json

Will compute the price of a product if it has a Journey matrix configured

Request Parameters

sHMAC: string HMAC signature				Required
productId: int Identifiant du produit dont le prix doit être calculé				Required
journeyOriginKey: string Code de l'origine dans la matrice Journey				Required
journeyDestinationKey: string Code de la destination dans la matrice Journey				Required
journeyViaKey: ?string Code du via dans la matrice Journey

List Media Products

/feed/products/media.json

Retrieves a list of (simplified) products that can be bought on a media (inluding externally provided media)

Request Parameters

sHMAC: string HMAC signature		Required
userToken: string Token utilisateur		Required
mediaId: int Identifiant du media	Example 486351	Required
networkId: ?int Identifiant du réseau	Example 456

RedSys

Handles RedSys payment notifications

POST

/feed/redsys/ipn.json

IPN entrypoint for RedSys payment provider

Request Parameters

Ds_SignatureVersion: string

Signature version

Example

HMAC_SHA256_V1

Required

Ds_MerchantParameters: string

JSON-formatted data, stringified and Base64-encoded

Example

eyJEc19BbW91bnQiOiIxNDUiLCJEc19DdXJyZW5jeSI6Ijk3

Required

Ds_Signature: string

Signature of Ds_MerchantParameters

Example

QVxoXwwp919v7XYjyBjhr1VXozESRosHPb3PDW

Required

Shop

Get Catalog

/feed/shop/catalog.json

Returns a list of products and categories with some information about them

Request Parameters

sHMAC: string The HMAC signature of the request				Required
networkId: int The ID of the network to get the catalog from				Required
client: ?string Slug of the client to get the catalog from
saleChannels: ?string List of sale channels separated by a comma
tags: ?string List of exclusive tags to filter the catalog separated by a comma

Search Product Reservation Trip Locations

/feed/shop/searchProductReservationTripLocations.json

Returns a list of reservation trip locations for a given product

Request Parameters

productId: int

ID du produit

Example

Required

departureLocationRef: ?string

Référence du lieu de départ

Example

saint-cloud

Search Product Reservation Trips

/feed/shop/searchProductReservationTrips.json

Returns a list of reservation trips for a given product

Request Parameters

productId: int ID du produit				Required
userToken: string Token de l'utilisateur				Required
userId: int ID de l'utilisateur				Required
departureLocationRef: string Référence de la localisation de départ				Required
arrivalLocationRef: string Référence de la localisation d'arrivée				Required
seatCount: ?int Nombre de places que l'utilisateur souhaite réserver
departureDateAfter: ?string Date de départ après laquelle chercher des créneaux
departureDateBefore: ?string Date de départ après laquelle chercher des créneaux
arrivalDateBefore: ?string Date d'arrivée avant laquelle chercher des créneaux
arrivalDateAfter: ?string Date d'arrivée avant laquelle chercher des créneaux
sortBy: ?string Tri des résultats

Acquire Product Reservation Hold

POST

/feed/shop/acquireProductReservationHold.json

Acquires a reservation hold for a given product

Request Parameters

productId: int ID du produit				Required
userToken: string Token de l'utilisateur				Required
userId: int ID de l'utilisateur				Required
selectionToken: string Token du créneau de réservation				Required
reservationGroupVariantRef: ?string Référence du sous-produit dans la configuration du groupe de réservation

Subscriptions

List Customer Subscriptions

/feed/subscriptions/list.json

Gets a list of the users subscriptions

Request Parameters

userToken: string

le token utilisateur

Required

Get Subscription Details

/feed/subscriptions/get.json

Gets a single subscription with details

Request Parameters

userToken: string

Le token utilisateur

Required

subscriptionId: string

Identifiant de l'abonnement

Required

Update Subscription Card

POST

/feed/subscriptions/updateCard.json

Updates the card associated with a subscription

Request Parameters

userToken: string

le token utilisateur

Required

subscriptionId: string

Identifiant de l'abonnement

Required

cardId: int

Identifiant du moyen de paiement

Required

Terminate Subscription

POST
DELETE

/feed/subscriptions/terminate.json

Requests a (delayed) termination of the subscription

Request Parameters

userToken: string

Le token utilisateur

Required

subscriptionId: string

Identifiant de l'abonnement

Required

locale: ?string

Langue de l'utilisateur

Example

fr_FR

SycaPay

SycaPay IPN

POST

/feed/sycapay/ipn.json

Handles SycaPay Instant Payment Notifications

System

Get System Keys

/feed/system/keys.json

Retourne une liste des clés publiques du système

Response Payload Example

{
    "keys": [
        {
            "id": 12345,
            "algorithm": "EC",
            "publicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEFq4lXbh2rejJQBdg27LE4SpsY4bsFL1oyHg1cOQ95wSxbKPtWH5H99f0H5RAg1g2oiaXKu+SqGccJkW1PDeLtg=="
        },
        {
            "id": 6789,
            "algorithm": "EC",
            "publicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEFq4lXbh2rejJQBdg27LE4SpsY4bsFL1oyHg1cOQ95wSxbKPtWH5H99f0H5RAg1g2oiaXKu+SqGccJkW1PDeLtg=="
        },
        // ...
    ]
}

Terms

getTermsOfUse

GET
POST

/feed/terms/getTermsOfUse.json

Flux CGV : permet de récuperer les CGV d'un réseau

Request Parameters

networkId: int

Identifiant du réseau

Required

lang: ?string

Langue souhaitée

getTixiPassTermsOfUse

/feed/terms/getTixiPassTermsOfUse.json

Flux CGV : permet de récuperer les CGV de TixiPass

getLegalNotice

/feed/terms/getLegalNotice.json

Renvoie les mentions légales du réseau spécifié.

Request Parameters

networkId: int

Identifiant du réseau

Required

lang: ?string

Langue souhaitée

getContact

/feed/terms/getContact.json

Renvoie la page contact du réseau

Request Parameters

networkId: int

Identifiant réseau

Required

lang: ?string

Langue souhaitée

getPrivacyPolicy

/feed/terms/getPrivacyPolicy.json

Renvoie la politique de confidentialité du réseau

Request Parameters

networkId: int

Identifiant réseau

Required

lang: ?string

Langue souhaitée

Tests

Example Documentation Route

GET
POST

/feed/tests/documentation.json

Deprecated

Oh no this route is old, bye. Also some link.

This route does not do anything. It just stands there to give an example of how a route can be documented.

Main Title

Some text

Sub Subtitle

{
  "example": "of some JSON" // could be used for response examples
}

Request Parameters

exampleOldParam: string

Old $methods param

Required

exampleRouteSpecificParam: ?mixed

Parameter specified drectly on the route DocBlock

Test Error Format

GET
POST

/feed/tests/error.json

Throws an error in the requested format.

Is to be used when testing front-end error handling.

Request Parameters

format: string

The type of error to return

Enum

"LEGACY" "ENCAPSULATED" "MODERN"

cors

GET
POST
PUT

/feed/tests/cors.json

Vérifie si la requète passe les CORS ou non

journey

GET
POST

/feed/tests/journey.json

Vérifie si la requète passe les CORS ou non

Request Parameters

matrixId: string Identifiant de la matrice Journey				Required
originHeaderKey: ?string Code de l'origine
destinationHeaderKey: ?string Code de la destination
matrixLayerKey: ?string Clé du calque (optionnel)

Dump Request

GET
POST

/feed/tests/request.json

Simply returns the request data, for diagnosis purposes

Test Cache

GET
POST

/feed/tests/cache.json

Caches some value and returns it to check cache implementation

Request Parameters

cacheKey: string

Clé a stocker en cache

Required

cacheTTL: int

TTL du cache en secondes

Required

cachePool: ?string

Identifiant de l'interface de cache

Test Exchange Token

POST

/feed/tests/exchange.json

Attempts to decode an Exchange Token or returns the error if one is received.

Request Parameters

token: ?string

Token à tester

Test Logger

GET
POST

/feed/tests/logger.json

Creates a log entry with the given parameters

Request Parameters

message: ?string

Message de log

context: ?json

Contexte de log

Ticket

punchTicket

POST

/feed/ticket/punchTicket.json

Flux validation du ticket

Request Parameters

user_id: string Identifiant utilisateur		Required
userToken: string Token de sécurité		Required
sHMAC: string HMAC key		Required
ticketId: ?string Code du ticket
ticketIdentifier: ?string Id du ticket
lat: ?string Latitude
lng: ?string Longitude
qrcode: ?string Contenu du QrCode de validation	Example 2DA5+3
displayFullscreenVersion: ?int La version du token 'fullscreen' attendue	Example 2
displayFullscreenDevicePublicId: ?string ID publique du device pour les display tokens "Fullscreen"	Example a7a2e2ed-36d1-446e-bd75-76cd94b46a9d
displayFullscreenDevicePublicKey: ?string Clé publique du device pour les display tokens "Fullscreen" (encodée en base64url)	Example MDEyMzQ1Njc4OUFCQ0RFRg

Transit

Undocumented function

/feed/transit/getODStops.json

Récupération des arrêts

Request Parameters

network_id: int Identifiant Réseau				Required
product_id: ?int ID du produit
sHMAC: ?string HMAC key
origin_stop: ?string Arrêt de départ

getODTrips

/feed/transit/getODTrips.json

Récupération des trajets possibles

Request Parameters

network_id: int Identifiant Réseau				Required
origin_stop: string Arrêt de départ				Required
destination_stop: string Arrêt de destination				Required
sHMAC: string HMAC key				Required
timestamp: ?int Date/heure souhaitée de voyage
product_id: ?int ID du produit

Vignette

List Vignette Keys

/feed/vignette/keys.json

Retrieves a list of public Keys for Vignette barcodes

Response Payload Example

{
  "keys": [
    {
      "id": 12345,
      "version": 1,
      "publicKey": "pGN0eXByRUxHQU1BTCBQVUJMSUMgS0VZY2VncMJQ5jvo5I8N9WuTMXjOGQp0o2NlZ2fCUHLNBVFOro4JmdFTGleWML1jZWdiwlARXidt4vwhZBiVAoe+Qn3v",
      "disabledAt": null,
      "createdAt": "2020-01-01T00:00:00+00:00"
    },
    {
      "id": 67890,
      "version": 1,
      "publicKey": "pGN0eXByRUxHQU1BTCBQVUJMSUMgS0VZY2VncMJQ5jvo5I8N9WuTMXjOGQp0o2NlZ2fCUHLNBVFOro4JmdFTGleWML1jZWdiwlARXidt4vwhZBiVAoe+Qn3v",
      "disabledAt": "2021-01-01T00:00:00+00:00",
      "createdAt": "2020-01-01T00:00:00+00:00"
    }
    // ...
  ]
}

Request Parameters

sHMAC: string

HMAC key

Required

decode

POST

/feed/vignette/decode.json

Décoder le contenu encodé d'une Affichette

Request Parameters

sHMAC: string

HMAC key

Required

encodedPayload: string

Contenu encodé d'une affichette (base64)

Required

Get Sticker by ID

/feed/vignette/sticker.json

Retreives the configuration and content of a declared Vignette Sticker

Can be used to substitude a Sticker scan, for manual input or in case of damaged barcode

Response Payload Example

{
    "sticker": {
        "id": 12345,
        "networkId": 123,
        "label": "Sticker Label",
        "alias": "ALIAS",
        "targetId": 123,
        "domainId": 123,
        "version": 1,
        "content": {
            "tagRef": "abc-123",
            "networkRef": "TER+TCL",
            "otherProperties": true
        },
        "createdAt": "2025-01-01T00:00:00+00:00",
        "updatedAt": "2025-01-01T00:00:00+00:00"
    },
}

Request Parameters

sHMAC: string

HMAC key

Required

stickerId: int

Identifier of a sticker

Example

Required

Wallet

blueprints

/feed/wallet/blueprints.json

Récupérer la liste des blueprints

Request Parameters

sHMAC: string

HMAC key

Required

id: ?json

Liste d'identifiants de blueprints, pour filtrage

Example

["013e04eb-3c8c-4134-9a7b-98812cadddee"]

networkId: ?json

Liste d'identifiants de réseaux, pour filtrage

Example

["44","64"]

tickets

/feed/wallet/tickets.json

Récupérer la liste des tickets

Request Parameters

sHMAC: string HMAC key		Required
userToken: string Token de sécurité		Required
userId: string Identifiant de l'utilisateur pour lequel on veut récupérer les tickets	Example 23340	Required
id: ?json Liste d'id de tickets, pour filtrage	Example ["8d92dd6c-02da-43ac-b772-27b8f8fdc0e4"]
blueprintId: ?json Liste de blueprints, pour filtrage	Example ["024804cd-d26c-4fe6-b646-585e8ecd938b"]
networkId: ?json Liste d'identifiants de réseaux, pour filtrage	Example ["44","64"]
sessionOnly: ?int 0 pour récupérer tous les tickets de l'usager et 1 pour récupérer les tickets liés à la session en cours seulement
deviceCode: ?string Identifiant de l'appareil, s'il est indiqué : assigne un contrat à un device, sinon assigne un contrat à la session en cours
withDisplay: ?int Demande d'accompagner la réponse des données d'affichage	Example 1
displayFullscreenDevicePublicId: ?string ID publique du device pour les display tokens "Fullscreen"	Example a7a2e2ed-36d1-446e-bd75-76cd94b46a9d
displayFullscreenDevicePublicKey: ?string Clé publique du device pour les display tokens "Fullscreen" (encodée en base64url)	Example MDEyMzQ1Njc4OUFCQ0RFRg

validation

POST

/feed/wallet/validation.json

Valider un contrat

Request Parameters

sHMAC: string HMAC key		Required
userToken: string Token de sécurité		Required
userId: string Identifiant de l'utilisateur pour lequel on veut récupérer les tickets	Example 23340	Required
contractId: string Identifiant du contrat à valider	Example 111a1de303e326b48663c3835500168c	Required
type: string Type de validation	Example PUNCH	Required
networkId: ?int Identifiant de réseaux, pour la localisation de la validation	Example 44
occurredAt: ?string Date à laquelle la validation a eu lieu, à rensigner seulement si la validation est offline	Example 2019-08-24T14:15:22Z
context: ?json Contexte de validation	Example {}

contractAttestation

/feed/wallet/contractAttestation.json

Génère un code de contrôle pour un contrat

Request Parameters

contractId: string Identifiant du contrat à contrôler	Example 9844f4e1-838c-4d97-9788-85e7a123ad63	Required
sHMAC: string HMAC key	Example abc	Required
userToken: string Token de sécurité	Example d7bb15b970e503e8dd67b0b5f907ba18	Required
providerId: ?int Identifiant du générateur de code de contrôle	Example 680
providerSlug: ?string Référence du générateur de code de contrôle	Example ThalesTBM
mediaCode: ?string Identifiant du media	Example 57721656
mediaType: ?string Type du media demandant l'attestation	Example PASS
mediaKey: ?string Clé publique du media	Example 11abc

acquireContract

POST

/feed/wallet/acquireContract.json

Lie un contrat à la session en cours

Request Parameters

sHMAC: string

HMAC key

Required

userToken: string

Token de sécurité

Required

contractIds: json

Identifiants des contrats à lier

Example

["111a1de303e326b48663c3835500168c"]

Required

releaseContract

POST

/feed/wallet/releaseContract.json

Délie un contrat de la session en cours

Request Parameters

sHMAC: string

HMAC key

Required

userToken: string

Token de sécurité

Required

contractIds: json

Identifiants des contrats à délier

Example

["111a1de303e326b48663c3835500168c"]

Required

Transfer Wallet Contract

POST

/feed/wallet/transferContract.json

Transfers a Wallet Contract to another customer and store the transaction for both customers history.

Request Parameters

sHMAC: string The HMAC signature of the request				Required
userToken: string The user token to use to authenticate the request				Required
contractId: string The ID of the contract to transfer				Required
recipientCustomerId: string The ID of the customer to transfer the contract to				Required
sendEmail: bool Sends an email to the both issuer and recipient customers if true				Required

Validates synchronously Wallet Contract

POST

/feed/wallet/validationSync.json

Valider un contrat de manière synchrone (online uniquement)

Request Parameters

sHMAC: string The HMAC signature of the request				Required
userToken: string The user token to use to authenticate the request				Required
customerId: string The ID of the customer to transfer the contract to				Required
contractId: string The ID of the contract to transfer				Required
context: bool Validation context				Required