List payment refunds

get

https://api.mollie.com/v2/payments/{paymentId}/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.readOAuth access with refunds.read

Path Params

paymentId

string

required

Provide the ID of the related payment.

Query Params

from

string

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.

limit

integer | null

1 to 250

Defaults to 50

The maximum number of items to return. Defaults to 50 items.

embed

string

enum

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

Show Details

payment

Embed the payment related to this refund.

Allowed:

testmode

boolean

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.

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/hal+json

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

400The request contains issues. For example, if the specified from value is not a valid ID.

404No entity with this ID exists.

429Rate Limit has been reached.