Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Предприятие вызывает веб-сервис создания счета (с указанием номера счета, суммы, допустимого срока оплаты и т. д.), АПК Ассист формирует счет на оплату и платежный токен, соответствующий данному счету. Создание счета также возможно вручную из личного кабинета (https://account.paysecure.ru/).  Ссылка Ссылка с платежным токеном отправляется системой АПК Ассист покупателю по электронной почте или предприятие формирует URL с использованием полученного платежного токена и переадресовывает покупателя на страницу оплаты счета. Также предприятие самостоятельная самостоятельно может отправить ссылку покупателю с помощью E-mail, SMS или других средств связи. Ссылка на оплату счета имеет следующий вид: https://<SERVER_NAME>/bill/paybill.cfm?ID=c2RmZ2UzNXkyNXR5MjU0

...

Веб-сервис для создания счета принимает параметры счета (форматы в формате HTTP POST/SOAP ) и либо JSON (swagger описание: https://docs.assist.ru/swagger/) и возвращает (в случае успешного создания счета) платежный токен/ID, соответствующий данному счету. На основе этого платежного токена предприятие может сформировать ссылку на своей стороне для переадресации покупателя на страницу оплаты счета или для самостоятельной отправки ее покупателю (E-mail, SMS или другие средства связи), или АПК Ассист может отправить ее по E-mail адресу покупателя, указанному в параметрах.

...

Идентификационный номер клиента магазина (для организации платежей в режиме OneClick).

Название

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

Принимаемые значения

Значение по умолчанию

Описание

Merchant_ID

Да

Число


Идентификатор предприятия в АПК Ассист

Login

Да

8 - 20 символов 


Логин (лат. буквы и цифры, символ _)

Password

Да

8 - 20 символов


Пароль (лат. буквы и цифры)

Bill

Да/Нет1

128 символов


Номер счета (при создании заказа будет использован в качестве OrderNumber)

Bill_amount

Да

Число, 15 цифр (разделитель «. знаков, два знака после разделителя (допустимые разделители «.», «,»)


Сумма счета (OrderAmount в заказе)

Bill_currency

Да

3 символа


Валюта счета (OrderCurrency)

Bill_comment

Нет

256 символов


Комментарий (OrderComment в заказе)

Customer_Name

Нет

70 символов


Имя плательщика (FirstName в заказе)

Customer_Lastname

Нет

70 символов


Фамилия плательщика (LastName в заказе)

Customer_Middlename

Нет

70 символов


Отчество плательщика (MiddleName в заказе)

Customer_Email

Да/Нет2

128 символов


E-mail плательщика (Email в заказе)

Customer_Phone

Нет

20 символов


Телефон плательщика (HomePhone в заказе)

Customer_Mobile

Нет

20 символов


Мобильный телефон плательщика (MobilePhone в заказе)

Language

Нет

RU

EN

Настройка базового языка аккаунта мерчанта

Язык платежных страниц

Pay_until

Нет

Дата/время

1 сутки

Крайний срок оплаты счета (дата и время в GMT): YYYYMMDDThhmm, если не передано - вычисляется на основе настройки мерчанта

DelayPayment

Нет

Число

0

Флаг двустадийного платежа (параметр delay в заказе): 0- одностадийный, 1 - двустадийный режим оплаты.

SendNotification

Нет

Число

В зависимости от настроек мерчанта

Признак отправки счета: 0 - не отправлять, 1 – отправлять ссылку по Email, 2 – отправлять ссылку в SMS, 3 – отправлять ссылку и по Emai, и в SMS.

Checkvalue

Да

Строка

Контрольная сумма3

CustomerNumberURL_RETURNНет

Строка

255 символов
URL страницы, на которую должен вернуться покупатель после осуществления платежа в системе (должна быть активирована опция «Перейти на страницу магазина» в настройках мерчанта в Личном кабинете). В целях безопасности рекомендуется использовать протокол с шифрованием HTTPS.
URL_RETURN_OKНет255 символов

Значение параметра URL_RETURN,

а при его отсутствии – URL для возврата при успешной авторизации, указанный в Личном кабинете
URL страницы, куда должен вернуться покупатель после успешного осуществления платежа в системе АПК Ассист (должна быть активирована опция «Перейти на страницу магазина» в настройках мерчанта в Личном кабинете). В целях безопасности рекомендуется использовать протокол с шифрованием HTTPS.
URL_RETURN_NOНет255 символов

Значение параметра URL_RETURN,

а при его отсутствии – URL для возврата, указанный в Личном кабинете
URL страницы, куда должен вернуться покупатель после неуспешного осуществления платежа в системе АПК Ассист или при отсутствии ответа об окончательном статусе платежа (текущий статус "В процессе"), подробнее см. "Возврат покупателя на страницу интернет-магазина после покупки". Должна быть активирована опция «Возвращаться в магазин по URL для возврата» в Личном кабинете. В целях безопасности рекомендуется использовать протокол с шифрованием HTTPS.

CardPayment

Нет

1 – использовать оплату по банковской карте,
0 – не использовать

1

Покупатель сможет сделать платеж с помощью банковской карты, если передано значение параметра 1 или параметр отсутствует (и оплата по банковским картам доступна для предприятия).

YMPayment

Нет

1 – использовать платежную систему YandexMoney,
0 – не использовать

1

Покупатель сможет сделать платеж с помощью платежной системы YandexMoney, если передано значение параметра 1 или параметр отсутствует (и оплата по YandexMoney доступна для предприятия).

SberPayPayment

Нет

1 – использовать платежную систему SberPay, 
0 – не использовать

1

Покупатель сможет сделать платеж с помощью всех средств оплаты платежной системы SberPay, если передано значение параметра 1 или параметр отсутствует (и оплата по SberPay доступна для предприятия)

FastPayPayment

Нет

1; 0

1

Покупатель сможет сделать платеж с помощью Системы Быстрых Платежей, если передано значение параметра 1 и оплата по СБП доступна для предприятия.

GooglePayPayment

Нет

1; 0

1

Признак оплаты через Google Pay (=1)

ApplePayPayment

Нет

1; 0

1

Признак оплаты через Apple Pay (=1)

SamsungPayPayment

Нет

1; 0

1

Признак оплаты через Samsung Pay (=1)

MirPayPayment

Нет

1; 0

1

Признак оплаты через Mir Pay (=1)

Checkvalue

Да/Нет

Строка


Контрольная сумма3

CustomerNumber

Нет

Строка


Идентификационный номер клиента магазина (для организации платежей в режиме OneClick).

Anchor
1
1


1 Номер счета может не передаваться, если включена автоматическая генерация номера счета.

Anchor
2
2


2 Если не передано значение адреса E-mail, то отправка счета по E-mail невозможна. Если не передан номер телефона, то отправка SMS невозможна. Примечание. Если признак отправки равен 3, то при отсутствии номера телефона ссылка на счет будет отправлена только по E-mail, а при отсутствии адреса E-mail нотификация вообще не будет выполнена.

Anchor
3
3


3 Контрольная сумма формируется на основе формулы:

uppercase(md5(uppercase(md5(SALT) + md5(Х)))), где SALT – секретное слово; Х – результат строковой склейки всех переданных параметров счета (в последовательности по порядку следования параметров в таблице сверху вниз, не включая DelayPayment, SendNotification,  Checkvalue и CustomerNumber) через разделитель - точка с запятой (";"), ' + ' – строковая склейка."

По умолчанию параметр не является обязательным. Если в целях безопасности предприятию необходимо использовать контрольную сумму, то для выполнения соответствующих настроек следует обратиться в службу технической поддержки АПК Ассист.

Note

Для фискализации последующей операции оплаты счета в запросе на его создание заранее могут передаваться дополнительные параметры для формирования корректного чека. Описание дополнительных параметров приведено в разделе "Режимы передачи данных чека".

...

Если не удается создать уникальный платежный токен/ID, то счет не создается и выдается сообщение об ошибке "Не удалось сформировать уникальный платежный токен".

Информация об использовании протокола 3-D Secure 2.0при создании платежа.

Пример запроса HTTP POST для создания счета:

...

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Header/>
    <Body>
        <WSCreateBill><CreateBill>
            <Bill>
                <merchant_id>423422</merchant_id>
                <login>login</login>
                <password>password</password>
                <bill>123456</bill>
                <bill_amount>23.23</bill_amount>
                <bill_currency>RUB</bill_currency>
                <bill_comment></bill_comment>
                <customer_name>Test</customer_name>
                <customer_lastname>Testov</customer_lastname>
                <customer_middlename>Testovich</customer_middlename>
                <customer_email>test@testpost.ru</customer_email>
                <customer_phone></customer_phone>
                <language>RU</language>
                <pay_until>20150611T1212</pay_until>
                <sendnotification>0</sendnotification>
                <checkvalue> AA3BC3F48B7FE23988044B53AA98F169</checkvalue>
            </Bill>
        </WSCreateBill>CreateBill>
    </Body>
</Envelope>

Пример результата запроса создания счета:

...

Название

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

Принимаемые значения

Значение по умолчанию

Описание

Merchant_ID

Да

Число


Идентификатор предприятия в АПК Ассист

Login

Да

8 - 20 символов 


Логин (лат. буквы и цифры, символ _)

Password

Да

8 - 20 символов


Пароль (лат. буквы и цифры)

Bill

Да/Нет*

128 символов


Номер счета (при создании заказа будет использован в качестве OrderNumber)

BillNumber

Да/Нет*

15 или 16 цифр


Номер платежа - уникальный номер заказа в системе АПК Ассист

*Обязательно должен быть передан один из параметров - Bill или BillNumber. Если в одном запросе переданы оба параметра, то поиск будет осуществляться по BillNumber.


Пример запроса HTTP POST для получения статуса счета:

Code Block
languagexml
<FORM ACTION="https://<SERVER-NAME>/bill/createbillbillstatus.cfm" method="POST">
<INPUT TYPE="hidden" NAME="Merchant_ID" VALUE="Ваш Merchant_ID">
<INPUT TYPE="hidden" NAME="Login" VALUE="Ваш логин">
<INPUT TYPE="hidden" NAME="Password" VALUE="Ваш пароль">
<INPUT TYPE="hidden" NAME="Bill" VALUE="Номер счета">
<INPUT TYPE="hidden" NAME="BillNumber" VALUE="Номер платежа">
<INPUT TYPE="Submit"></FORM>

...

Название

Значение

Merchant_id

Идентификатор предприятия

Bill

Номер счета

Bill_amount

Сумма счета

Bill_currency

Валюта счета

Bill_comment

Комментарий к счету

Bill_date

Дата и время создания счета (GMT)

Bill_status

Статус счета

Billnumber

Номер платежа (пусто, если заказ не был создан) = Billnumberзаказа

Payment_date

Дата и время оплаты счета (пусто, если заказ не был создан) = OrderDate (GMT)

Payment_amount

Сумма платежа (пусто, если заказ не был создан) = сумма операции оплаты amount

Payment_currency

Валюта платежа (пусто, если заказ не был создан) = валюта операции оплаты currency

Payment_RRN

Дополнительный идентификатор платежа/RRN (пусто если не было оплаты)

Refund_amount

Сумма успешных возвратов по платежу (пусто, если заказ не был создан; 0, если оплата была, но не было возвратов)

Customer_name

Имя плательщика

Customer_Lastname

Фамилия плательщика

Customer_Middlename

Отчество плательщика

Customer_Email

Email плательщика

Customer_Phone

Телефон плательщика

Customer_Mobile

Мобильный телефон плательщика

Language

Язык

Pay_until

Срок оплаты счета (GMT)

Sendnotification

Флаг отправки счета (0 - не отправлять, 1 - отправлять, 10 – отправлен)*

Bill_typeТип счета (1 - по умолчанию)

CheckValue

Контрольная сумма формируется на основе формулы:
uppercase(md5(uppercase(md5(SALT) + md5(Х)))), где SALT – секретное слово; Х – результат строковой склейки всех переданных параметров ответа (в последовательности по порядку следования параметров в таблице сверху вниз, не включая SendNotification и Checkvalue) через разделитель - точка с запятой(";"), разделитель добавляется и в случае отсутствующего параметра, '+' – строковая склейка."

...

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Header/>
    <Body>
        <WSBillStatus><BillStatus>
            <Bill>
                <merchant_id>423422</merchant_id>
                <login>login</login>
                <password>password</password>
                <bill>123456</bill>
                <billnumber></billnumber>
            </Bill>
        </WSBillStatus>BillStatus>
    </Body>
</Envelope>

Пример результата запроса статуса счета:

...

Code Block
languagexml
<FORM ACTION="https://test.paysecure.ru/bill/createbillbillrevoke.cfm" method="POST">
<INPUT TYPE="hidden" NAME="Merchant_ID" VALUE="Ваш Merchant_ID">
<INPUT TYPE="hidden" NAME="Login" VALUE="Ваш логин">
<INPUT TYPE="hidden" NAME="Password" VALUE="Ваш пароль">
<INPUT TYPE="hidden" NAME="Bill" VALUE="Номер счета">
<INPUT TYPE="hidden" NAME="SendNotification" VALUE="Флаг отправки счета">
<INPUT TYPE="hidden" NAME="Checkvalue" VALUE="Контрольная сумма">
<INPUT TYPE="Submit"></FORM>

...

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Header/>
    <Body>
        <WSBillRevoke><BillRevoke>
            <Bill>
                <merchant_id>423422</merchant_id>
                <login>login</login>
                <password>password</password>
                <bill>123456</bill>
                <sendnotification>0</sendnotification>
                <checkvalue> AA3BC3F48B7FE23988044B53AA98F169</checkvalue>
            </Bill>
        </WSBillRevoke>BillRevoke>
    </Body>
</Envelope>

Пример результата запроса аннулирования счета:

...