List settlement captures¶
Settlements API v2
GET
https://api.mollie.com/v2/settlements/*settlementId*/captures
Authentication:API keysOrganization access tokensApp access tokens
Retrieve all captures in a certain settlement.
Captures are used for payments that have the authorize-then-capture flow. The only payment methods at the moment that have this flow are Klarna Pay now, Klarna Pay later and Klarna Slice it. Captures are created when (part of) an Order is shipped. The capture is then settled to the merchant.
Parameters¶
Replace settlementId
in the endpoint URL by the settlement’s ID. For example:
/v2/settlements/stl_jDk30akdN/captures
.
Response¶
200
application/hal+json
count
integer
The number of captures found in
_embedded
, which is either the requested number (with a maximum of 250) or
the default number._embedded
objectThe object containing the queried data.
captures
array
An array of capture objects as described in Get capture.
_links
objectLinks to help navigate through the lists of captures. Every URL object will contain an href
and a type
field.
self
object
The URL to the current set of captures.
previous
object
The previous set of captures, if available.
next
object
The next set of captures, if available.
documentation
object
The URL to the List settlement captures endpoint documentation.
Example¶
cURLPHPPythonRubyNode.js
1 2 | curl -X GET https://api.mollie.com/v2/settlements/stl_jDk30akdN/captures \ -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" |
1 2 3 4 5 6 | <?php $mollie = new \Mollie\Api\MollieApiClient(); $mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"); $settlement = $mollie->settlements->get("stl_jDk30akdN"); $captures = $settlement->captures(); |
1 2 3 4 5 6 7 | from mollie.api.client import Client mollie_client = Client() mollie_client.set_access_token("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ") settlement = mollie_client.settlements.get("stl_jDk30akdN") captures = settlement.captures.list() |
1 2 3 4 | We don't have a Ruby code example for this API call yet. If you have some time to spare, feel free to share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
1 2 3 4 | We don't have a Node.js code example for this API call yet. If you have some time to spare, feel free to share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
Response¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | HTTP/1.1 200 OK Content-Type: application/hal+json { "_embedded": { "captures": [ { "resource": "capture", "id": "cpt_4qqhO89gsT", "mode": "live", "amount": { "value": "1027.99", "currency": "EUR" }, "settlementAmount": { "value": "399.00", "currency": "EUR" }, "paymentId": "tr_WDqYK6vllg", "shipmentId": "shp_3wmsgCJN4U", "settlementId": "stl_jDk30akdN", "createdAt": "2018-08-02T09:29:56+00:00", "_links": { "self": { "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg/captures/cpt_4qqhO89gsT", "type": "application/hal+json" }, "payment": { "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg", "type": "application/hal+json" }, "shipment": { "href": "https://api.mollie.com/v2/orders/ord_8wmqcHMN4U/shipments/shp_3wmsgCJN4U", "type": "application/hal+json" }, "settlement": { "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN", "type": "application/hal+json" }, "documentation": { "href": "https://docs.mollie.com/reference/v2/captures-api/get-capture", "type": "text/html" } } } ] }, "count": 1, "_links": { "documentation": { "href": "https://docs.mollie.com/reference/v2/settlements-api/list-settlement-captures", "type": "text/html" }, "self": { "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN/captures?limit=50", "type": "application/hal+json" }, "previous": null, "next": null } } |