Skip to main content

When this fires

When a refund is issued for a payment — full or partial — and the payment provider confirms it. A refund does not change the subscription. If it should end, cancel it separately. refundAmount is the refunded amount in cents (100 = $1.00). The invoice fields are null for payments that were not tied to an invoice. Use it to mirror the refund in your own books or to notify the customer through your channels.

Body

application/json
id
string
required
event
string
required
Allowed value: "payment.refunded"
timestamp
string
required
organizationId
string
required
mode
enum<string>
required
Available options:
live,
sandbox
apiVersion
string
required
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.