Capture payment (clearing)

Captures the amount of a two-step payment (pg_auto_clearing = 0) that was blocked at authorization.

One clearing per payment: capture the full amount or a part of it; the rest of the amount is released to the client.

pg_status = ok means that the request is processed, not that the amount is captured: check pg_clearing_amount in the response. 0 means that nothing is captured: the amount is greater than the payment amount, the payment is not successful or cancelled, or the payment system declined the clearing.

A repeated request does not capture the amount again: the response returns the amount captured earlier. For a one-step payment the response returns the full amount.

If neither clearing nor cancel is requested within 5 days (the period can be changed for the merchant), the payment is captured or cancelled automatically, depending on the merchant settings. Test payments are not processed automatically.

Test cards: see Merchant API Overview.

Clearing flow

Result

`pg_status`	`pg_clearing_amount`	Meaning	Next step
`ok`	greater than `0`	The amount is captured.	To return the money later, call Refund payment.
`ok`	`0`	Nothing is captured.	Check the payment with Get payment status.
`error`	—	The request is rejected.	See «Errors» below.

Errors

The HTTP status is always 200; the error is returned in pg_error_code and pg_error_description. Error responses are not signed.

`pg_error_code`	When	What to do
`340`	The payment is not found, is not paid yet or is not a card payment.	Check `pg_payment_id`.
`1100`	The signature is missing or invalid.	Check the signature: see Merchant API Overview.
Other codes	Other errors of the request.	See Error codes.

Request example

Required fields only. pg_sig is calculated with the secret key test_secret_key.
Line breaks in the body are added for readability: send the body as one line.

Responses

🟢200Success

application/xml

Bodyapplication/xml

Examples

Captured part of the amountCaptured the full amountNot captured

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_amount>100</pg_amount>
    <pg_clearing_amount>40</pg_clearing_amount>
    <pg_status>ok</pg_status>
    <pg_salt>9b2aaedvray9F4i3</pg_salt>
    <pg_sig>c980c4c95df5e9e83830d1daf68c42f1</pg_sig>
</response>

🟢200Error

Capture payment (clearing)

Clearing flow#

Result#

Errors#

Request example#

Request

Responses

Clearing flow

Result

Errors

Request example