Lire un paiement

GET/v1/payments/{payment}

Droit de clé restreinte : batches:read.

Paramètres de chemin

paymenttexteobligatoire
L'identifiant, pay_….

Réponse

Rend l’objet paiements.

Une erreur suit le format commun.

Requête

curl


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

PHP


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

TypeScript


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

Réponse 200


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