Capture Funds

Use Capture to complete a previously initiated payment that has not already been captured, indicated by the capturable flag in the response. Payment method type Card and some e-wallets supports the authorize/capture flow, others are auto-captured by default.

By default, the full authorized amount will be captured.

1
2
3
4
5
curl -X POST \
  https://api.test.payments.worldline.com/api/v2/merchants/1570616552/orders/order_example_1/captures \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'
  -H 'Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172'
1
2
3
4
POST /api/v2/merchants/1570616552/orders/order_example_1/captures HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
<CaptureOrderRequest>
    <OrderInfo>
        <OrderId>order_example_1</OrderId>
    </OrderInfo>
    <RequestInfo>
        <TransactionChannel>Web Online</TransactionChannel>
    </RequestInfo>
    <MerchantInfo>
        <MerchantId>1570616552</MerchantId>
    </MerchantInfo>
</CaptureOrderRequest>

Referencing the Initiating transaction

With the Capture, you optionally refer to a previous transactionId. You must use the same mid and orderId as you used in the InitiatePayment method.

Partial and multiple captures

Some but not all payment methods support partial or multiple captures. Worldline support captures up to maximum 100% of the authorized amount in the standard client configuration. In some specific cases, up to 115% amount is allowed. Speak with your integrations manager if required.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl -X POST \
  https://api.test.payments.worldline.com/api/v2/merchants/1570616552/orders/order_example_1/captures \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172'
  -d '{
    "amount": {
        "amount": 4.50,
        "currency": "EUR"
    }
}'
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
POST /api/v2/merchants/1570616552/orders/order_example_1/captures HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172

{
   "amount": {
      "amount": 10.50,
      "currency": "EUR"
   }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<CaptureOrderRequest>
    <OrderInfo>
        <OrderId>order_example_1</OrderId>
    </OrderInfo>
    <RequestInfo>
        <TransactionChannel>Web Online</TransactionChannel>
        <TimeoutSeconds>45</TimeoutSeconds>
    </RequestInfo>
    <MerchantInfo>
        <MerchantId>1570616552</MerchantId>
    </MerchantInfo>
    <PayInfo>
        <Amount>4.50</Amount>
        <Currency>
            <AlphabeticCode>EUR</AlphabeticCode>
        </Currency>
    </PayInfo>
</CaptureOrderRequest>