3.2. /api/v2/account-verification-form

Введение

Верификация аккаунта с непрямой передачей карточных данных инициируется через HTTPS POST запрос, используя URL и параметры, указанные ниже. Используйте SHA-1 шифрование для аутентификации. См. Статусы.

API URL

Примечание

Путь API URL не должен быть задан фиксированным значением, т.к. он может быть изменён позднее.

Интеграционная среда

Производственная среда

https://sandbox.payneteasy.com/paynet/api/v2/account-verification-form/ENDPOINTID

https://gate.payneteasy.com/paynet/api/v2/account-verification-form/ENDPOINTID

https://sandbox.payneteasy.com/paynet/api/v2/account-verification-form/group/ENDPOINTGROUPID

https://gate.payneteasy.com/paynet/api/v2/account-verification-form/group/ENDPOINTGROUPID

Параметры запроса

Примечание

Запрос должен иметь заголовок content-type=application/x-www-form-urlencoded.
Начальные и конечные пробелы во параметрах запроса будут пренебрежены
Банк-эквайер может изменить обязательность некоторых полей.

Название параметра

Описание

Значение

client_orderid

Уникальный идентификационный номер Присоединяющейся Стороны.
Необходимость: Обязательно
Тип: String
Длина: 128

order_desc

Краткое описание.
Необходимость: Обязательно
Тип: String
Длина: 64k

address1

Адрес Плательщика, строка 1. (Обратите внимание, что в некоторых случаях невозможно отправить адрес длиной более 50 символов. Для получения более подробной информации обратитесь к вашему менеджеру.)
Необходимость: Обязательно
Тип: String
Длина: 256

city

Город Плательщика.
Необходимость: Обязательно
Тип: String
Длина: 50

zip_code

Почтовый индекс Плательщика.
Необходимость: Обязательно
Тип: String
Длина: 10

country

Страна Плательщика. Для списка действительных кодов см. Коды стран.
Необходимость: Обязательно
Тип: String
Длина: 2

email

Адрес электронной почты Плательщика.
Необходимость: Обязательно
Тип: String
Длина: 50

ipaddress

IP-адрес плательщика, также включен в проверки на мошенничество.
Необходимость: Обязательно
Тип: String
Длина: 45

control
Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
1. <ENDPOINTID | ENDPOINTGROUPID> (см: Request URL)
2. Параметр запроса: client_orderid
3. Параметр запроса: email
4. merchant_control (Контрольный ключ, назначенный для аккаунта Присоединяющейся Cтороны в системе Payneteasy).
Необходимость: Обязательно
Тип: String
Длина: 128

first_name

Имя Плательщика.
Необходимость: Условно
Тип: String
Длина: 50

last_name

Фамилия Плательщика.
Необходимость: Условно
Тип: String
Длина: 50

ssn

Последние четыре цифры номера социального страхования Плательщика.
Необходимость: Условно
Тип: Numeric
Длина: 32

birthday

Дата рождения Плательщика в формате ГГГГММДД.
Необходимость: Условно
Тип: Numeric
Длина: 8

state

Штат Плательщика. Для списка действительных кодов штатов см. Обязательные коды штатов. Требуется для США, Канады и Австралии.
Необходимость: Условно
Тип: String
Длина: 2-3

phone

Полный международный номер телефона Плательщика, включая код страны.
Необходимость: Условно
Тип: String
Длина: 15

cell_phone

Полный номер мобильного телефона Плательщика, включая код страны.
Необходимость: Условно
Тип: String
Длина: 15

currency

Валюта, в которой проводится операция (см. Коды валют). Примеры значений: USD для доллара США, EUR для европейского евро, RUB для российского рубля.
Необходимость: Условно
Тип: String
Длина: 3

site_url

URL-адрес сайта электронной коммерции, откуда происходит платеж.
Необходимость: Условно
Тип: String
Длина: 128

redirect_url
URL-адрес, на который будет перенаправлен Плательщик после получения финального статуса транзакции. Перенаправление будет осущствлено в независимости от финального статуса (успешно, неуспешно и т.д.). См. Статусы.
Присоединяющаяся Сторона не должна использовать параметры, которые посылаются вместе с HTTP-запросом перенаправления на обработку статуса транзакции. Вместо этого Присоединяющаяся Сторона может использовать server_callback_url или АПИ команду запроса статуса. Если же нет необходимости перенаправлять Плательщика, вписать https://doc.payneteasy.com. Использовать или параметр redirect_url, или комбинацию параметров redirect_success_url и redirect_fail_url, не оба.
Необходимость: Условно
Тип: String
Длина: 1024

redirect_success_url
URL-адрес, на который будет перенаправлен Плательщик после получения успешного статуса транзакции.(cм. Статусы транзакций).
Присоединяющаяся Сторона не должна использовать параметры, которые посылаются вместе с HTTP-запросом перенаправления на обработку статуса транзакции. Вместо этого Присоединяющаяся Сторона может использовать server_callback_url или АПИ команду запроса статуса. Если же нет необходимости перенаправлять Плательщика, вписать https://doc.payneteasy.com. Использовать или параметр redirect_url, или комбинацию параметров redirect_success_url и redirect_fail_url, не оба.
Необходимость: Условно
Тип: String
Длина: 1024

redirect_fail_url
URL-адрес, на который будет перенаправлен Плательщик после получения неуспешного статуса транзакции.(cм. Статусы транзакций).
Присоединяющаяся Сторона не должна использовать параметры, которые посылаются вместе с HTTP-запросом перенаправления на обработку статуса транзакции. Вместо этого Присоединяющаяся Сторона может использовать server_callback_url или АПИ команду запроса статуса. Если же нет необходимости перенаправлять Плательщика, вписать https://doc.payneteasy.com. Использовать или параметр redirect_url, или комбинацию параметров redirect_success_url и redirect_fail_url, не оба.
Необходимость: Условно
Тип: String
Длина: 1024

server_callback_url

URL-адрес, по которому будет отправлен обратный вызов с результатом транзакции. Присоединяющаяся Сторона может использовать server callback URL для обработки завершения транзакции, т.е. собирать данные оплаты в информационной системе Присоединяющейся Стороны. Для получения информации о списке параметров, которые посылаются вместе с обратным вызовом сервера в параметре server_callback_url, см. Параметры Обратного Вызова Присоединяющейся Стороны.
Необходимость: Условно
Тип: String
Длина: 128

notify_url
URL, where the transaction status is sent to. Connecting Party may use notify URL for custom processing of the transaction completion, e.g. to collect payment data in the Connecting Party’s information system. For the list of parameters which come along with server callback to notify_url refer to Connecting Party callback parameters. This parameter can be sent instead of server_callback_url. If notify_url is sent, Payment Gateway sends callback notification once the original transaction receives final status, and about every future update for this original transaction (reversal, chargeback, etc). If server_callback_url is sent, Payment Gateway sends callback notification only when original transaction receives final status.
Необходимость: Условно
Тип: String
Длина: 128

preferred_language

Двухбуквенный код языка Плательщика для многоязычных платежных форм.
Необходимость: Условно
Тип: String
Длина: 2

merchant_form_data

Ключи и значения, отправленные в параметре MERCHANT_FORM_DATA, делятся на макросы с тем же именем. Параметр должен использовать URL кодировку (urlencode), например: testparam%3Dtest1%26mynewparam%3Dtest2 делится на макросы $MFD_testparam = test1 и $MFD_mynewparam = test2 в форме. Символы ключей параметра [a-zA-Z0-9], символы значений параметра [a-zA-Z0-9], управляющие символы [=&], максимальный размер 2 МБ. Например, этот параметр можно использовать для отображения формы платежа в светлом/темном режиме в зависимости от переданного значения (для переданного параметра merchant_form_data=theme%3Ddark, вместо макроса $MFD_theme в форме оплаты будет значение dark.
Необходимость: Условно
Тип: String
Длина: 128

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

Примечание

Ответ имеет заголовок Content-Type: text/html;charset=utf-8. Все поля имеют кодировку x-www-form-urlencoded, с символом (0xA) в конце значения каждого параметра.

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

Описание

type
Тип ответа. Может принимать такие значения как - async-response, validation-error, error и т.д.
Если тип ответа принимает значение validation-error или error, параметры error-message и error-code будут содержать информациюоб ошибке.

payet-order-id

Номер заказа в системе Payneteasy.

merchant-order-id

Номер заказа в системе Присоединяющейся Стороны.

serial-number

Уникальный номер, присвоенный сервером Doc2.0 конкретному запросу от Присоединяющейся Стороны.

error-message

Для транзакций в статусе error этот параметр будет содержать причину отклонения или сведения об ошибке.

error-code

Код ошибки для транзакций в статусе error.

redirect-url

URL, на который Присоединяющаяся Сторона должна перенаправить браузер Плательщика. Присоединяющаяся Сторона отправляет HTTP 302 см. Верификация аккаунта с непрямой передачей карточных данных.

Пример запроса

POST /paynet/api/v2/account-verification-form/39915 HTTP/1.1
User-Agent: curl/7.83.0
Accept: */*
Content-Length: 565
Content-Type: application/x-www-form-urlencoded
Connection: close

client_orderid=34T43R77N
&order_desc=Test Order Описание
&first_name=John
&last_name=Smith
&ssn=1267
&birthday=19820115
&address1=100 Main st
&city=Seattle
&state=WA
&zip_code=98102
&country=US
&phone=+12063582043
&cell_phone=+19023384543
&email=[email protected]
&ipaddress=65.153.12.232
&site_url=www.google.com
&currency=USD
&purpose=user_account1
&redirect_url=http://connectingparty.com/result
&server_callback_url=https://httpstat.us/200
&merchant_data=VIP customer
&merchant_form_data=testparam%3Dtest1%26mynewparam%3Dtest2
&control=5112b51084be33fa331d995d17b9d82af3bfbbc9

Пример успешного ответа

HTTP/1.1 200
Server: server
Date: Wed, 10 May 2023 09:07:27 GMT
Content-Type: text/html;charset=utf-8
Connection: close
Vary: Accept-Encoding
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Language: en-US
Strict-Transport-Security: max-age=31536000
Content-Length: 285

type=async-form-response
&serial-number=00000000-0000-0000-0000-000002e378e8
&merchant-order-id=34T43R77N
&paynet-order-id=6998044
&redirect-url=https%3A%2F%2Fsandbox.payneteasy.com%2Fpaynet%2Fform%2Finit%2FBB587546567A31587163597A684535634A775969614A5538374E4535734B44743364784335716A7979316B673D

Пример неуспешного ответа

HTTP/1.1 200
Server: server
Date: Mon, 22 May 2023 11:36:59 GMT
Content-Type: text/html;charset=utf-8
Connection: close
Vary: Accept-Encoding
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Content-Language: en-US
Strict-Transport-Security: max-age=31536000
Content-Length: 152

type=validation-error
&serial-number=00000000-0000-0000-0000-000002e5c587
&merchant-order-id=34T43R77N
&error-message=INVALID_CONTROL_CODE
&error-code=2

Коллекция Postman

Конструктор запросов

endpointid or groupid

input the ENDPOINTID or ENDPOINTGROUPID

client_orderid

make it or use the internal invoice ID

order_desc
first_name
last_name
ssn
birthday
address1
city
state
zip_code
country
phone
cell_phone
email
ipaddress
site_url
currency
purpose
merchant_control

input the Control Key

redirect_url
redirect_success_url
redirect_fail_url
notify_url
server_callback_url
merchant_data
merchant_form_data

String to sign
Signature