v55

OpenAPI 3.1.0CC-BY-NC-SA-4.0raw.githubusercontent.com2026-08-011243791.8 MB
Settlements API

List settlement 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.

get/v2/settlements/{settlementId}/payments

Query parameters

fromstring
Example:tr_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.

sort'asc' | 'desc'
Example:desc

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

profileIdstring

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

Example:pfl_5B8cwPMGnU

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.

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 payment objects.