Skip to content

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.overpay.io/transactions/captures with the following parameters:
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.
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.
Example of the request 
{
  "request": {
    "parent_uid": "1-310b0da80b",
    "amount": 50,
    "additional_data": {
      "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
    }
  }
}
Response
object
uid
required
 string
A UID of the processed transaction.
status
required
 string
A status of the processed transaction.
message
required
 string
A processing result message corresponding to the processing code (code).
type
required
 string
A transaction type.
receipt_url
required
 string
A transaction receipt URL.
object
A section of detailed information about the transaction.
referer
 string
URL of the resource from which the transaction request is made.
object
A section of parameters of Smart Routing verification results.
status
 string
Smart Routing check status for the transaction.
code
required
 string
Transaction processing code .
friendly_message
required
 string
code description for the customer.
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.overpay.io/customer/transactions/52bfc29a-2c2f-408a-a7d5-bd8e84a320a9/580262bb7b11a467fd85aa1c22f3c4afb4150511533c086b55eb7e53f81f4727?language=en",
        "status_code": null,
        "mute_notifications": null,
        "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"
        }
    }
}

YA Integration option

It is impossible to receive the final transaction status in the synchronous response to the capture request: the response will be sent with the incomplete transaction status, the final transaction status will be specified in the webhook notification.

Info

Example of the synchronous response 
{
  "transaction": {
    "uid": "acd0f07e-5509-4081-82ff-28a2b0c77271",
    "status": "incomplete",
    "amount": 200,
    "currency": "RUB",
    "type": "capture",
    "message": "Unknown transaction status. Contact the payment service provider for details.",
    "test": false,
    "created_at": "2025-10-10T08:28:23.059Z",
    "updated_at": "2025-10-10T08:28:24.755Z",
    "paid_at": null,
    "closed_at": null,
    "settled_at": null,
    "manually_corrected_at": null,
    "parent_uid": "595cbea6-9463-4dd1-a508-a3e1cc5a25ee",
    "receipt_url": "https://backoffice.overpay.io/customer/transactions/acd0f07e-5509-4081-82ff-28a2b0c77271/260ee21c4f3100d9d247f21603afd723d8a1129698e9a6d4f183806acd79dbd0?language=en",
    "status_code": null,
    "mute_notifications": null,
    "version": 3,
    "psp_settled_at": null,
    "registry_id": null,
    "tracking_id": "ebc6fae9-70f5-47f6-a9d8-2b685dba3551",
    "credit_card": {
      "holder": "John Doe",
      "stamp": "c891ed42d05a6a9e33dd15914f04b33ee8e80c5695ea9e9f05070b6017fed87c",
      "brand": "visa",
      "last_4": "0178",
      "first_1": "4",
      "bin": "405106",
      "bin_8": "40510600",
      "issuer_country": null,
      "issuer_name": null,
      "product": null,
      "exp_month": 12,
      "exp_year": 2026,
      "token_provider": null,
      "token": "fdcc6f93-cd35-4dba-af8e-8d2a185d770f"
    },
    "id": "acd0f07e-5509-4081-82ff-28a2b0c77271",
    "code": "P.9999",
    "friendly_message": "Unknown transaction status. Contact the merchant for details.",
    "capture": {
      "message": "Confirmed",
      "ref_id": "3091820",
      "rrn": null,
      "auth_code": null,
      "bank_code": "200",
      "gateway_id": 5782,
      "status": "incomplete"
    }
  }
}
Example of the webhook notification with the final transaction status 
{
  "transaction": {
    "uid": "acd0f07e-5509-4081-82ff-28a2b0c77271",
    "status": "successful",
    "amount": 200,
    "currency": "RUB",
    "type": "capture",
    "message": "Successfully processed",
    "test": false,
    "created_at": "2025-10-10T08:28:23.059Z",
    "updated_at": "2025-10-10T08:28:28.244Z",
    "paid_at": "2025-10-10T08:28:28.155Z",
    "closed_at": null,
    "settled_at": null,
    "manually_corrected_at": null,
    "parent_uid": "595cbea6-9463-4dd1-a508-a3e1cc5a25ee",
    "receipt_url": "https://backoffice.overpay.io/customer/transactions/acd0f07e-5509-4081-82ff-28a2b0c77271/260ee21c4f3100d9d247f21603afd723d8a1129698e9a6d4f183806acd79dbd0?language=en",
    "status_code": null,
    "mute_notifications": null,
    "version": 6,
    "psp_settled_at": null,
    "registry_id": null,
    "tracking_id": "ebc6fae9-70f5-47f6-a9d8-2b685dba3551",
    "credit_card": {
      "holder": "John Doe",
      "stamp": "c891ed42d05a6a9e33dd15914f04b33ee8e80c5695ea9e9f05070b6017fed87c",
      "brand": "visa",
      "last_4": "0178",
      "first_1": "4",
      "bin": "405106",
      "bin_8": "40510600",
      "issuer_country": null,
      "issuer_name": null,
      "product": null,
      "exp_month": 12,
      "exp_year": 2026,
      "token_provider": null,
      "token": "fdcc6f93-cd35-4dba-af8e-8d2a185d770f"
    },
    "id": "acd0f07e-5509-4081-82ff-28a2b0c77271",
    "code": "S.0000",
    "friendly_message": "The transaction is successfully processed.",
    "capture": {
      "message": "Transaction was successfully processed.",
      "ref_id": "3091820",
      "rrn": null,
      "auth_code": null,
      "bank_code": "200",
      "gateway_id": 5782,
      "status": "successful"
    }
  }
}