Payture API

MobilePay

https://{Environment}.payture.com/api/MobilePay

Метод MobilePay используется для быстрого проведения клиентского платежа одним действием (одностадийный платеж) с помощью систем мобильных платежей Apple Pay, Google Pay, Samsung Pay.

Запрос

curl https://sandbox3.payture.com/api/MobilePay \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d PayToken={PayToken} \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \
-d Checksum=true \
-d Amount=12480 \

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

ПараметрОписаниеФормат
PayTokenПлатежные данные:
для Apple Pay — paymentData из PKPaymentToken в кодировке Base64
для Google Pay — token из paymentData в кодировке Base64
для Samsung Pay — paymentCredential в кодировке Base64
String
Mandatory
String
Mandatory
KeyНаименование платежного Терминала
Предоставляется с параметрами тестового/рабочего доступа
String
Mandatory
OrderIdУникальный идентификатор платежа в системе Продавца
Рекомендуемый формат: GUID/UUID или Alphanumeric. Другие форматы могут вызвать сбои в работе банковских сервисов.
String [1..50]
Mandatory
AmountСумма платежа в копейках (или другая минимальная единица валюты терминала)
Обязательный параметр для Google Pay. Amount должен совпадать с суммой в токене.
Для Samsung Pay и Apple Pay используется только при «Checksum=True» (для Samsung Pay и Apple Pay сумма платежа используется из токена)
Integer
Optional
SecureCodeCVV2/CVC2 код
Параметр обязателен при оплате нетокенизированной картой через Google Pay
Integer
Optional
CustomFieldsДополнительные поля транзакции
Url Encoded строка, содержащая пары ключей и их значений, разделённые символом «;» (точка с запятой). Ключи и значения разделены символом «=» (равно)
String
Optional
ChecksumФлаг, используемый для проверки совпадения сумм в токенах Apple Pay или Samsung Pay и параметре Amount с точностью до 100 копеекBoolean
Optional
ChequeИнформация о чеке в формате JSON, закодированная в Base64String
Optional

Ответ

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

<Pay OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" Key="Merchant" Success="True" Amount="12480"/>

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

ПараметрОписаниеФормат
SuccessПризнак успешности операции. Принимает значения:
True — операция успешна
False — операция неуспешна
3DS — необходима аутентификация 3‑D Secure
String
Mandatory
OrderIdИдентификатор платежа в системе Продавца
Соответствует переданному в запросе
String [1..50]
Mandatory
KeyНаименование платежного Терминала
Соответствует переданному в запросе
String
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
FinalTerminalКонечный Терминал, на котором был выполнен платеж
Передается, если было перенаправление на другой Терминал
String
Optional
AddInfoДополнительные параметры транзакции, которые могут быть переданы в ответе платежного шлюза по согласованию со службой поддержки Payture
Описание формата и возможных параметров доступно здесь
Object
Optional
ErrCodeКод ошибки. См. коды ошибок
Передается, если «Success=False»
String
Optional

MobileBlock

https://{Environment}.payture.com/api/MobileBlock

Метод MobileBlock позволяет блокировать денежные средства на карте Покупателя, добавленной в сервисах Apple Pay, Google Pay, Samsung Pay.

Запрос

curl https://sandbox3.payture.com/api/MobileBlock \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d PayToken={PayToken} \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \
-d Checksum=true \
-d Amount=12480 \

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

ПараметрОписаниеФормат
PayTokenПлатежные данные:
для Apple Pay — paymentData из PKPaymentToken в кодировке Base64
для Google Pay — token из paymentData в кодировке Base64
для Samsung Pay — paymentCredential в кодировке Base64
String
Mandatory
String
Mandatory
KeyНаименование платежного Терминала
Предоставляется с параметрами тестового/рабочего доступа
String
Mandatory
OrderIdУникальный идентификатор платежа в системе Продавца
Рекомендуемый формат: GUID/UUID или Alphanumeric. Другие форматы могут вызвать сбои в работе банковских сервисов.
String [1..50]
Mandatory
AmountСумма платежа в копейках (или другая минимальная единица валюты терминала)
Обязательный параметр для Google Pay. Amount должен совпадать с суммой в токене.
Для Samsung Pay и Apple Pay используется только при «Checksum=True» (для Samsung Pay и Apple Pay сумма платежа используется из токена)
Integer
Optional
SecureCodeCVV2/CVC2 код
Параметр обязателен при оплате нетокенизированной картой через Google Pay
Integer
Optional
CustomFieldsДополнительные поля транзакции
Url Encoded строка, содержащая пары ключей и их значений, разделённые символом «;» (точка с запятой). Ключи и значения разделены символом «=» (равно)
String
Optional
ChecksumФлаг, используемый для проверки совпадения сумм в токенах Apple Pay или Samsung Pay и параметре Amount с точностью до 100 копеекBoolean
Optional
ChequeИнформация о чеке в формате JSON, закодированная в Base64String
Optional

Ответ

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

<Block OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" Key="Merchant" Success="True" Amount="12480"/>

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

ПараметрОписаниеФормат
SuccessПризнак успешности операции. Принимает значения:
True — операция успешна
False — операция неуспешна
3DS — необходима аутентификация 3‑D Secure
String
Mandatory
OrderIdИдентификатор платежа в системе Продавца
Соответствует переданному в запросе
String [1..50]
Mandatory
KeyНаименование платежного Терминала
Соответствует переданному в запросе
String
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
FinalTerminalКонечный Терминал, на котором был выполнен платеж
Передается, если было перенаправление на другой Терминал
String
Optional
AddInfoДополнительные параметры транзакции, которые могут быть переданы в ответе платежного шлюза по согласованию со службой поддержки Payture
Описание формата и возможных параметров доступно здесь
Object
Optional
ErrCodeКод ошибки. См. коды ошибок
Передается, если «Success=False»
String
Optional