List captures
Retrieve a list of all captures created for a specific payment.
The results are paginated.
Query parameters
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.
The maximum number of items to return. Defaults to 50 items.
This endpoint allows embedding related API items by appending the following values via the embed query string parameter.
Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.
Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
Headers
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 92 revisions of this API.16
- ○
added the optional write-only property
_embedded/captures/items/allOf[list-entity-capture]/testmodeto the response with the statusresponse-optional-write-only-property-added
- ○
- ▲
the
response property's min was decreased from1.00to0.00for the response statusresponse-property-min-decreased
- ▲
- ○
removed
subschema #2from the//response propertyallOflist for the response statusresponse-property-all-of-removed
- ○
- ○
added the non-success response with the status
response-non-success-status-added
- ○
- ○
the endpoint scheme security
advancedAccessTokenwas added to the APIapi-security-added
- ○
the endpoint scheme security
organizationAccessTokenwas removed from the APIapi-security-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
response property
_embedded/captures/items/allOf[list-entity-capture]/settlementAmountdeprecatedresponse-property-deprecated
- ○
Of the 92 revisions, 9 have no diff computed.