3.26. /api/v2/card-insurance-document

Формирование запроса

После успешного проведения транзакции, необходимо сформировать запрос для скачивания полиса страхования с данными Клиента в формате PDF.
Запрос инициируется на указанный ниже URL. Для подписания запроса используется OAuth HMAC-SHA1 авторизация.

API URLs

Интеграция

Боевая Среда

https://sandbox.payneteasy.com/paynet/api/v2/card-insurance-document/ENDPOINTID

https://gate.payneteasy.com/paynet/api/v2/card-insurance-document/ENDPOINTID

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

Имя параметра запроса

Описание

client-order-id

Номер Клиента в системе

order_id

Идентификатор заказа, назначенный в Payneteasy.

endpoint_id

Номер терминала в системе, по которому совершалась операция

consumer_key

Логин торговца в системе

consumer_secret

Контрольный ключ торговца

Note

Для формирования запроса можно воспользоваться инструментом отладки (ссылка на отладку). Формировать запрос требуется для родительской транзакции. Для этого необходимо подставить имеющиеся данные для доступа к системе: endpoint_id, consumer_key, consumer_secret и заполнить остальные параметры запроса.

HTTP method
URL
parameters
version
consumer key
consumer secret
timestamp
nonce
signature method

normalized parameters
signature base string
signature
authorization header
                            
                        

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

Имя параметра запроса

Описание

request_serial_number

Уникальный номер, назначенный сервером Payneteasy для конкретного запроса от торговца.

document_path

Ссылка для скачивания документа

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

{
  "request_serial_number": "00000000-0000-0000-0000-000001fd4472",
  "document_path": "https://sandbox.sbctech.ru/paynet/api/v2/download/card-ins-95255434629222889419"
}

Note

Полученную в ответе ссылку необходимо отобразить в браузере Клиента.

Warning

Файл доступен только для одной загрузки.

Отладка платежной формы

Страхование при оплате без использования формы

Также возможен сценарий когда управления процессом списания страховой суммы Торговцем. В этом случае отображение информации на платёжной форме через рекуррентный запрос с использованием card-ref-id карты.

Отладка рекуррентного запроса

Страхование при переводе средств

Для осуществления операции страхования при переводе средств на предоставленном терминале необходима активация соответствующей операции.

Warning

В запросе обязательно указание параметра insurance_amount.

Warning

Cтраховой полис при этом не формируется и не показывается: при получении запроса на перевод средств операция сразу начинает обработку.

Request Builder

Введите ваш приватный ключ в контейнере PKCS#1 для использования отладки. Подробнее см. RSA-SHA256.


Warning

Используйте либо destination-card-no, destination-card-ref-id либо комбинацию destination-iban-no и destination-bic.
URL

Вместо ENDPOINTID используйте ID нужного Endpoint в системе

login

your login should be used as Consumer Public for OAuth

client_orderid

make it or use your internal invoice ID

destination-card-no enter the beginning of the sequence, and then "i".

destination-card-ref-id
destination-iban-no
destination-bic
order_desc
amount
insurance_amount
currency
ipaddress
first_name
middle_name
last_name
ssn
birthday
address1
city
state
zip_code
country
phone
cell_phone
email
purpose
receiver_first_name
receiver_middle_name
receiver_last_name
receiver_phone
receiver_resident
receiver_identity_document_series
receiver_identity_document_number
receiver_identity_document_id
receiver_address1
receiver_city
redirect_url
redirect_success_url
redirect_fail_url
server_callback_url
merchant_data

Normalized parameters string to sign, according to OAuth 1.0a rules
POST body parameters to submit
OAuth 1.0a headers to submit.
HEX Encoded Signature
* HEX encoded string is for debug purposes only. You shouldn't send this string to the server neither in HEX nor in Encoded HEX representation.
Base64 Encoded Signature
* Binary RSA-SHA256 signature directly encoded in base64 should be sent to the server.

Запрос статуса

Торговцу необходимо использовать запрос статуса по API для получения актуальной информации о статусе транзакции. Запрос статуса осуществляется по параметру order_id, возвращаемого Payneteasy для каждой созданной транзакции.
Запрос инициируется на указанный ниже URL. Для подписания запроса используется OAuth HMAC-SHA1 авторизация.

API URLs

Integration

Production

https://sandbox.payneteasy.com/paynet/api/v2/status/ENDPOINTID

https://gate.payneteasy.com/paynet/api/v2/status/ENDPOINTID

https://sandbox.payneteasy.com/paynet/api/v2/status/group/ENDPOINTGROUPID

https://gate.payneteasy.com/paynet/api/v2/status/group/ENDPOINTGROUPID

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

Параметр

Описание

Обязательность

login

Логин торговца в системе Payneteasy.

Необходимость: Обязательно
Тип:
Длинна:

client_orderid

Номер заказа в системе торговца, по которому запрашивается статус.

Необходимость: Обязательно
Тип:
Длинна:

orderid

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

Необходимость: Обязательно
Тип:
Длинна:

by-request-sn

Серийный номер API запроса в системе Payneteasy.

Необходимость: Опционально
Тип:
Длинна:

control

Контрольная сумма, подтверждающая отправление запроса торговцем. Представляет собой SHA-1 свёртку от конкатенации следующих параметров: login + client-order-id + paynet-order-id + merchant-control.

Необходимость: Обязательно
Тип:
Длинна:

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

Параметр

Описание

type

Тип ответа, ожидаемое значение: status-response.

status

Статус заказа. Возможные значения: Status List.

amount

Сумма заказа. Это значение может быть изменено во время транзакции.

paynet-order-id

Номер заказа, присвоенный системой QA.

merchant-order-id

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

phone

Телефон покупателя.

html

HTML код страницы 3-D Secure, закодированный в формат MIME application/x-www-form-urlencoded. Торговцу необходимо декодировать этот параметр перед показом формы покупателю. Система QA HTML код страницы 3-D Secure, закодированный в формат MIME application/x-www-form-urlencoded. Торговцу необходимо декодировать этот параметр перед показом формы покупателю. Система Payneteasy возвращает этот параметр в ответе, когда получает форму 3-D Secure. Параметр содержит HTML код страницы, который должен быть передан в интернет-браузер Клиента без изменений. Для non-3DS транзакций данный параметр не присутствует в ответе. Также этот параметр не присутствует в ответе при запросе статуса транзакции по форме (sale form, transfer form).

redirect-to

Параметр может использоваться вместо параметра html Содержит URL для переадресации Клиента на форму 3-D Secure. Торговец должен использовать метод GET для переадресации Клиента. Для non-3DS транзакций данный параметр не присутствует в ответе. Также этот параметр не присутствует в ответе при запросе статуса транзакции по форме (sale form, transfer form).

serial-number

Уникальный номер конкретного API запроса торговца, присвоенный системой Payneteasy.

last-four-digits

Последние четыре цифры номера карты покупателя.

bin

Банковский идентификационный номер (БИН) карты покупателя.

card-type

Тип карты покупателя (например VISA, MASTERCARD, MIR).

gate-partial-reversal

Поддерживаются ли частичные возвраты на шлюзе (enabled or disabled).

gate-partial-capture

Поддерживаются ли частичные capture на шлюзе (enabled или disabled).

transaction-type

Тип транзакции (sale, reversal, capture, preauth).

processor-rrn

Регистрационный номер транзакции в системе банка-эквайера (RRN).

processor-tx-id

Идентификатор транзакции в системе банка-эквайера.

receipt-id

Ссылка на электронный чек https://gate.payneteasy.com/paynet/view-receipt/ENDPOINTID/receipt-id/.

name

Имя.

cardholder-name

Имя держателя карты.

card-exp-month

Последний месяц действия карты.

card-exp-year

Последний год действия карты.

card-hash-id

Уникальный идентификатор карты используется для программы лояльности или проверок на fraud.

card-country-alpha-three-code

Трехбуквенный код страны эмитента карты отправителя. Смотри Country Codes для большей информации.

email

E-mail покупателя.

purpose

Назначение, куда направляется оплата.

bank-name

Название банка-эмитента.

terminal-id

Идентификатор терминала банка-эквайера.

paynet-processing-date

Дата процессинга транзакции в системе банка-эквайера.

approval-code

Код подтверждения банка-эквайера.

order-stage

Стадия процессинга транзакции. Смотри Order Stage для большей информации.

loyalty-balance

Текущий бонусный баланс программы лояльности для данной операции. if available.

loyalty-message

Сообщение от программы лояльности. if available.

loyalty-bonus

Бонусное значение программы лояльности для данной операции. if available.

loyalty-program

Название программы лояльности для данной операции. if available.

descriptor

Идентификатор банка.

error-message

Если статус заказа declined, error или filtered этот параметр содержит причину отказа.

error-code

Код ошибки для заказов в статусе declined, error, filtered.

by-request-sn

Серийный номер запроса, если он содержится в параметрах запроса.

verified-3d-status

Статус результата 3-D Secure. Смотри 3D Secure Status List для большей информации.

verified-rsc-status

Смотри Random Sum Check Status List для большей информации.

merchantdata

Если представлен в инициализирующем запросе, merchant_data параметр и его значение будут включены в ответе на запрос статуса.

initial-amount

Сумма, назначенная в инициализирующей транзакции, без каких-либо комиссий. Это значение может не быть изменено во время транзакции.

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

type=status-response
&serial-number=00000000-0000-0000-0000-0000005b5044
&merchant-order-id=902B4FF5
&processor-tx-id=PNTEST-159884
&paynet-order-id=159884
&status=approved
&amount=10.42
&descriptor=test-usd
&gate-partial-reversal=enabled
&gate-partial-capture=enabled
&transaction-type=sale
&receipt-id=a5061379-6ff5-3565-a9ba-1b8a814d04f6
&name=TEST HOLDER
&cardholder-name=TEST HOLDER
&card-exp-month=1
&card-exp-year=2016
&email=john.smith@gmail.com
&processor-rrn=510321889824
&approval-code=242805
&order-stage=sale_approved
&last-four-digits=9001
&bin=520306
&card-type=MASTERCARD
&phone=12063582043
&bank-name=CITIBANK
&paynet-processing-date=2015-04-09 17:14:26 MSK
&by-request-sn=00000000-0000-0000-0000-0000005b2a8a
&card-hash-id=1493114
&verified-3d-status=AUTHENTICATED
&verified-rsc-status=AUTHENTICATED
&merchantdata=promo

Пример формирования подписи запроса

Контрольная сумма, сгенерированная SHA-1. Строка для подписи представляет собой объединение следующих параметров:
  1. <ENDPOINTID | ENDPOINTGROUPID> (см: Request URL)

  2. Параметр запроса: client_orderid

  3. Параметр запроса: amount в минимальных денежных единицах

  4. Параметр запроса: email

  5. merchant_control (Контрольный ключ, назначенный для учетной записи Присоединяющейся Cтороны в Payneteasy).

  • login

  • client_orderid

  • orderid

  • merchant_control (Контрольный ключ, назначенный для учетной записи Присоединяющейся Cтороны в Payneteasy)

Пример расчёта контрольной суммы:

Parameter Name

Parameter Value

login

cool_merchant

client_orderid

5624444333322221111110

orderid

9625

merchant_control

r45a019070772d1c4c2b503bbdc0fa22

Строка для формирования контрольной суммы будет выглядеть следующим образом:

cool_merchant56244443333222211111109625r45a019070772d1c4c2b503bbdc0fa22

Шифрование вышеприведённой строки с помощью алгоритма SHA-1 . приводит к следующему значению контрольной суммы:

c52cfb609f20a3677eb280cc4709278ea8f7024c

Request Builder

endpointid or groupid

input ENDPOINTID or ENDPOINTGROUPID

login

input Login

client_orderid

input Invoice Number

orderid
merchant_control

input Control Key

by-request-sn

String to sign
Signature