Déposer un fichier de retours de paiement

POST/v1/remittances

Lit un fichier NOEMIE 580, rapproche chaque retour de sa facture, crée ses paiements et ses rejets, et fait passer chaque facture rapprochée à l’état que ses parts lui donnent. Un retour sans facture reste à rapprocher à la main. Les écarts relevés sont dans discrepancies.

Droit de clé restreinte : batches:write.

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 l’objet retours de paiement.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/remittances \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"contents":"MDAwICAwMTc1…","file_name":"RSP0001.580"}'

PHP


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

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/remittances', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    contents: 'MDAwICAwMTc1…',
    file_name: 'RSP0001.580'
  }),
})
const object = await response.json()

Réponse 201


{
  "id": "obj_…",
  "object": "remittance",
  "norm": "…",
  "emitter": null,
  "source": "file",
  "file_name": null,
  "return_count": 0,
  "matched_count": 0,
  "unmatched_count": 0,
  "total_cents": 0,
  "discrepancies": [
    {}
  ],
  "received_at": null,
  "livemode": false,
  "created": 1793970000
}