Skip to main content

Refund amount, reason, and metadata. If amount is omitted, the full remaining captured amount is refunded.

amount
integer

Amount to refund in minor units. Omit to refund full remaining captured amount.

Required range: x >= 1
Example:

5000

reason
string

Reason for the refund

Example:

"Customer returned item"

metadata
object

Additional metadata

Example:
{ "refund_type": "partial" }