NOnovabilling
Payments

Refund a payment

Changed on

Issue a full or partial refund for a succeeded payment. If amount is omitted, the full payment amount is refunded.

post/api/payments/{id}/refund

Request

Path parameters

idstring required

Payment ID

Request body

amountnumber

Amount to refund (full refund if omitted)

reasonstring

Reason for refund

Response

Payment refunded successfully

idstring required
invoiceIdstring required
providerstring required
providerTransactionIdstring
amountstring required

Decimal amount as string

currencystring required
status'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'FAILED' | 'REFUNDED' required
failureReasonstring
metadataobject
createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "invoiceId": "clxinv123",
  "provider": "paystack",
  "providerTransactionId": "PAY_txn_abc123",
  "amount": "99.9900",
  "currency": "USD",
  "status": "SUCCEEDED",
  "failureReason": "Insufficient funds"
}

Changes