Charge
https://{Environment}.payture.com/api/ChargeThe 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.
Processing the request charges the Customer's card for an amount that does not exceed the held amount (equal to or less than it).
Important! For the capture to succeed, the payment must have the Authorized status at the time the request is processed.
Request parameters
curl https://sandbox3.payture.com/api/Charge \
-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
| 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 |
| Amount | Amount to capture, in kopecks. If the parameter is omitted, the full amount is captured Digits only, without decimal or other separators | Integer Optional |
| Cheque | Fiscal receipt data in JSON format, Base64-encoded | String Optional |
Response
XML string with the Charge element
Response examples
<Charge Success="True" OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" Amount="12564"/>| 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 |
| Amount | Final amount charged to the Customer's card Returned if “Success=True” | Integer Optional |
| Amount | Final amount charged to the Customer's card Returned if “Success=True” | Integer Optional |
| ErrCode | Error code. See error codes Returned if “Success=False” | String Optional |
Block3DS
The Block3DS command completes the hold of funds on a card protected by 3-D Secure. It is called after the Block request, once the 3-D Secure authentication results have been received from the issuing bank.
Unblock
The Unblock command fully releases funds that were previously held with the Block command. It is used as part of the two-step payment flow.
