API REST v1

Documentation API Chorus Pay

L'API Chorus Pay vous permet d'intégrer la création et la gestion de devis pour les collectivités directement dans vos applications.

Simple et rapide

API RESTful intuitive avec des réponses JSON. Créez votre première commande en quelques minutes.

Sécurisé

Authentication par API key, webhooks signés HMAC-SHA256, et conformité aux standards de sécurité.

Extensible

Webhooks temps réel, metadata personnalisées, et configuration flexible pour s'adapter à vos besoins.

Démarrage rapide

Voir Authentification

Créer votre première commande

C'est le payload minimal : une description, au moins une ligne, et l'email du client. Dès la création, un devis est généré et un lien d'identification est envoyé par email à la collectivité, qui n'a plus qu'à suivre le parcours (identification, bon de commande, confirmation) pour déclencher le dépôt sur Chorus Pro.

Shell
curl -X POST https://choruspay.fr/api/v1/pay-links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Prestation de conseil",
    "client_info": {
      "email": "finances@exemple.fr"
    },
    "items": [
      {
        "description": "Prestation de conseil",
        "quantity": 1,
        "unit_price": 100,
        "vat_rate": "20"
      }
    ]
  }'

Réponse

JSON
{
  "id": "pl_d068e8a8cd5045a7a5945dd35f6851f2",
  "status": "created",
  "amount": 120,
  "amount_ht": 100,
  "quote_number": "D-2026-00206",
  "url": "https://choruspay.fr/link/pl_d068e8a8cd5045a7a5945dd35f6851f2",
  "description": "Prestation de conseil",
  "client": {
    "email": "finances@exemple.fr"
  },
  "created_at": "2026-07-24T03:32:58.000Z",
  "items": [
    {
      "total": 100,
      "quantity": 1,
      "vat_rate": "20",
      "unit_price": 100,
      "description": "Prestation de conseil"
    }
  ],
  "metadata": null,
  "endpage_url": null,
  "pdf_url": null,
  "purchase_order_url": null,
  "updated_at": "2026-07-24T03:32:58.000Z",
  "sent_at": null,
  "accepted_at": null,
  "rejected_at": null
}

Informations de base

Base URL

Texte
https://choruspay.fr/api/v1/

Toutes les requêtes API doivent être préfixées par cette URL.

Authentication

Texte
Authorization: Bearer "YOUR_API_KEY"

Authentifiez-vous en incluant votre clé API dans l'en-tête de chaque requête.

Le concept de commande

Une commande est une URL unique qui génère automatiquement :

  1. Un devis au format PDF avec votre branding
  2. Une page de checkout sécurisée pour la collectivité
  3. Un workflow complet : consultation → acceptation → génération du bon de commande

1 devis = 1 commande : chaque commande est unique et correspond à un devis spécifique. Dans l'API, une commande est représentée par la ressource pay_link (nom historique conservé pour la stabilité des endpoints).

Workflow type

1
Créer la commande
2
Envoyer ou rediriger le client
3
Client importe bon de commande
Facture créée et déposée sur Chorus Pro