Unblock
https://{Environment}.payture.com/api/UnblockThe Unblock command fully releases funds that were previously held with the Block command. It is used as part of the two-step payment flow.
Processing the request fully releases the amount held on the Customer's card.
Important! For the release to succeed, the payment must have the Authorized status at the time the request is processed.
curl https://sandbox3.payture.com/api/Unblock \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \Parameter names in requests are case-sensitive
Request
| Parameter | Description | Format |
|---|---|---|
| Key | Payment terminal name 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 |
Charge
The Charge command captures funds on the Customer's card that were previously held with the Block command. It is used as part of the two-step payment flow.
Refund
The Refund command returns funds charged with the Pay or Charge command to the Customer's card. It is used with both the one-step and the two-step payment flows.
