Vue d'ensemble
L'API partenaire v3 permet à un partenaire d'émettre des factures payables en espèces dans le réseau de points de vente FDJ.
L'API partenaire v3 expose la facturation : un partenaire crée une facture pour l'un de ses produits, transmet le QR code (DataMatrix) à son client, et le client règle la facture en espèces chez un détaillant FDJ.
Parcours type
Obtenir un jeton d'accès
Le partenaire s'authentifie en client_credentials sur POST /v3/oauth/token et récupère un
jeton Bearer. Voir Authentification.
Créer la facture
POST /v3/products/{productId}/invoices avec une référence partenaire unique, un montant et le
client payeur. La facture est créée au statut OPEN avec un qrCode. Voir
Créer une facture.
Transmettre le QR code au client
Le contenu qrCode.content est encodé en DataMatrix et présenté au client, qui le scanne en point
de vente avant qrCode.expiresAt. Le règlement est décrit dans Règlement.
Pré-autorisation (si activée)
Nirio peut appeler votre serveur avant d'encaisser pour confirmer que la facture peut être réglée. Voir Pré-autorisation.
Suivre la facture
Le partenaire consulte la facture (récupérer, lister)
jusqu'à son passage au statut PAID, ou l'annule tant qu'elle est OPEN.
Endpoints disponibles
| Méthode | Chemin | Description |
|---|---|---|
POST | /v3/products/{productId}/invoices | Créer une facture |
GET | /v3/products/{productId}/invoices | Lister les factures |
GET | /v3/products/{productId}/invoices/{invoiceId} | Récupérer une facture |
POST | /v3/products/{productId}/invoices/{invoiceId}/cancel | Annuler une facture |
URL de base
Les appels passent par la gateway de votre environnement :
https://api.dev.nir.io
Tous les chemins sont préfixés par /v3. La référence API permet de changer
d'environnement directement dans sa liste de serveurs.