List settlement chargebacks

Retrieve all chargebacks 'deducted' from the given settlement.

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

Access with

Organization access token with settlements.read payments.read

OAuth access with settlements.read payments.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 you to embed additional information via the embed query string parameter.

Show Details
paymentInclude the payment these chargebacks were issued for.
Allowed:
boolean

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.

Responses

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