Saisir un virement reçu

POST/v1/bank-transactions

Enregistre un crédit lu sur le relevé, sans fichier, et le rapproche du virement annoncé qu’il règle.

Droit de clé restreinte : batches:write.

Corps de la requête

booked_ondateobligatoire
Le jour du crédit sur le relevé, AAAA-MM-JJ.
amount_centsentierobligatoire
Le montant crédité, en centimes.
labeltexteobligatoire
Le libellé du relevé, tel quel : il retrouve le virement.
counterpartytexteou null
Le donneur d'ordre, s'il est lisible.
referencetexteou null
La référence du virement, s'il en a une.

En-têtes

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

Réponse

Rend l’objet crédits du relevé.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/bank-transactions \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "booked_on": "2026-11-05",
    "amount_cents": 124830,
    "label": "VIR SEPA CPAM PARIS 2611034512"
  }'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/bank-transactions', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'booked_on' => '2026-11-05',
        'amount_cents' => 124830,
        'label' => 'VIR SEPA CPAM PARIS 2611034512',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/bank-transactions', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    booked_on: '2026-11-05',
    amount_cents: 124830,
    label: 'VIR SEPA CPAM PARIS 2611034512'
  }),
})
const object = await response.json()

Réponse 201


{
  "id": "obj_…",
  "object": "bank_transaction",
  "status": "matched",
  "amount_cents": 0,
  "currency": "eur",
  "booked_on": "…",
  "label": "…",
  "counterparty": null,
  "reference": null,
  "account_last4": null,
  "source": "statement",
  "payout": null,
  "bank_statement": null,
  "matched_at": null,
  "livemode": false,
  "created": 1793970000
}