Capture Parameters

This section outlines the required parameters for processing a capture request.

Request parameters

Request

Parameter Name	Type	Mandatory	Description
version	string(10)	optional	Protocol version. Default: 1.0.1. Version 1.0 is deprecated.
order_id	string(1024)	mandatory	Order ID generated by the merchant.
merchant_id	integer(12)	mandatory	Merchant unique ID, assigned by Fondy during registration.
amount	integer(12)	mandatory	Order amount without separator.
currency	string(3)	mandatory	Order currency. Supported values: EUR — Euro USD — US Dollar GBP — Pound Sterling CZK — Czech Koruna GEL — Georgian Lari UZS — Uzbekistan Sum See full list.
signature	string(40)	mandatory	Order signature to verify merchant request consistency and authenticity. See Signature generation.

Response

Parameter Name	Type	Description
order_id	string(1024)	Order ID generated by the merchant.
merchant_id	integer(12)	Merchant unique ID, assigned by Fondy during registration.
capture_status	string(50)	Capture operation status. Possible values: hold — Capture has been created but not approved yet; the merchant must continue requesting the order status. captured — Capture completed successfully, funds are charged from the payer’s account, and will be credited to the merchant. The merchant can proceed with service delivery or shipping goods.
response_status	string(50)	Request processing status. If parameters sent by the merchant did not pass validation, the response will be failure; otherwise, it will be success.
response_code	integer(4)	Capture decline response code. Possible codes see in Response Codes.
response_description	string(1024)	Capture response code description, see Response Codes.

Examples

Request

{
  "request": {
    "version": "1.0.1",
    "order_id": "test_12343242113",
    "currency": "GEL",
    "merchant_id": 1549901,
    "amount": 100,
    "signature": "1efcb015c89da38977ae1e734aade413b95ca900"
  }
}

Normal Response

If the capture is successful, the API returns:

{
  "response": {
    "capture_status": "captured",
    "order_id": "test_12343242112",
    "response_description": "",
    "response_code": "",
    "merchant_id": 1549901,
    "response_status": "success"
  }
}

Response in case of error

If an error occurs (e.g., an invalid merchant ID), the API returns:

{
  "response": {
    "error_code": 1016,
    "error_message": "Merchant not found",
    "request_id": "Mfqk42OKu69BI",
    "response_status": "failure"
  }
}