Déposer un fichier d’accusés

POST/v1/acknowledgments

Traduit chaque accusé du fichier, le rattache au lot envoyé qu’il désigne et l’applique : le lot est acquitté, ou refusé avec son code. Un accusé sans lot en attente est gardé non rapproché. La traduction passe par le moteur : 503 en production tant qu’il n’est pas raccordé.

Droit de clé restreinte : batches:write.

Paramètres de requête

limitentier
Le nombre d'objets rendus, de 1 à 100. Par défaut, 25.
starting_aftertexte
Un identifiant : la page qui suit cet objet.
ending_beforetexte
Un identifiant : la page qui précède cet objet.

Corps de la requête

contentstexteobligatoire
Le contenu du fichier, encodé en base 64.
file_nametexte
Le nom du fichier reçu, pour le retrouver.

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/acknowledgments?limit=3 \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"contents":"U0lNQVJMfDEK…","file_name":"ARL0001"}'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/acknowledgments?limit=3', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'contents' => 'U0lNQVJMfDEK…',
        'file_name' => 'ARL0001',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/acknowledgments?limit=3', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    contents: 'U0lNQVJMfDEK…',
    file_name: 'ARL0001'
  }),
})
const object = await response.json()

Réponse 200


{
  "object": "list",
  "url": "https://exemple.fr/hook",
  "has_more": true,
  "data": [
    {
      "id": "obj_…",
      "object": "acknowledgment",
      "result": "positive",
      "batch": "…",
      "matched": true,
      "code": null,
      "label": null,
      "claim": null,
      "invoice_number": null,
      "emitter": null,
      "recipient": null,
      "batch_number": null,
      "batch_date": null,
      "source": "file",
      "file_name": null,
      "received_at": null,
      "livemode": false,
      "created": 1793970000
    }
  ]
}