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

Organization access token with settlements.read refunds.read

OAuth access with settlements.read refunds.read

Path Params
string
required

Provide the ID of the related settlement.

Query Params
string

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.

integer | null
1 to 250
Defaults to 50

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

string
enum

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

Show Details
paymentEmbed the payment related to this refund.
Allowed:
Responses

Language
Credentials
Request
Response
Choose an example:
application/hal+json