Refunds API

List payment refunds

Retrieve a list of all refunds created for a specific payment.

The results are paginated.

get/v2/payments/{paymentId}/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.

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 refund objects. For a complete reference of the refund object, refer to the Get refund endpoint documentation.

Changes

Changed in 7 of the 92 revisions of this API.1238

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

  • eca80d9f39721033See the full diff
    • ▲

      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 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 write-only property _embedded/refunds/items/reverseRouting from the response with the status

      response-optional-write-only-property-removed

    • ○

      removed the optional write-only property _embedded/refunds/items/testmode from the response with the status

      response-optional-write-only-property-removed

    • ○

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

      response-property-all-of-added

    • ▲

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

      response-property-min-decreased

    • ○

      the response property /// became required for the status

      response-property-became-required

    • ○

      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

    • ○

      response property _embedded/refunds/items/settlementAmount deprecated

      response-property-deprecated

Of the 92 revisions, 9 have no diff computed.