Sign in
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.

Changes

Changed in 7 of the 78 revisions of this API.118

  • eca80d9f39722See the full diff
    • ○

      added to the // response property allOf list for the response status

      response-property-all-of-added

    • ○

      removed from the // response property allOf list for the response status

      response-property-all-of-removed

  • 8e5a936eb5bd1See the full diff
    • ●

      added the new failed enum value to the //// response property for the response status

      response-property-enum-value-added

  • 1bcb76dbe9ea1See the full diff
    • ▲

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

      response-property-min-decreased

  • 5e44242e94d31See the full diff
    • ○

      the response property /////// became required for the status

      response-property-became-required

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      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

  • 18e0e58eb54d2See the full diff
    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      response property _embedded/refunds/items/allOf[list-entity-refund]/settlementAmount deprecated

      response-property-deprecated

Of the 78 revisions, 9 have no diff computed.