Lister les paiements

GET/v1/payments

Ce que les retours de paiement versent ou retiennent, du plus récent au plus ancien.

Droit de clé restreinte : batches:read.

Paramètres de requête

claimtexte
Ceux d'une facture, clm_….
remittancetexte
Ceux d'un fichier de retours, rem_….
payouttexte
Pour les paiements : ceux d'un virement, po_….
matchedénumération
false : ceux qui attendent un rapprochement à la main.
truefalse
typeénumération
Pour les paiements : leur type. Pour les rejets : rejected ou deferred.
liquidationregularizationone_off_paymentone_off_deduction
statusénumération
Retient les objets dans cet état.
rejecteddeferred
limitentier
Le nombre d'objets rendus, de 1 à 100. Par défaut, 25.
starting_aftertexte
Un identifiant : la page qui suit cet objet.
ending_beforetexte
Un identifiant : la page qui précède cet objet.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl https://api.ophelix.fr/v1/payments?limit=3 \
  -H "Authorization: Bearer sk_test_…"

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->get('/v1/payments?limit=3', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/payments?limit=3', {
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "object": "list",
  "url": "https://exemple.fr/hook",
  "has_more": true,
  "data": [
    {
      "id": "obj_…",
      "object": "payment",
      "type": "liquidation",
      "part": "amo",
      "amount_cents": 0,
      "requested_cents": 0,
      "claim": null,
      "matched": true,
      "remittance": "…",
      "payout": null,
      "return_code": null,
      "invoice": {
        "number": null,
        "date": null,
        "type": null
      },
      "practitioner_number": null,
      "transfer": {
        "label": null,
        "accounting_date": null,
        "payer": null
      },
      "debt_reference": null,
      "operation_nature": null,
      "code": null,
      "label": null,
      "beneficiary": null,
      "matched_at": null,
      "livemode": false,
      "created": 1793970000
    }
  ]
}