Lister les retours de paiement

GET/v1/remittances

Les fichiers de retours reçus, du plus récent au plus ancien, avec leurs écarts.

Droit de clé restreinte : batches:read.

Paramètres de requête

with_discrepanciesénumération
true : seulement les fichiers qui ont relevé un écart.
truefalse
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/remittances?limit=3 \
  -H "Authorization: Bearer sk_test_…"

PHP


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

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/remittances?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": "remittance",
      "norm": "…",
      "emitter": null,
      "source": "file",
      "file_name": null,
      "return_count": 0,
      "matched_count": 0,
      "unmatched_count": 0,
      "total_cents": 0,
      "discrepancies": [
        {}
      ],
      "received_at": null,
      "livemode": false,
      "created": 1793970000
    }
  ]
}