Passer au contenu

Seqino PDP API (1.0.0)

Seqino PDP API - Modern interface to France's e-Invoicing services

Télécharger la description d'OpenAPI
openapi.json
openapi.yaml
Aperçu
URL
https://pdp.seqino.dev/
Langues
Serveurs
Dev server
https://pdp.seqino.dev/api
Local development server
http://localhost:8052

👥 Clients

Opérations

📋 Mandates

Opérations

📝 Drafts

Opérations

📘 Directory

Opérations

🧾 Invoicing

Opérations

🔄 Lifecycle

Opérations

📊 Reporting

Opérations

📊 Usage

Opérations

⚙️ Settings

Opérations

🔔 Webhooks

Opérations
Webhooks

Get available webhook event types

Requête

Get information about available webhook event types and their payload structures.

This endpoint provides documentation on:

  • All available event types you can subscribe to
  • Example payload structure for each event type
  • Description of what each event represents

Use this information when implementing your webhook endpoint to understand what data you'll receive for each event type.

Sécurité
APIKeyHeader
curl -i -X GET \
  https://pdp.seqino.dev/api/webhooks/event-types \
  -H 'Authorization: YOUR_API_KEY_HERE'

Réponses

List of available webhook event types

Corpsapplication/json
event_typesArray of objects(Event Types)obligatoire

List of available webhook event types

event_types[].​event_typestring(Event Type)obligatoire

Event type identifier

Exemple: "invoice.created"
event_types[].​descriptionstring(Description)obligatoire

Human-readable description of the event

Exemple: "Triggered when a new invoice is created"
event_types[].​example_payloadobject(WebhookEventPayload)obligatoire

Example payload structure for this event type

event_types[].​example_payload.​event_idstring(Event Id)obligatoire

Unique event identifier

Exemple: "evt_abc123def456"
event_types[].​example_payload.​event_typestring(WebhookEventType)obligatoire

Type of event

Enum"webhook.test""invoice.created""invoice.received""invoice.status_updated""mandate.activated""mandate.created""mandate.expired""mandate.failed"
event_types[].​example_payload.​timestampstring(date-time)(Timestamp)obligatoire

Event timestamp

event_types[].​example_payload.​sponsor_idstring(Sponsor Id)obligatoire

Sponsor ID

Exemple: "sandbox-sponsor-1"
event_types[].​example_payload.​dataobject(Data)obligatoire

Event-specific data

Exemple: {"file_name":"invoice_2025.xml","invoice_id":"inv_abc123","source_event_id":"inv_abc123","status":"submitted"}
event_types[].​example_payload.​data.​property name*anypropriété supplémentaire
Réponse
application/json
{
  "event_types": [
    { … }
  ]
}

Get webhook configuration

Requête

Get the current webhook configuration for this sponsor.

Note: The webhook secret is NOT included in this response for security reasons.

Sécurité
APIKeyHeader
curl -i -X GET \
  https://pdp.seqino.dev/api/webhooks \
  -H 'Authorization: YOUR_API_KEY_HERE'

Réponses

Successful Response

Corpsapplication/json
webhook_idstring(Webhook Id)obligatoire

Unique webhook identifier

urlstring(Url)obligatoire

Webhook endpoint URL

eventsArray of strings(Events)obligatoire

Subscribed event types

is_activeboolean(Is Active)obligatoire

Whether the webhook is active

created_atstring(date-time)(Created At)obligatoire

Creation timestamp

last_triggered_atLast Triggered At (string) or Last Triggered At (null)(Last Triggered At)

Last time the webhook was triggered

Any of:

Last time the webhook was triggered

string(date-time)(Last Triggered At)
Réponse
application/json
{
  "webhook_id": "string",
  "url": "string",
  "events": [
    "string"
  ],
  "is_active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_triggered_at": "2019-08-24T14:15:22Z"
}

Create webhook endpoint

Requête

Create a new webhook for the sponsor.

Only one webhook is allowed per sponsor. The secret is returned only on creation. Store it securely - it cannot be retrieved later.

The secret is used to generate HMAC-SHA256 signatures for webhook payloads.

You can optionally specify which events to subscribe to. If not provided, the webhook will receive all available event types.

Sécurité
APIKeyHeader
Corpsapplication/jsonobligatoire
urlstring(uri)(Url)[ 1 .. 2083 ] charactersobligatoire

Webhook endpoint URL (must be HTTPS in production)

Exemple: "https://api.example.com/webhooks/pdp"
eventsArray of Events (strings) or Events (null)(Events)

List of event types to subscribe to. If not provided, subscribes to all events.

Exemple: ["invoice.created"]
Any of:

List of event types to subscribe to. If not provided, subscribes to all events.

non-empty 
curl -i -X POST \
  https://pdp.seqino.dev/api/webhooks \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://api.example.com/webhooks/pdp",
    "events": [
      "invoice.created"
    ]
  }'

Réponses

Webhook created successfully

Corpsapplication/json
webhook_idstring(Webhook Id)obligatoire

Unique webhook identifier

Exemple: "webhook_abc123def456"
urlstring(Url)obligatoire

Webhook endpoint URL

Exemple: "https://api.example.com/webhooks/pdp"
secretstring(Secret)obligatoire

HMAC secret key (only returned once!)

Exemple: "a1b2c3d4...64char_hex_secret"
eventsArray of strings(Events)obligatoire

Subscribed event types

Exemple: ["invoice.created"]
created_atstring(date-time)(Created At)obligatoire

Creation timestamp

messagestring(Message)

Success message

Par défaut "Webhook created successfully"
Réponse
application/json
{
  "webhook_id": "webhook_abc123def456",
  "url": "https://api.example.com/webhooks/pdp",
  "secret": "a1b2c3d4...64char_hex_secret",
  "events": [
    "invoice.created"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "message": "Webhook created successfully"
}

Delete webhook

Requête

Delete the webhook configuration for this sponsor.

Sécurité
APIKeyHeader
curl -i -X DELETE \
  https://pdp.seqino.dev/api/webhooks \
  -H 'Authorization: YOUR_API_KEY_HERE'

Réponses

Successful Response

Réponse
Aucun contenu

Test webhook connection

Requête

Test the webhook connectivity for this sponsor.

Sécurité
APIKeyHeader
curl -i -X POST \
  https://pdp.seqino.dev/api/webhooks/test \
  -H 'Authorization: YOUR_API_KEY_HERE'

Réponses

Successful Response

Corpsapplication/json
any
Réponse
application/json
null

Connectivity TestWebhook

Requête

Triggered when a webhook connectivity is tested.

En-têtes
X-Webhook-Signaturestring(X-Webhook-Signature)obligatoire

HMAC-SHA256 signature of the request body using your webhook secret.

Corpsapplication/jsonobligatoire
event_idstring(Event Id)obligatoire

Unique event identifier

Exemple: "evt_abc123def456"
event_typestring(WebhookEventType)obligatoire

Type of event

Enum"webhook.test""invoice.created""invoice.received""invoice.status_updated""mandate.activated""mandate.created""mandate.expired""mandate.failed"
timestampstring(date-time)(Timestamp)obligatoire

Event timestamp

sponsor_idstring(Sponsor Id)obligatoire

Sponsor ID

Exemple: "sandbox-1234/5678"
dataobject(WebhookTestData)obligatoire

Data payload for webhook.test webhook event.

data.​test_idstring(Test Id)obligatoire

Unique test identifier

Exemple: "test_abc123def456"
application/json
{
  "event_id": "evt_abc123def456",
  "event_type": "webhook.test",
  "timestamp": "2019-08-24T14:15:22Z",
  "sponsor_id": "sandbox-1234/5678",
  "data": {
    "test_id": "test_abc123def456"
  }
}

Réponses

Successful Response

Corpsapplication/json
any
Réponse
application/json
null

Health Check

Requête

Health check endpoint.

curl -i -X GET \
  https://pdp.seqino.dev/health

Réponses

Successful Response

Corpsapplication/json
any
Réponse
application/json
null