Unblock
https://{Environment}.payture.com/apim/UnblockThis request fully releases funds previously held on the Customer's card. It is used as part of the two-step payment flow.
Processing the request fully releases the hold.
Important! For the release to succeed, the payment must have the Authorized status at the time the request is processed.
Request
curl https://sandbox3.payture.com/apim/Unblock \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d Password=123 \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \Parameter names in requests are case-sensitive
| Parameter | Description | Format |
|---|---|---|
| Key | Payment terminal name Provided with the test/production access credentials | String Mandatory |
| Password | Payment terminal password Provided with the test/production access credentials | String Mandatory |
| OrderId | Unique payment ID in the Merchant's system Recommended format: GUID/UUID or alphanumeric. Other formats may cause failures in banking services | String [1..50] Mandatory |
Response
XML string with the Unblock element
Response examples
<Unblock Success="True" OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" NewAmount="0"/>| Parameter | Description | Format |
|---|---|---|
| Success | Operation success flag. Possible values:True — the operation succeededFalse — the operation failed | String Mandatory |
| OrderId | Payment ID in the Merchant's system Matches the value passed in the request | String [1..50] Mandatory |
| NewAmount | Remaining held amount, always "0" Returned if “Success=True” | Integer Optional |
| ErrCode | Error code. See error codes Returned if “Success=False” | String Optional |
