List all refunds
Retrieve a list of all of your refunds.
The results are paginated.
Query parameters
Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.
The maximum number of items to return. Defaults to 50 items.
Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.
This endpoint allows embedding related API items by appending the following values via the embed query string parameter.
The identifier referring to the profile this entity belongs to.
Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.
The identifier referring to the profile you wish to retrieve the resources for.
Most API credentials are linked to a single profile. In these cases the profileId must not be sent. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.
Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
Headers
A unique key to ensure idempotent requests. This key should be a UUID v4 string.
Response
A list of refund objects
Changes
Changed in 6 of the 78 revisions of this API.1138
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///from the response with the statusresponse-required-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ○
removed the optional write-only property
_embedded/refunds/items/reverseRoutingfrom the response with the statusresponse-optional-write-only-property-removed
- ○
removed the optional write-only property
_embedded/refunds/items/testmodefrom the response with the statusresponse-optional-write-only-property-removed
- ○
added to the
//response propertyallOflist for the response statusresponse-property-all-of-added
- ▲
- ▲
the
response property's min was decreased from1.00to0.00for the response statusresponse-property-min-decreased
- ▲
- ○
the response property
///became required for the statusresponse-property-became-required
- ○
- ○
added the non-success response with the status
response-non-success-status-added
- ○
- ○
the endpoint scheme security
advancedAccessTokenwas added to the APIapi-security-added
- ○
the endpoint scheme security
organizationAccessTokenwas removed from the APIapi-security-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
response property
_embedded/refunds/items/settlementAmountdeprecatedresponse-property-deprecated
- ○
Of the 78 revisions, 9 have no diff computed.