Captures

---

Use Captures to request capture of a payment that has been authorized and fulfilled. The default capture amount is the same as the fulfilled amount. To capture any amount up to the fulfilled amount, you must define the capture amount in the request body.

Endpoints

POST /api/v2/merchants/{mid}/orders/{orderId}/captures

Captures a specified payment order.

Request parameters

Path parameter	Requirement	Description	Type
mid	Required	The merchant account reference number.	Number
orderId	Required	The reference to uniquely identify a payment.	String

Body parameter	Requirement	Description	Type
amount	Optional	The transaction amount.	Number
currency	Optional	The ISO 4217 currency code.	String

Sample request

CURL

curl -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172' \
    https://    /api/v2/merchants/1570616552/orders/order_example_1/captures

Request body example

REST API

{
   "amount": {
      "amount": 10.50,
      "currency": "EUR"
   }
}

Sample response

REST API

{
    "mid": 1570616552,
    "orderId": "order_example_1",
    "orderDetailDescription": "detailed desc",
    "orderDescription": "description",
    "orderAmount": 10.50,
    "fulfilmentAmount": 10.50,
    "capturedAmount": 10.50,
    "refundedAmount": 0.00,
    "currency": "EUR",
    "baseCurrency": "EUR",
    "baseOrderAmount": 10.50,
    "baseFulfilmentAmount": 10.50,
    "baseCapturedAmount": 10.50,
    "baseRefundedAmount": 0.00,
    "capturable": false,
    "cancelable": false,
    "refundable": true,
    "completable": false,
    "dccIndicator": false,
    "transactionReferences": [
        {
            "transactionId": 5986909881,
            "transactionTypeId": 3,
            "mid": 1570616552,
            "orderId": "order_example_1",
            "transactionType": "Capture",
            "transactionDate": "2019-10-04T14:19:34.264Z",
            "refTransactionId": 5986908782,
            "transactionDesc": "Transaction Accepted",
            "statusCode": 0,
            "status": "Processed",
            "amount": 10.50,
            "currency": "EUR",
            "baseAmount": 10.50,
            "baseCurrency": "EUR",
            "paymentMethod": "Visa",
            "paymentMethodId": 1001,
            "maskedAccountNumber": "411111xxxxxx1111",
            "cardExpiryDate": "12-2024",
            "cvResponse": "",
            "cvAnswerCode": 4,
            "avsResponse": "",
            "avsAnswerCode": 4
        }
    ]
}