v1

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

Refunds API

List payment refunds

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

The results are paginated.

🔑 Access with

API key

Advanced access token with refunds.read

OAuth access with refunds.read

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

embed'payment'

Example:payment

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.

Response

A list of refund objects. For a complete reference of the refund object, refer to the Get refund endpoint documentation.