Release NotesAnnouncementsBlogFAQSupport
API Reference

Get refunds list

get
https://scl-sandbox.dev.clover.com/v1/refunds

Returns a list of all existing refunds. The newest refund is first in the list. The ten most recent refunds appear by default on the charge object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Retrieve refunds applied to a specific charge.

object

List filter based on the object's created field. The value can be a string with a Unix timestamp (in milliseconds) or a dictionary of multiple options describing a time range.

string

Cursor used in pagination. The ending_before object ID sets your place in the list. For example, if you receive 100 objects in a list starting with obj_bar, add ending_before=obj_bar in your subsequent request to retrieve the previous page of the list.

integer

The number of objects returned by the request, ranging between 1 and 100. The default value is 10.

string
length ≤ 5000

Cursor used in pagination. The starting_after object ID sets your place in the list. For example, if you receive 100 objects in a list starting with obj_foo, add starting_after=obj_foo in your subsequent request to retrieve the next page of the list.

Headers
string
required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Responses

Updated 4 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago