List settlement payments

get

https://api.mollie.com/v2/settlements/{settlementId}/payments

Retrieve all payments included in the given settlement.

The response is in the same format as the response of the List payments endpoint.

For capture-based payment methods such as Klarna, the payments are not listed here. Refer to the List captures endpoint endpoint instead.

Access with

Organization access token with settlements.read payments.read

OAuth access with settlements.read payments.read

Path Params

settlementId

string

required

Provide the ID of the related settlement.

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.

sort

string

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

profileId

string

The identifier referring to the profile you wish to retrieve the resources for.

Most API credentials are linked to a single profile. In these cases the profileId must not be sent. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

Responses

Language

Credentials

Request

Response

Choose an example:

application/hal+json

200A list of payment objects.

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