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.
get/v2/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.
embedstring nullable
This endpoint allows embedding related API items by appending the following values via the embed query string parameter.
Headers
idempotency-keystring
Example:123e4567-e89b-12d3-a456-426
A unique key to ensure idempotent requests. This key should be a UUID v4 string.
Response
A list of refund objects.