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.

get/v2/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.

embedstring nullable

This endpoint allows embedding related API items by appending the following values 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.

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 chargeback objects.

Changes

Changed in 4 of the 79 revisions of this API.844

    • the response property's min was decreased from 1.00 to 0.00 for the response status

      response-property-min-decreased

    • added the non-success response with the status

      response-non-success-status-added

    • the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 18e0e58eb54d741See the full diff
    • the // response's property type changed from object to no type for status

      response-property-type-changed

    • removed the required property /// from the response with the status

      response-required-property-removed

    • removed the required property /// from the response with the status

      response-required-property-removed

    • removed the required property /// from the response with the status

      response-required-property-removed

    • removed the required property /// from the response with the status

      response-required-property-removed

    • removed the required property /// from the response with the status

      response-required-property-removed

    • removed the required property /// from the response with the status

      response-required-property-removed

    • removed the optional property /// from the response with the status

      response-optional-property-removed

    • removed the optional property /// from the response with the status

      response-optional-property-removed

    • removed the optional property /// from the response with the status

      response-optional-property-removed

    • removed the optional property /// from the response with the status

      response-optional-property-removed

    • added subschema #2 to the // response property allOf list for the response status

      response-property-all-of-added

Of the 79 revisions, 9 have no diff computed.