Sign in
Settlements API

List settlements

Retrieve a list of all your settlements.

The results are paginated.

get/v2/settlements

Query parameters

fromstring nullable

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.

balanceIdstring
Example:bal_gVMhHKqSSRYJyPsuoPNFH

Provide the token of the balance to filter the settlements by. This is the balance token that the settlement was settled to.

yearstring nullable
Example:2025

Provide the year to query the settlements. Must be used combined with month parameter

monthstring nullable
Example:1

Provide the month to query the settlements. Must be used combined with year parameter

currencies'EUR' | 'GBP' | 'CHF' | 'DKK' | 'NOK' | 'PLN' | 'SEK' | 'USD' | 'CZK' | 'HUF' | 'AUD' | 'CAD' | 'RON'
Example:EUR

Provides the currencies to retrieve the settlements. It accepts multiple currencies in a comma-separated format.

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 settlement objects. For a complete reference of the settlement object, refer to the Get settlement endpoint documentation.

Changes

Changed in 9 of the 78 revisions of this API.8269

  • cc776d6ba83e164See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

  • e1a1ad379a1e751See the full diff
    • ▲

      the // response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ○

      added subschema #2 to the // response property allOf list for the response status

      response-property-all-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 160fcdd65af72See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 1bcb76dbe9ea1See the full diff
    • ▲

      the response property's min was decreased from 1.00 to 0.00 for the response status

      response-property-min-decreased

  • 01ff4e7355c41See the full diff
    • ○

      added the new enum value RON to the query request parameter currencies

      request-parameter-enum-value-added

  • 226f9009e9282See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 36c56b46f1501See the full diff
    • ●

      added the new processing-at-bank enum value to the /////// response property for the response status

      response-property-enum-value-added

Of the 78 revisions, 9 have no diff computed.