Capture

This transaction captures the money previously held by the corresponding authorization transaction. As a result, the issuing bank credits the funds to the merchant's bank account and updates the cardholder's statement. Card regulations require a merchant to ship goods before settling the funds for an order.

---

Request

To initiate a capture transaction, send a POST request to https://gateway.mfstream.io/transactions/captures with the parameters from the tables below.

Header parameters

Content-Type required application/json Accept required application/json X-API-Version Possible values: 2, 3. By default, 3. More details here RequestID Idempotency key. More details here.

Body parameters

request object parent_uid required string A UID of the authorization transaction. amount required bigInteger An amount to capture in minimal currency units, for example 1000 for $10.00. tracking_id string (255) The ID of your transaction or order. Please, use unique values in order to get the correct transaction information by query request. Otherwise, you will get an array of up to 10 recent transactions with the matching tracking_id. Can be multiple values separated with semicolons. For example, "cbe59142-90af-4aea-b5a5-5bf3f66cf3da;f7883cb9-0e26-43a7-beb7-4027cb55d1a6;4a6a89d5-6950-400f". If multiple values are sent in the request, the transaction search in the back office system can be performed by any of them. If tracking_id is not provided, the response returns the tracking_id of the corresponding authorization transaction, provided that it was included in the authorization request. additional_data object A section with additional transaction data. referer string URL of the resource from which the transaction request is made. Contact the Tech Support Team to check if this parameter is required by your acquirer.

Warning

If the integration supports multiple partial captures, each capture request is treated as a separate transaction.

If a 5xx response is received or a network error occurs after sending the request, it is recommended to check the transaction status by tracking_id. If no transaction is found, resend the original request using the same idempotency key.

Resending the request without an idempotency key or with a new idempotency key may result in an additional partial capture.

Example of the request

{
  "request": {
    "parent_uid": "1-310b0da80b",
    "amount": 50,
    "tracking_id": "tracking_id_2",
    "additional_data": {
      "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
    }
  }
}

Response

transaction object uid required string A UID of the processed transaction. tracking_id required string The tracking_id parameter value sent in the transaction request. If tracking_id was not provided in the capture request but was provided in the corresponding authorization request, the response returns the tracking_id of the corresponding authorization transaction. status required string A status of the processed transaction. message required string A processing result message corresponding to the code. For certain integration options, this parameter contains the processing result message provided by the acquirer. type required string A transaction type. receipt_url required string A transaction receipt URL. additional_data object A section of detailed information about the transaction. referer string URL of the resource from which the transaction request is made. smart_routing_verification object A section of parameters of Smart Routing verification results. status string Smart Routing check status for the transaction. capture object message string A processing result message provided by the acquirer. ref_id string A transaction reference ID provided by the acquirer. rrn string A retrieval reference number. A transaction ID issued by the card processing service. auth_code string An authorization code provided by the acquirer. gateway_id string Gateway ID in the MF STREAM system. status string A status of the processed transaction in the acquiring bank. code required string Transaction processing code . friendly_message required string A customer-friendly message corresponding to the code. For certain integration options, this parameter contains the processing result message provided by the acquirer.

Example of the response

{
    "transaction": {
        "uid": "52bfc29a-2c2f-408a-a7d5-bd8e84a320a9",
        "status": "successful",
        "amount": 460,
        "currency": "EUR",
        "type": "capture",
        "message": "Successfully processed",
        "test": true,
        "created_at": "2024-04-02T12:07:14.881Z",
        "updated_at": "2024-04-02T12:07:20.028Z",
        "paid_at": "2024-04-02T12:07:19.955Z",
        "closed_at": null,
        "settled_at": null,
        "manually_corrected_at": null,
        "parent_uid": "4298aabd-9547-46fa-a151-66c29489c157",
        "receipt_url": "https://backoffice.mfstream.io/customer/transactions/52bfc29a-2c2f-408a-a7d5-bd8e84a320a9/580262bb7b11a467fd85aa1c22f3c4afb4150511533c086b55eb7e53f81f4727?language=en",
        "status_code": null,
        "mute_notifications": null,
        "tracking_id": "tracking_id_2",
        "id": "52bfc29a-2c2f-408a-a7d5-bd8e84a320a9",
        "code": "S.0000",
        "friendly_message": "The operation is successful.",
        "smart_routing_verification": {
            "status": "successful"
        },       
        "capture": {
            "message": "Capture was approved",
            "ref_id": "8889912",
            "rrn": null,
            "auth_code": null,
            "bank_code": "05",
            "gateway_id": 3483,
            "status": "successful"
        },
        "additional_data": {
            "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
        }
    }
}