Rapprocher un paiement à la main

POST/v1/payments/{payment}/match

Rattache à une facture un retour que le rapprochement automatique n’a pas reconnu : ce paiement et tout ce que porte le même retour. Rend la facture, dans son nouvel état.

Droit de clé restreinte : batches:write.

Paramètres de chemin

paymenttexteobligatoire
L'identifiant, pay_….

Corps de la requête

claimtexteobligatoire
La facture que le professionnel reconnaît dans ce retour, clm_….

En-têtes

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

Réponse

Rend l’objet factures.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/payments/pay_…/match \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"claim":"clm_…"}'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/payments/pay_…/match', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'claim' => 'clm_…',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/payments/pay_…/match', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    claim: 'clm_…'
  }),
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "claim",
  "status": "draft",
  "number": null,
  "replaces": null,
  "replaced_by": null,
  "reissue_chain": [
    "…"
  ],
  "editable": null,
  "kind": "fse",
  "mode": "secured",
  "supporting_document_status": "pending",
  "practitioner": "…",
  "practice_situation": null,
  "patient": "…",
  "coverage": "…",
  "batch": "…",
  "quote": null,
  "insurance_nature": "sickness",
  "third_party_amo": true,
  "third_party_amc": true,
  "context": {},
  "complementary": null,
  "lines": [
    {
      "id": "obj_…",
      "object": "claim_line",
      "nomenclature": "ngap",
      "code": "…",
      "service_date": "…",
      "quantity": 0,
      "coefficient": "…",
      "modifiers": [
        "…"
      ],
      "prescriber": null,
      "execution_place": "practice",
      "facility_identifier": null,
      "technical_package": null,
      "documentary_extension": null,
      "mandatory_child_exam": null,
      "prior_agreement": null,
      "unit_price_cents": 0,
      "base_unit_cents": 0,
      "amount_cents": 0,
      "base_amount_cents": 0,
      "amo_amount_cents": 0,
      "amc_amount_cents": 0,
      "reimbursement_rate": null,
      "exemption_code": null,
      "pricing_steps": [
        {
          "rule": "…",
          "step": "…",
          "value": {}
        }
      ],
      "livemode": false
    }
  ],
  "amount_cents": 0,
  "base_amount_cents": 0,
  "amo_amount_cents": 0,
  "amc_amount_cents": 0,
  "amc_pricing": null,
  "patient_amount_cents": 0,
  "paid_amount_cents": 0,
  "returns": {
    "amo": "paid",
    "amc": "paid"
  },
  "regularized_at": null,
  "rejection_code": null,
  "referential_versions": null,
  "ready_at": null,
  "secured_at": null,
  "transmitted_at": null,
  "acknowledged_at": null,
  "settled_at": null,
  "canceled_at": null,
  "livemode": false,
  "created": 1793970000,
  "updated": null
}