Get settlement

Retrieve a single settlement by its ID.

To lookup settlements by their bank reference, replace the ID in the URL by a reference. For example: 1234567.2404.03.

A settlement represents a transfer of your balance funds to your external bank account.

Settlements will typically include a report that details what balance transactions have taken place between this settlement and the previous one.

For more accurate bookkeeping, refer to the balance report endpoint or the balance transactions endpoint.

get/v2/settlements/{settlementId}

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

The settlement object.

Changes

Changed in 7 of the 78 revisions of this API.7268

Aug 18, 2026cc776d6ba83e164See 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
Aug 7, 2026e1a1ad379a1e751See the full diff
- ▲
  the response's body type changed from object to no type for status
  response-body-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 body allOf list for the response status
  response-body-all-of-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 30, 2026160fcdd65af72See 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
Jul 2, 2026226f9009e9282See 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
May 19, 20267cab62b218301See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
May 12, 2026ef4b5a97b56a2See 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
May 7, 202636c56b46f1501See 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.

Full history