Lire un retour de paiement

GET/v1/remittances/{remittance}

Droit de clé restreinte : batches:read.

Paramètres de chemin

remittancetexteobligatoire
L'identifiant, rem_….

Réponse

Rend l’objet retours de paiement.

Une erreur suit le format commun.

Requête

curl


curl https://api.ophelix.fr/v1/remittances/rem_… \
  -H "Authorization: Bearer sk_test_…"

PHP


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

TypeScript


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

Réponse 200


{
  "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
}