Capture

CAPTURE request

The CAPTURE request settles a transaction that was previously authorized by a SALE sent with auth=Y. The held funds are transferred to the Merchant's account.

The authorization stays in PENDING status until it is captured or released. To release it instead of capturing, send CREDITVOID.

This request is sent by POST in the background (e.g. through PHP CURL).

Availability

Two-stage payments depend on the connector supporting the mode, and are implemented for the wallet brands applepay and googlepay. Confirm availability with your account manager before using auth=Y for any other brand. See Two-stage payments.

Request parameters

Parameter	Description	Limitations	Required
action	Action to perform	= CAPTURE	+
client_key	Unique client key	CLIENT_KEY	+
trans_id	Transaction ID of the authorization in the Payment Platform	String up to 255 characters	+
amount	The amount to capture. Only one partial capture is allowed. If omitted, the full authorized amount is captured.	Format depends on currency. See the SALE request for the per-currency format rules.	-
hash	Special signature to validate your request to Payment Platform	See Appendix A, Capture signature.	+

Response parameters

You will get JSON encoded string with transaction result.

Successful capture response

Parameter	Description
action	CAPTURE
result	SUCCESS
status	SETTLED
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform
amount	Amount of capture
currency	Currency

Unsuccessful capture response

Parameter	Description
action	CAPTURE
result	DECLINED
status	PENDING
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform
amount	Amount of capture
currency	Currency
decline_reason	The reason why the capture was declined

Undefined capture response

Parameter	Description
action	CAPTURE
result	UNDEFINED
status	PENDING
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform

Callback parameters

Successful capture response

Parameter	Description
action	CAPTURE
result	SUCCESS
status	SETTLED
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform
amount	Amount of capture
currency	Currency
connector_name *	Connector's name (Payment Gateway)
rrn *	Retrieval Reference Number value from the acquirer system
approval_code *	Approval code value from the acquirer system
gateway_id *	Gateway ID - transaction identifier provided by payment gateway
extra_gateway_id *	Extra Gateway ID - additional transaction identifier provided by payment gateway
merchant_name *	Merchant Name
mid_name *	MID Name
hash	Special signature, used to validate callback, see Appendix A

* The parameters are included if the appropriate setup is configured in the admin panel (see "Add Extended Data to Callback" block in the Configurations -> Protocol Mappings section).

Unsuccessful capture response

Parameter	Description
action	CAPTURE
result	DECLINED
status	PENDING
order_id	Transaction ID in the Merchant's system
trans_id	Transaction ID in the Payment Platform
trans_date	Transaction date in the Payment Platform
decline_reason	The reason why the capture was declined
hash	Special signature, used to validate callback, see Appendix A

warning

Do not use VOID to release a held authorization. VOID applies to payments in SETTLED status only and returns Void is not allowed. for an authorization that has not been captured.