Sign in
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.

Changes

Changed in 19 of the 92 revisions of this API.33545

  • 9c1c6717ac7d3See the full diff
    • ●

      added the new el_GR enum value to the /////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sl_SI enum value to the /////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new tr_TR enum value to the /////////// response property for the response status

      response-property-enum-value-added

  • 34b0d7662c301See the full diff
    • ●

      added the new undefined enum value to the //////////// response property for the response status

      response-property-enum-value-added

  • 7eb5bf6b29dd1See the full diff
    • ●

      added the new undefined enum value to the //////// response property for the response status

      response-property-enum-value-added

  • 66dee9998c091See the full diff
    • ●

      added the new wero enum value to the //////// response property for the response status

      response-property-enum-value-added

  • 8e5a936eb5bd6See the full diff
    • ●

      added the new Cartes Bancaires enum value to the //////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new cartes-bancaires-business enum value to the //////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new cartes-bancaires-consumer enum value to the //////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mastercard-debit-consumer-inter enum value to the //////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new visa-debit-consumer-inter enum value to the //////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new visa-debit-consumer-intra-eea enum value to the //////////// response property for the response status

      response-property-enum-value-added

  • 86a9cd830b063See the full diff
    • ●

      added the new en_BE enum value to the /////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new en_NL enum value to the /////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new visa-credit-consumer-inter enum value to the //////////// response property for the response status

      response-property-enum-value-added

  • 64c0511a62bc11See the full diff
    • ●

      added the new undefined enum value to the /////////// response property for the response status

      response-property-enum-value-added

    • ○

      removed the null enum value from the /////////// response property for the response status

      response-property-enum-value-removed

  • 42479670d8c91See the full diff
    • ▲

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

      response-property-became-nullable

  • 160fcdd65af71See the full diff
    • ●

      added the new billink enum value to the //////// response property for the response status

      response-property-enum-value-added

  • 4d4ab81fb2d52See the full diff
    • ●

      added the new cs_CZ enum value to the /////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sk_SK enum value to the /////////// response property for the response status

      response-property-enum-value-added

Of the 92 revisions, 9 have no diff computed.