Docs
ENFR
Tableau de bord
Référence de l’API

Points de terminaison

Les adresses HTTPS où Monerail envoie les événements. 10 au plus par entreprise, test et production confondus. Voir Webhooks pour vérifier les signatures.

L’objet point de terminaison

Attributs
idstring

Identifiant unique (UUID).

livemodeboolean

true en production, false en mode test.

objectstring

Toujours webhook_endpoint.

urlstring

Adresse HTTPS qui reçoit les événements.

eventsarray

Types d’événements suivis. * : tous ; payout.* : tous ceux des paiements.

statusstring
enableddisabled
secretstring

Secret de signature (whsec_…). Seulement dans la réponse 201 d’origine à la création, jamais ensuite.

created_atstring

Date de création, ISO 8601 (UTC).

L’objet point de terminaison
{
  "id": "9a661b6d-2895-414e-b1d1-51e473582cbb",
  "object": "webhook_endpoint",
  "livemode": false,
  "url": "https://example.com/webhooks/monerail",
  "events": [
    "collection.succeeded",
    "payout.*"
  ],
  "status": "enabled",
  "created_at": "2026-10-30T13:47:06.394Z"
}

Créer un point de terminaison

POST/v1/webhook_endpoints

La réponse 201 contient le secret de signature. Conservez-le : il ne sera plus jamais renvoyé, pas même si la requête est rejouée avec la même Idempotency-Key. Si vous le perdez, supprimez le point de terminaison et créez-en un nouveau. Les points de terminaison de production demandent un dossier d’entreprise validé.

Rôles de la clé : Propriétaire ou Développeur

Corps
urlstringRequis

Adresse HTTPS, 500 caractères au plus, sans utilisateur:mot_de_passe@. L’hôte doit être un nom de domaine : les adresses IP sont refusées.

eventsarrayRequis

Types d’événements à recevoir : types exacts, prefixe.* ou *.

Retour

Renvoie le nouvel objet point de terminaison avec 201.

Erreurs à prévoir
HTTPCodeDescription
400url_invalidPas une adresse HTTPS avec un nom de domaine, ou elle contient utilisateur:mot_de_passe@. Les adresses IP sont refusées.
400parameter_invalidUn paramètre a un type ou une valeur incorrects. Voir param.
400limit_reachedVotre entreprise a déjà 10 points de terminaison (test et production confondus).
403permission_deniedLe créateur de la clé n’a pas le rôle requis pour cette opération.
curl https://api.monerail.com/v1/webhook_endpoints \
  -H "Authorization: Bearer $MONERAIL_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/webhooks/monerail",
    "events": [
      "collection.succeeded",
      "payout.*"
    ]
  }'
Réponse201
{
  "id": "9a661b6d-2895-414e-b1d1-51e473582cbb",
  "object": "webhook_endpoint",
  "livemode": false,
  "url": "https://example.com/webhooks/monerail",
  "events": [
    "collection.succeeded",
    "payout.*"
  ],
  "status": "enabled",
  "created_at": "2026-10-30T13:47:06.394Z",
  "secret": "whsec_9b89c8bdc0b89f67637e017c49f9539d68b2132ea7492041"
}

Consulter un point de terminaison

GET/v1/webhook_endpoints/{id}

Le secret n’est pas inclus.

Rôles de la clé : Propriétaire ou Développeur

Paramètres de chemin
idstringRequis

Identifiant du point de terminaison.

Retour

Renvoie l’objet point de terminaison.

Erreurs à prévoir
HTTPCodeDescription
403permission_deniedLe créateur de la clé n’a pas le rôle requis pour cette opération.
404resource_missingAucun objet avec cet identifiant dans ce mode.
curl https://api.monerail.com/v1/webhook_endpoints/9a661b6d-2895-414e-b1d1-51e473582cbb \
  -H "Authorization: Bearer $MONERAIL_KEY"
Réponse200
{
  "id": "9a661b6d-2895-414e-b1d1-51e473582cbb",
  "object": "webhook_endpoint",
  "livemode": false,
  "url": "https://example.com/webhooks/monerail",
  "events": [
    "collection.succeeded",
    "payout.*"
  ],
  "status": "enabled",
  "created_at": "2026-10-30T13:47:06.394Z"
}

Lister les points de terminaison

GET/v1/webhook_endpoints

Du plus récent au plus ancien. Les points de terminaison de test et de production sont listés séparément, selon le mode de la clé.

Rôles de la clé : Propriétaire ou Développeur

Paramètres de requête
limitintegerFacultatifPar défaut 20

Nombre d’objets à renvoyer, de 1 à 100.

starting_afterstringFacultatif

Curseur : l’identifiant du dernier objet de la page précédente.

Retour

Renvoie un objet liste : data contient jusqu’à limit objets webhook_endpoint, et has_more indique s’il en reste.

Erreurs à prévoir
HTTPCodeDescription
403permission_deniedLe créateur de la clé n’a pas le rôle requis pour cette opération.
curl "https://api.monerail.com/v1/webhook_endpoints?limit=10" \
  -H "Authorization: Bearer $MONERAIL_KEY"
Réponse200
{
  "object": "list",
  "url": "/v1/webhook_endpoints",
  "data": [
    {
      "id": "9a661b6d-2895-414e-b1d1-51e473582cbb",
      "object": "webhook_endpoint",
      "livemode": false,
      "url": "https://example.com/webhooks/monerail",
      "events": [
        "collection.succeeded",
        "payout.*"
      ],
      "status": "enabled",
      "created_at": "2026-10-30T13:47:06.394Z"
    }
  ],
  "has_more": false
}

Supprimer un point de terminaison

DELETE/v1/webhook_endpoints/{id}

Arrête tout envoi vers cette adresse, nouvelles tentatives comprises.

Rôles de la clé : Propriétaire ou Développeur

Paramètres de chemin
idstringRequis

Identifiant du point de terminaison.

Retour

Renvoie { id, object, deleted: true }.

Erreurs à prévoir
HTTPCodeDescription
403permission_deniedLe créateur de la clé n’a pas le rôle requis pour cette opération.
404resource_missingAucun objet avec cet identifiant dans ce mode.
curl -X DELETE https://api.monerail.com/v1/webhook_endpoints/9a661b6d-2895-414e-b1d1-51e473582cbb \
  -H "Authorization: Bearer $MONERAIL_KEY"
Réponse200
{
  "id": "9a661b6d-2895-414e-b1d1-51e473582cbb",
  "object": "webhook_endpoint",
  "deleted": true
}