Simuler l’arrivée d’un virement

POST/v1/test-helpers/payouts/{payout}/arrival

Le simulateur écrit le relevé camt.053 du compte, qui suit le chemin d’un relevé déposé. received crédite le virement, amount_mismatch le crédite de 9,00 € de moins, not_received rend un relevé qui couvre sa date sans le montrer. Mode test seulement.

Droit de clé restreinte : batches:write.

Mode test seulement

Paramètres de chemin

payouttexteobligatoire
L'identifiant, po_….

Corps de la requête

scenarioénumération
received (par défaut), amount_mismatch ou not_received.
receivedamount_mismatchnot_received

En-têtes

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

Réponse

Rend l’objet virements.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/test-helpers/payouts/po_…/arrival \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"scenario":"amount_mismatch"}'

PHP


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

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/test-helpers/payouts/po_…/arrival', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    scenario: 'amount_mismatch'
  }),
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "payout",
  "status": "pending",
  "amount_cents": 0,
  "currency": "eur",
  "statement_descriptor": null,
  "label": {
    "line_1": null,
    "line_2": null
  },
  "accounting_date": null,
  "payer": null,
  "practitioner_number": null,
  "remittance": null,
  "payment_count": 0,
  "claim_count": 0,
  "detail_cents": 0,
  "breakdown": {
    "liquidation_cents": 0,
    "regularization_cents": 0,
    "one_off_payment_cents": 0,
    "deduction_cents": 0
  },
  "bank_transaction": null,
  "received_cents": 0,
  "arrival_date": null,
  "reconciliation": "automatic",
  "reconciled_at": null,
  "discrepancies": [
    {}
  ],
  "livemode": false,
  "created": 1793970000
}