Déposer un relevé de compte

POST/v1/bank-statements

Lit le relevé du compte du praticien, CSV exporté de la banque ou camt.053, garde ses crédits et les rapproche des virements annoncés par les retours. Les débits ne se gardent pas. Un virement qu’un relevé couvrant sa date ne montre pas est signalé not_received.

Droit de clé restreinte : batches:write.

Corps de la requête

contentstexteobligatoire
Le contenu du relevé, encodé en base 64 : CSV de la banque, ou camt.053.
file_nametexte
Le nom du fichier, 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 relevés de compte.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/bank-statements \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": "RGF0ZTtMaWJlbGzD…",
    "file_name": "releve-novembre.csv"
  }'

PHP


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

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/bank-statements', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    contents: 'RGF0ZTtMaWJlbGzD…',
    file_name: 'releve-novembre.csv'
  }),
})
const object = await response.json()

Réponse 201


{
  "id": "obj_…",
  "object": "bank_statement",
  "format": "csv",
  "source": "file",
  "file_name": null,
  "account_last4": null,
  "period": {
    "start": null,
    "end": null
  },
  "line_count": 0,
  "credit_count": 0,
  "duplicate_count": 0,
  "matched_count": 0,
  "livemode": false,
  "created": 1793970000
}