Activate
https://{Environment}.payture.com/vwapi/ActivateThe Activate command activates a card previously registered in the Payture system and awaiting activation. Use it when the card is verified with the add-card flow that places a hold on a small amount.
The Activate request must specify the amount held on the card when it was added via Add. If the Customer enters the held amount correctly, the card is activated and the held funds are released. If the amount is entered incorrectly, the funds are released by a separate request.
Request
curl https://sandbox3.payture.com/vwapi/Activate \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d VWID=Merchant \
--data-urlencode "DATA= \
VWUserLgn=123@ya.ru; \
VWUserPsw=2645363; \
CardId=00a94d92-1d84-44be-fa32-1c9591443347; \
Amount=101" \Parameter names in requests are case-sensitive
| Parameter | Description | Format |
|---|---|---|
| VWID | Payment terminal name Provided with the test/production access credentials | String Mandatory |
| DATA | Card parameters A URL-encoded string containing key-value pairs separated by “;” (semicolon). Keys and values are separated by “=” (equals sign) | String Mandatory |
DATA parameter keys
| Parameter | Description | Format |
|---|---|---|
| VWUserLgn | Customer identifier in the Payture system | String [1..50] Mandatory |
| VWUserPsw | Additional access parameter for the Customer's private information (Customer password) | String [1..50] Mandatory |
| CardId | Identifier, in the Payture system, of the card being activated | String [36] Mandatory |
| Amount | Amount held on the Customer's card, in kopecks (1/100 of a ruble) | Integer Mandatory |
| Amount | Amount held on the Customer's card, in kopecks (1/100 of a ruble) | Integer Mandatory |
Example of the DATA parameter (decoded):
VWUserLgn=123@ya.ru;
VWUserPsw=2645363;
CardId=00a94d92-1d84-44be-fa32-1c9591443347;
Amount=12480Response
An XML string with the Activate element
Response examples
<Activate Success="True" VWUserLgn="123@ya.ru" CardId="00a94d92-1d84-44be-fa32-1c9591443347"/>| Parameter | Description | Format |
|---|---|---|
| Success | Operation success flag. Possible values:True — the operation succeededFalse — the operation failed | String Mandatory |
| VWUserLgn | Customer identifier in the Payture system Matches the value passed in the request | String [1..50] Mandatory |
| CardId | Card identifier in the Payture system Returned if “Success=True” | String [36] Optional |
| ErrCode | Error code. See error codes Returned if “Success=False” | String Optional |
AddSubmit3DS
The AddSubmit3DS command completes adding a card protected by 3-D Secure. It is sent after the Add request (merchant side) once the 3-D Secure authentication results have been received from the issuing bank.
Remove
The command removes a payment card's data (for both activated and non-activated cards) from the Customer's card list.
