v1

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

Settlements API

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

Advanced access token with settlements.read payments.read

OAuth access with settlements.read payments.read

get/settlements/{settlementId}/chargebacks

Query parameters

fromstring

Example:chb_xFzwUN4ci8HAmSGUACS4J

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 you to embed additional information via the embed query string parameter.

testmodeboolean

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.

Response

A list of chargeback objects.