Payture eWallet

Pay

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

Запрос vwapi/Pay c передачей PayToken используется для совершения платежа с использованием систем Apple Pay, Google Pay или Samsung Pay.

Платеж может быть выполнен по одностадийной (SessionType=Pay) или по двухстадийной схеме (SessionType=Block).

Запрос

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" \

В запросах наименования параметров чувствительны к регистру

ПараметрОписаниеФормат
VWIDНаименование платежного Терминала
Предоставляется с параметрами тестового/рабочего доступа
String
Mandatory
DATAПараметры платежа
Url Encoded строка, содержащая пары ключей и их значений, разделённые символом «;» (точка с запятой). Ключи и значения разделены символом «=» (равно)
String
Mandatory

Состав ключей параметра DATA

ПараметрОписаниеФормат
VWUserLgnИдентификатор Покупателя в системе PaytureString [1..50]
Mandatory
VWUserPswДополнительный параметр доступа к приватной информации Покупателя (пароль Покупателя)String [1..50]
Mandatory
CardIdДля платежей Apple Pay, Google Pay и Samsung Pay необходимо передавать значение CardId=FreePayString [36]
Mandatory
OrderIdУникальный идентификатор платежа в системе Продавца
Рекомендуемый формат: GUID/UUID или Alphanumeric. Другие форматы могут вызвать сбои в работе банковских сервисов.
String [1..50]
Mandatory
AmountСумма платежа в копейках (или другая минимальная единица валюты терминала)
Для текущего запроса сумма платежа всегда используется из запроса (не из токена). Сумма должна совпадать со значением в токене
Integer
Mandatory
PayTokenПлатежные данные:
для Apple Pay — paymentData из PKPaymentToken в кодировке Base64
для Google Pay — token из paymentData в кодировке Base64
для Samsung Pay — paymentCredential в кодировке Base64
String
Mandatory
String
Mandatory
SessionTypeТип платежа. Определяет количество стадий платежа:
Pay — одностадийный платеж (по умолчанию)
Block — двухстадийный платеж
String
Optional
AddCardПризнак сохранения карты
True — необходимо добавить карту. По умолчанию False
Boolean
Optional
SecureCodeCVV2/CVC2 код
Параметр обязателен при оплате нетокенизированной картой через Google Pay
Integer
Optional
IPIP адрес Покупателя
IPv4 или IPv6
String
Optional
ChequeИнформация о чеке в формате JSON, закодированная в Base64String
Optional
Дополнительные параметрыЛюбые дополнительные параметры Продавца
Дополнительных параметров может быть несколько. Каждый параметр передается отдельно

Optional

Пример параметра DATA (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

Ответ

XML строка с элементом Pay

Примеры ответов

<Pay VWUserLgn="123@ya.ru" OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" MerchantOrderId="[CUSTOMERS_PAY]-[1715289]-[1]" Success="True" Amount="12480"/>
ПараметрОписаниеФормат
SuccessПризнак успешности операции. Принимает значения:
True — операция успешна
False — операция неуспешна
3DS — необходима аутентификация 3‑D Secure
String
Mandatory
VWUserLgnИдентификатор Покупателя в системе Payture
Соответствует переданному в запросе
String [1..50]
Mandatory
OrderIdИдентификатор платежа в системе Продавца
Соответствует переданному в запросе
String [1..50]
Mandatory
MerchantOrderIdИдентификатор платежа в системе Payture
Дополнительный идентификатор платежа, присвоенный системой Payture. Содержит номер попытки совершения платежа
String [1..50]
Mandatory
AmountСумма платежа в копейках (или другая минимальная единица валюты терминала)
Передается, если «Success=True» или «Success=3DS». Соответствует переданному в запросе
Integer
Optional
ACSUrlАдрес сервера аутентификации 3-D Secure
Передается, если «Success=3DS»
String
Optional
PaReqЗапрос на аутентификацию 3-D Secure
Передается, если «Success=3DS»
String
Optional
ThreeDSKeyУникальный идентификатор транзакции (MD)
Передается, если «Success=3DS»
String
Optional
ThreeDSVersionВерсия протокола 3-D Secure:
1.0 — первая версия
2.1 — вторая версия
Передается, если «Success=3DS»
String
Optional
AddInfoДополнительные параметры транзакции, которые могут быть переданы в ответе платежного шлюза по согласованию со службой поддержки Payture
Описание формата и возможных параметров доступно здесь
Object
Optional
ErrCodeКод ошибки. См. коды ошибок
Передается, если «Success=False»
String
Optional

Add

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

Запрос vwapi/Add с передачей PayToken используется для привязки карты из Apple Pay, Google Pay или Samsung Pay перед выполнением рекуррентных платежей.

Запрос

curl https://sandbox3.payture.com/vwapi/Add \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d VWID=VWMerchantside \
--data-urlencode "DATA= \
VWUserLgn=123@ya.ru; \
VWUserPsw=2645363; \
PayToken={PayToken}; \
AdditionalField1=Value1; \
AdditionalField2=Value2" \

В запросах наименования параметров чувствительны к регистру

ПараметрОписаниеФормат
VWIDНаименование платежного Терминала
Предоставляется с параметрами тестового/рабочего доступа
String
Mandatory
DATAПараметры платежа
Url Encoded строка, содержащая пары ключей и их значений, разделённые символом «;» (точка с запятой). Ключи и значения разделены символом «=» (равно)
String
Mandatory

Состав ключей параметра DATA

ПараметрОписаниеФормат
VWUserLgnИдентификатор Покупателя в системе PaytureString [1..50]
Mandatory
VWUserPswДополнительный параметр доступа к приватной информации Покупателя (пароль Покупателя)String [1..50]
Mandatory
PayTokenПлатежные данные:
для Apple Pay — paymentData из PKPaymentToken в кодировке Base64
для Google Pay — token из paymentData в кодировке Base64
для Samsung Pay — paymentCredential в кодировке Base64
String
Mandatory
String
Mandatory
SecureCodeCVV2/CVC2 код
Параметр обязателен при оплате нетокенизированной картой через Google Pay
Integer
Optional
PhoneNumberНомер телефона Покупателя
Только цифры, без разделителей. Формат: [код страны][код оператора][номер абонента]
String
Optional
Дополнительные параметрыЛюбые дополнительные параметры Продавца
Дополнительных параметров может быть несколько. Каждый параметр передается отдельно

Optional

Пример параметра DATA (decoded):

VWUserLgn=123@ya.ru;
VWUserPsw=2645363;
PayToken={PayToken};
SecureCode=123;
PhoneNumber=79156783333;
AdditionalField1=Value1;
AdditionalField2=Value2

Ответ

XML строка с элементом Add

Примеры ответов

<Add VWUserLgn="123@ya.ru" Success="True" CardName="411111xxxxxx1112" CardId="00a94d92-1d84-44be-fa32-1c9591443347"/>
ПараметрОписаниеФормат
SuccessПризнак успешности операции. Принимает значения:
True — операция успешна
False — операция неуспешна
3DS — необходима аутентификация 3‑D Secure
String
Mandatory
VWUserLgnИдентификатор Покупателя в системе Payture
Соответствует переданному в запросе
String [1..50]
Mandatory
CardNameМаскированный номер карты (первые 6 и последние 4 цифры: 123456хххххх1234)
Передается, если «Success=True» или «Success=3DS»
String [13..19]
Optional
CardIdИдентификатор карты в системе Payture
Передается, если «Success=True» или «Success=3DS»
String [36]
Optional
ACSUrlАдрес сервера аутентификации 3-D Secure
Передается, если «Success=3DS»
String
Optional
PaReqЗапрос на аутентификацию 3-D Secure
Передается, если «Success=3DS»
String
Optional
ThreeDSKeyУникальный идентификатор транзакции (MD)
Передается, если «Success=3DS»
String
Optional
ThreeDSVersionВерсия протокола 3-D Secure:
1.0 — первая версия
2.1 — вторая версия
Передается, если «Success=3DS»
String
Optional
AddInfoДополнительные параметры транзакции, которые могут быть переданы в ответе платежного шлюза по согласованию со службой поддержки Payture
Описание формата и возможных параметров доступно здесь
Object
Optional
ErrCodeКод ошибки. См. коды ошибок
Передается, если «Success=False»
String
Optional