Sign in

v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB
Settlements API

List settlement refunds

Retrieve all refunds 'deducted' from the given settlement.

The response is in the same format as the response of the List refunds endpoint.

🔑 Access with

Advanced access token with settlements.read refunds.read

OAuth access with settlements.read refunds.read

get/settlements/{settlementId}/refunds

Query parameters

fromstring
Example:re_5B8cwPMGnU

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.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

embed'payment'
Example:payment

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

Response

A list of refund objects.