Lister les virements

GET/v1/payouts

Les virements que les retours de paiement annoncent, du plus récent au plus ancien, avec leur rapprochement et leurs écarts.

Droit de clé restreinte : batches:read.

Paramètres de requête

statusénumération
Retient les objets dans cet état.
pendingreconcileddiscrepancy
remittancetexte
Ceux qu'annonce un fichier de retours, rem_….
payertexte
Ceux d'un organisme payeur, tel que le retour le nomme.
accounting_date[gte]date
accounting_date[lte]date
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/payouts?limit=3 \
  -H "Authorization: Bearer sk_test_…"

PHP


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

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/payouts?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": "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
    }
  ]
}