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.
🔑 Access with
Advanced access token with settlements.read payments.read
OAuth access with settlements.read payments.read
get/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.
embed'payment'
Example:payment
This endpoint allows you to embed additional resources via the embed query string parameter.
Response
A list of capture objects.
Changes
No recorded changes to this endpoint across all 1 revision of this API.