Déclencher un accusé simulé

POST/v1/test-helpers/batches/{batch}/acknowledgment

Le simulateur écrit le fichier d’accusés de l’organisme destinataire, qui suit le chemin d’un fichier déposé. arl_positive acquitte le lot et ses factures. arl_negative le refuse avec code : 1001 refuse tout le lot (par défaut), 2004 désigne sa première facture, rejetée. Mode test seulement.

Droit de clé restreinte : batches:write.

Mode test seulement

Paramètres de chemin

batchtexteobligatoire
L'identifiant, bat_….

Corps de la requête

scenarioénumérationobligatoire
arl_positive ou arl_negative.
arl_positivearl_negative
codeénumération
Le code de traitement d'un accusé négatif : 1001, 2004 ou 5001.
100120045001

En-têtes

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

Réponse

Rend l’objet lots et fichiers.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/test-helpers/batches/bat_…/acknowledgment \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"scenario":"arl_negative","code":"2004"}'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/test-helpers/batches/bat_…/acknowledgment', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'scenario' => 'arl_negative',
        'code' => '2004',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/test-helpers/batches/bat_…/acknowledgment', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    scenario: 'arl_negative',
    code: '2004'
  }),
})
const object = await response.json()

Réponse 200


{
  "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
}