GET
/v1/charges/{charge}/refundsList refunds for a charge
Lists refunds belonging to a specific charge. Supply charge and use limit, starting_after, or ending_before to page through refunds beyond the most recent refunds included on the charge object. The response indicates whether more refunds are available.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
chargestringrequired
The unique identifier of the charge whose refunds to list.
ending_beforestringoptional
An object ID cursor used to retrieve the previous page of refunds.
expandarray<string>optional
Fields to expand in the response.
limitintegeroptional
The number of refunds to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor used to retrieve the next page of refunds.
200Returns a list of Refund objects for the charge, with pagination state, the list type, and its access URL.
dataarray<Refund>required
Details about each object.
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultReturns an error object when the charge refunds cannot be listed.
errorobjectrequired
Error handling
charge must identify the charge whose refunds you want to list. limit must be between 1 and 100 when provided, and starting_after and ending_before must contain object IDs used as pagination cursors.