Lister les lots

GET/v1/batches

Du plus récent au plus ancien. Un lot ne porte ni acte ni patient.

Droit de clé restreinte : batches:read.

Paramètres de requête

statusénumération
Retient les objets dans cet état.
createdsentacknowledgedfailed
practitionertexte
Les lots d'un praticien, prac_….
transmissiontexte
Les lots d'un fichier, trm_….
fundtexte
Le code de la caisse destinataire.
numbertexte
Le numéro du lot, 042.
created[gte]entier
Créé à partir de cette date, en secondes Unix.
created[lte]entier
Créé jusqu'à cette date, en secondes Unix.
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.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl https://api.ophelix.fr/v1/batches?limit=3 \
  -H "Authorization: Bearer sk_test_…"

PHP


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

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/batches?limit=3', {
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "object": "list",
  "url": "https://exemple.fr/hook",
  "has_more": true,
  "data": [
    {
      "id": "obj_…",
      "object": "batch",
      "status": "created",
      "number": "…",
      "kind": "fse",
      "mode": "secured",
      "third_party": true,
      "practitioner": "…",
      "practice_situation": null,
      "regime_code": null,
      "fund_code": null,
      "transmission": "…",
      "claim_count": 0,
      "amount_cents": 0,
      "failure_code": null,
      "failure_label": null,
      "retransmission": true,
      "rebuilt_from": null,
      "rebuildable": true,
      "sent_at": null,
      "acknowledgment_expected": true,
      "acknowledgment_due_at": null,
      "overdue_at": null,
      "acknowledged_at": null,
      "failed_at": null,
      "rebuilt_at": null,
      "livemode": false,
      "created": 1793970000,
      "updated": null
    }
  ]
}