Capture is the process by which payment funds are secured once the payment has been authorized.

The Capture API captures a payment for the full or partial amount, or changes the capture date to today. A new capture record is created and the status of the existing capture is updated to CANCELED, if and only if the existing capture(s) don't have the status STARTED or CAPTURED.

Capture Payment

By default, a capture for the full amount is created when the shopper authorizes the payment with a capture date of today. In this case, the capture call is only needed if a lower amount should be captured.

The default capture can be changed to a day in the future, or no default capture at all, by means of a configuration request. In the first case, the capture-request can be used to capture the payment earlier (today), or for a lower amount. In the latter case the capture call must be used, otherwise the payment funds (the actual money) will be not be secured.

Note: Depending on the payment method the capture is already captured when authorized by the shopper, and has the status CAPTURED.

POST /ps/api/public/v1/merchants/{merchant_key}/orders/{order_key}/payments/{payment_id}/captures

Identifiers

Parameters

Not applicable.

Request

The fields amount and currency are calculated when item_lines are provided. The request will be rejected, when amount, currency, and item_lines are provided.

The following shipping methods are supported:

The shipping method UNDEFINED is only used for Klarna payment method.

Response

Not applicable.

HTTP Status

Capture Payment example with amount and currency

> curl \
    -X POST \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic RG9jZGF0YVBGOkJXazJhZkpV' \
    https://testsecure.docdatapayments.com/ps/api/public/v1/merchants/4ef08825-993a-424d-a769-3ee97116a1b6/orders/94D261BBF80E4AC7212B127D3BD2E279/payments/pid1607033373t/captures \
    -d '{
        "amount"        : 1000,
        "currency"      : "EUR",
    }'
 
< Http 201 Created

Capture Payment example with itemLines and shippingInformation

> curl \
    -X POST \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Basic RG9jZGF0YVBGOkJXazJhZkpV' \
    https://testsecure.docdatapayments.com/ps/api/public/v1/merchants/4ef08825-993a-424d-a769-3ee97116a1b6/orders/94D261BBF80E4AC7212B127D3BD2E279/payments/pid1607033373t/captures \
    -d '{
        "item_lines"      : [
            {
                "code" : "SDC4/4GB-2ADP",
                "quantity" : 1
            },
            {
                "code" : "9781741791570",
                "quantity" : 2
            }
        ],
       "shipping_information" : {
            "shipping_company" : "DHL",
            "shipping_method"  : "PICKUP_POINT",
            "tracking_number"  : "111",
            "tracking_uri"     : "trackingUri",
            "return_shipping_company" : "DHL EU",
            "return_tracking_number"  : "222",
            "return_tracking_uri"     : "returnTrackingUri"
    }
}'
 
< Http 201 Created