Создание платежа
Last updated
Last updated
Пример запроса (GET):
Обязательные параметры:
Если вы используете онлайн кассу, в ссылку на оплату необходимо передавать обязательные параметры. Подробнее в этой статье.
Дополнительные параметры оплаты:
По мере выполнения платежа мы уведомляем платформу магазина о статусе оплаты, последовательно отправляя GET запросы на URL обработчика.
Запрос можно выполнить в тестовом режиме. Узнать подробнее
В ответе на запрос ссылка будет создана с параметрами hideMenu, hideOtherMethods. Поскольку запрос формируется на конкретный метод оплаты (paymentType) и не подразумевает переключения на другие методы из сформированной ссылки.
Если ваш сайт создан с помощью CMS, ознакомьтесь со списком готовых модулей. Для взаимодействия с API вы можете использовать библиотеку Unitpay PHP-SDK.
Значение
Описание
paymentType
строка
Код платежной системы, через которую будет идти оплата
account
строка
Идентификатор абонента в системе партнера (например, логин или email абонента)
desc
строка
Описание заказа
sum
число
Сумма платежа в рублях (например, 10.00)
projectId
число
ID вашего проекта в системе UnitPay
secretKey
строка
Секретный ключ, доступен в настройках проекта
Значение
Описание
currency
строка
Валюта заказа по стандарту ISO 4217 (RUB, UAH, BYN, EUR, USD итд. Полный список валют). Если платежная система не поддерживает требуемую валюту, то сумма будет сконвертирована в валюту системы оплаты
locale
строка
Принудительное указание языка платежной формы, допустимые значения: ru, en. По умолчанию язык формы определяется исходя из страны, к которой относится IP адрес пользователя
ip
строка
IP адрес плательщика
resultUrl
строка
Полный URL адрес перехода пользователя после оплаты (например, http://вашсайт.ru) Важно: домен не должен отличаться от домена проекта. Если параметр не задан, то будет использован адрес страницы чека платежа.
backUrl
строка
Адрес возврата пользователя с платежной формы без совершения покупки, по умолчанию используется адрес проекта. В адресе обязательно должен использоваться домен проекта. Примеры: "https://redirect.<домен проекта>/?someParams", "https://<домен проекта>/redirect/"
subscription
true/false
Используйте данный флаг, если требуется создать подписку по карте плательщика. Идентификатор подписки (subscriptionId) будет передан в методе PAY на ваш обработчик платежа. Использование подписок возможно только после согласования с вашим курирующим менеджером
subscriptionId
число
Идентификатор подписки, по которой требуется произвести списание средств. Данный параметр должен быть предварительно получен в методе PAY на ваш обработчик платежа
preauth
true/false
Используйте этот флаг для создания платежа с преавторизацией, по умолчанию флаг выключен и значение равно 0
preauthExpireLogic
число
Поле для логики блокировки платежей с преавторизацией 0 - При отсутствии запроса на подтверждение или отмену, платеж по истечении срока блокировки на стороне банка-эквайера (~114 часов после создания платежа) будет подтвержден 1 - При отсутствии запроса на подтверждение или отмену, платеж по истечении срока блокировки на стороне банка-эквайера (~114 часов после создания платежа) будет отменен. Если параметр не будет использован, платеж будет отменен по истечении срока.
Значение
Описание
message
string
Информация о результате формирования платежа
paymentId
bigint
Номер платежа в системе UnitPay
receiptUrl
string
Ссылка на чек Примечание: возвращается, если подключена касса Юнит.Чеки, Атол или e-comm.
type
string
Тип ответа:
redirect — необходимо перенаправить пользователя на адрес, указанные в redirectUrl
response - необходимо показать пользователю информацию, указанную в response invoice — счет создан автоматически и направлен плательщику. Дополнительных действий не требуется
redirectUrl
string
URL для переадресации пользователя на шлюз платежной платформы
response
string
html код формы, а если ApplePay, то json
html - необходимо отобразить на странице
json - необходимо направить пользователя по approveUrl
invoiceId
string
id счета
Значение
Описание
message
строка
Информация с описанием ошибки формирования платежа