Accounts API4

Balance Transfers API3

Balances API5

Capabilities API1

Captures API3

Chargebacks API3

Checkout Sessions API2

Client Links API1

Clients API2

Customers API7

Delayed Routing API3

Draft Transfers API4

Invoices API2

Mandates API4

Methods API7

OAuth API2

Onboarding API2

Organizations API3

Payment Links API6

Payments API6

Payouts API4

Permissions API2

Profiles API6

Refunds API5

Sales Invoices API5

Settlements API8

Subscriptions API7

Terminals API6

Transfers API2

Unmatched Credit Transfers API4

Verify Payee API1

Wallets API1

Webhook Events API1

Webhooks API6

Settlements API

List settlement captures

Retrieve all captures included in the given settlement.

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

get/v2/settlements/{settlementId}/captures

Query parameters

fromstring

Example:cpt_vytxeTZskVKR7C7WgdSP3d

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.

embedstring nullable

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

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

Changes

Changed in 6 of the 78 revisions of this API.17

Aug 5, 2026392e474e7edc1See the full diff
- ○
  added the optional write-only property _embedded/captures/items/allOf[list-capture-response]/allOf[list-entity-capture]/testmode to the response with the status
  response-optional-write-only-property-added
Jul 8, 20261bcb76dbe9ea1See the full diff
- ▲
  the response property's min was decreased from 1.00 to 0.00 for the response status
  response-property-min-decreased
Jul 2, 2026e8c8cac713801See the full diff
- ○
  removed subschema #2 from the ////// response property allOf list for the response status
  response-property-all-of-removed
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 4, 202618e0e58eb54d2See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  response property _embedded/captures/items/allOf[list-capture-response]/allOf[list-entity-capture]/settlementAmount deprecated
  response-property-deprecated

Of the 78 revisions, 9 have no diff computed.

Full history