Skip to main content
The RefundRequest object is used to specify refund details when processing a refund.

Properties

FieldTypeRequiredDescription
refundAmountintegerAmount to refund in the smallest currency unit
Notes: Minimum value: 1, If omitted full refund is processed, Cannot exceed original captured amount

Usage

Full Refund: Omit the refundAmount field to refund the entire captured amount.Partial Refund: Include refundAmount to refund a specific amount.

Example - Full Refund

{}

Example - Partial Refund

{
  "refundAmount": 500
}

Business Rules

  • Refunds can only be processed on captured payments
  • Refund amount cannot exceed the captured amount
  • Multiple partial refunds are allowed until the full amount is refunded