Merchant API
Capture an order (Deprecated)
api
post
/api/1.0/orders/{order_id}/capture

Capture an order (Deprecated)

Capture the funds of an existing, uncaptured order. When the payment for an order is authorised, the order is captured and sent to the processing stage.

When you create an order, you can choose one of the following capture modes:

  • AUTOMATIC: The order is captured automatically after payment authorisation, so you don't need to take any action then.
  • MANUAL: The order is not captured automatically and stays in AUTHORISED state. You must manually capture the order later using one of the following methods:
    • Web UI: Complete the following steps:
      1. Log in to your Revolut Business portal.
      2. Navigate to the Merchant tab on the dashboard, and click the See all button in the Transactions section.
      3. Select an uncaptured payment, and click Capture.
    • Endpoint: Use the /capture endpoint.

Optionally, you can send a fraction of the full amount in the capture request to do a partial capture. You can only capture an order once. The amount that isn't captured will be voided.

note

Orders stay uncaptured for 7 days. After this period, the funds are returned to the customer's original payment method.

Request​

Path Parameters
Path Parameters
Header Parameters
Header Parameters
Request body
Body object 

Response​

OK

Response body
Body object 
Was this page helpful?
POST
/api . /1.0 . /orders . /{order_id} . /capture . 
Parameters
curl -L -g -X POST 'https://merchant.revolut.com/api/1.0/orders/{order_id}/capture' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <yourSecretApiKey>' \
--data-raw '{
  "amount": 100
}'
Request body samples
{
  "amount": 100
}
Response body samples
{
  "id": "7c97ce7e-a7e4-4ff9-b3ca-9f988b0ba5e0",
  "public_id": "fecaafa0-c230-44e9-a24e-7005e82e03f8",
  "type": "PAYMENT",
  "state": "COMPLETED",
  "created_at": "2021-01-14T18:37:06.055371Z",
  "updated_at": "2021-01-14T18:38:04.115204Z",
  "completed_at": "2021-01-14T18:38:39.476986Z",
  "description": "Testing Orders",
  "capture_mode": "MANUAL",
  "settlement_currency": "EUR",
  "merchant_order_ext_ref": "testorder123",
  "customer_id": "56db1367-2494-4a35-8254-c23929f8e5e1",
  "email": "test@revolut.com",
  "phone": "+447123456789",
  "order_amount": {
    "value": 50,
    "currency": "GBP"
  },
  "order_outstanding_amount": {
    "value": 0,
    "currency": "GBP"
  },
  "shipping_address": {
    "street_line_1": "7 Westferry Circus",
    "street_line_2": "Revolut",
    "city": "London",
    "country_code": "GB",
    "postcode": "E14 4HD"
  },
  "payments": [
    {
      "id": "7c97ce7e-a7e4-4ff9-b3ca-absgdjwuio12",
      "state": "COMPLETED",
      "created_at": "2021-01-14T18:37:48.069092Z",
      "updated_at": "2021-01-14T18:38:39.476986Z",
      "amount": {
        "value": 50,
        "currency": "GBP"
      },
      "settled_amount": {
        "value": 67,
        "currency": "EUR"
      },
      "payment_method": {
        "type": "CARD",
        "card": {
          "card_brand": "VISA",
          "funding": "CREDIT",
          "card_country": "GB",
          "card_bin": "459664",
          "card_last_four": "6376",
          "card_expiry": "03/2025",
          "cardholder_name": "John Doe",
          "checks": {
            "cvv_verification": "MATCH",
            "address": "NOT_MATCH",
            "postcode": "MATCH",
            "cardholder": "N_A"
          }
        }
      },
      "billing_address": {
        "street_line_1": "7 Westferry Circus",
        "street_line_2": "Revolut",
        "city": "London",
        "country_code": "GB",
        "postcode": "E14 4HD"
      },
      "risk_level": "LOW",
      "fees": [
        {
          "type": "ACQUIRING",
          "amount": {
            "value": 5,
            "currency": "GBP"
          }
        }
      ]
    }
  ]
}