Documentation/Lire un remboursement
openapi.jsonOuvrir mon espace

Lire un remboursement

GET/v1/refunds/{id}

Un remboursement, et ce qu’il a coûté.

La demande

bash
curl https://api.payiz.app/v1/refunds/rem_01j9xb2te8r5mzq4kd7n \
  -H "Authorization: Bearer sk_test_…"

La réponse

json
{
  "object": "refund",
  "id": "rem_01j9xb2te8r5mzq4kd7n",
  "payment": "pay_01j9x3kq7m4tzv8qhw2n",
  "amount": 10000,
  "currency": "XOF",
  "status": "processing",
  "reason": "requested_by_customer",
  "fee": 100,
  "fee_returned": 250,
  "amount_debited": 9850,
  "failure_message": null,
  "created": 1790006292,
  "livemode": false
}

Ce qu’on reçoit

200 · un objet refund

object« refund »Le genre de l’objet rendu : il ne change jamais.
idtexteUn identifiant préfixé « rem_ », par exemple rem_01j9x3kq7m4tzv8qhw2n.
paymenttexteUn identifiant préfixé « pay_ », par exemple pay_01j9x3kq7m4tzv8qhw2n.
amountentierCe qui repart chez le payeur.
currencytexteLe code ISO 4217, en majuscules.
status« pending » · « processing » · « succeeded » · « failed »Où en est le remboursement.
reasontexteLe motif, choisi parmi ceux que Payiz accepte.
feeentierLes frais du remboursement.
fee_returnedentierLa commission d’encaissement rendue au marchand.
amount_debitedentierCe que l’opération coûte en tout au marchand.
failure_messagetexte ou nullCe que l’opérateur a répondu, quand ça a échoué.
createdentier ou nullDes secondes depuis 1970, ou null.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.
© 2026 PayizUne question ? L’aide est dans le rond, en bas à droite.

Lire un remboursement

GET/v1/refunds/{id}

Un remboursement, et ce qu’il a coûté.

La demande

bash
curl https://api.payiz.app/v1/refunds/rem_01j9xb2te8r5mzq4kd7n \
  -H "Authorization: Bearer sk_test_…"

La réponse

json
{
  "object": "refund",
  "id": "rem_01j9xb2te8r5mzq4kd7n",
  "payment": "pay_01j9x3kq7m4tzv8qhw2n",
  "amount": 10000,
  "currency": "XOF",
  "status": "processing",
  "reason": "requested_by_customer",
  "fee": 100,
  "fee_returned": 250,
  "amount_debited": 9850,
  "failure_message": null,
  "created": 1790006292,
  "livemode": false
}

Ce qu’on reçoit

200 · un objet refund

object« refund »Le genre de l’objet rendu : il ne change jamais.
idtexteUn identifiant préfixé « rem_ », par exemple rem_01j9x3kq7m4tzv8qhw2n.
paymenttexteUn identifiant préfixé « pay_ », par exemple pay_01j9x3kq7m4tzv8qhw2n.
amountentierCe qui repart chez le payeur.
currencytexteLe code ISO 4217, en majuscules.
status« pending » · « processing » · « succeeded » · « failed »Où en est le remboursement.
reasontexteLe motif, choisi parmi ceux que Payiz accepte.
feeentierLes frais du remboursement.
fee_returnedentierLa commission d’encaissement rendue au marchand.
amount_debitedentierCe que l’opération coûte en tout au marchand.
failure_messagetexte ou nullCe que l’opérateur a répondu, quand ça a échoué.
createdentier ou nullDes secondes depuis 1970, ou null.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.