Payture eWallet

Pay

https://{Environment}.payture.com/vwapi/Pay

The vwapi/Pay request with a PayToken is used to make a payment via Apple Pay, Google Pay, or Samsung Pay.

The payment can be made using the one-step flow (SessionType=Pay) or the two-step flow (SessionType=Block).

Request

curl https://sandbox3.payture.com/vwapi/Pay \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d VWID=VWMerchantside \
--data-urlencode "DATA= \
VWUserLgn=123@ya.ru; \
VWUserPsw=2645363; \
CardId=FreePay; \
OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea; \
Amount=12480; \
PayToken={PayToken}; \
SessionType=Block; \
AdditionalField1=Value1; \
AdditionalField2=Value2" \

Parameter names in requests are case-sensitive

Parameter	Description	Format
VWID	Payment terminal name Provided with the test/production access credentials	String Mandatory
DATA	Payment parameters URL-encoded string of key-value pairs separated by “;” (semicolon). Keys and values are separated by “=” (equals sign)	String Mandatory

DATA parameter keys

Parameter	Description	Format
VWUserLgn	Customer ID in the Payture system	String [1..50] Mandatory
VWUserPsw	Additional parameter for accessing the Customer's private information (Customer password)	String [1..50] Mandatory
CardId	For Apple Pay, Google Pay, and Samsung Pay payments, pass the value `CardId=FreePay`	String [36] 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	Payment amount in kopecks (or another minor unit of the terminal currency) For this request, the payment amount is always taken from the request (not from the token). The amount must match the value in the token	Integer Mandatory
PayToken	Payment data: for Apple Pay — paymentData from PKPaymentToken, Base64-encoded for Google Pay — token from paymentData, Base64-encoded for Samsung Pay — paymentCredential, Base64-encoded	String Mandatory
SessionType	Payment type. Determines the number of payment steps: `Pay` — one-step payment (default) `Block` — two-step payment	String Optional
AddCard	Card saving flag True — the card must be added. Defaults to False	Boolean Optional
SecureCode	CVV2/CVC2 code Required when paying with a non-tokenized card via Google Pay	Integer Optional
IP	Customer's IP address IPv4 or IPv6	String Optional
Cheque	Fiscal receipt data in JSON format, Base64-encoded	String Optional
Additional parameters	Any additional Merchant parameters There can be multiple additional parameters. Each parameter is passed separately	— Optional

Example of the DATA parameter (decoded):

VWUserLgn=123@ya.ru;
VWUserPsw=2645363;
CardId=FreePay;
OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea;
Amount=12480;
PayToken={PayToken};
SessionType=Block;
SecureCode=123;
IP=241.22.197.12;
AdditionalField1=Value1;
AdditionalField2=Value2

Response

XML string with the Pay element

Response examples

<Pay VWUserLgn="123@ya.ru" OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" MerchantOrderId="[CUSTOMERS_PAY]-[1715289]-[1]" Success="True" Amount="12480"/>

Parameter	Description	Format
Success	Operation success flag. Possible values: `True` — the operation succeeded `False` — the operation failed `3DS` — 3‑D Secure authentication is required	String Mandatory
VWUserLgn	Customer ID in the Payture system Matches the value passed in the request	String [1..50] Mandatory
OrderId	Payment ID in the Merchant's system Matches the value passed in the request	String [1..50] Mandatory
MerchantOrderId	Payment ID in the Payture system Additional payment ID assigned by the Payture system. Contains the payment attempt number	String [1..50] Mandatory
Amount	Payment amount in kopecks (or another minor unit of the terminal currency) Returned if “Success=True” or “Success=3DS”. Matches the value passed in the request	Integer Optional
ACSUrl	3-D Secure authentication server (ACS) URL Returned if “Success=3DS”	String Optional
PaReq	3-D Secure authentication request Returned if “Success=3DS”	String Optional
ThreeDSKey	Unique transaction ID (MD) Returned if “Success=3DS”	String Optional
ThreeDSVersion	3-D Secure protocol version: 1.0 — version 1 2.1 — version 2 Returned if “Success=3DS”	String Optional
AddInfo	Additional transaction parameters that can be returned in the payment gateway response by arrangement with Payture support A description of the format and available parameters is available here (in Russian)	Object Optional
ErrCode	Error code. See error codes Returned if “Success=False”	String Optional

Add

https://{Environment}.payture.com/vwapi/Add

The vwapi/Add request with a PayToken is used to bind a card from Apple Pay, Google Pay, or Samsung Pay before making recurring payments.