Developers

API and connection documentation

Инициализация платежа

Для создания платежной транзакции (инициализации платежа) магазин должен выполнить два действия:
1. передать данные о платеже PayBoxу
2. передать покупателя в управление PayBoxу

Это возможно сделать двумя способами:
1. передать информацию о платеже через браузер пользователя, при этом одновременно пользователь переходит на сайт PayBoxа.
2. передать информацию о платеже напрямую в PayBox, в ответ получить идентификатор платежной транзакции и URL для последующего перенаправления покупателя, а затем перенаправить покупателя на этот URL.

В обоих случаях состав передаваемых данных совершенно идентичен, различаются лишь способ передачи и формат ответа.

Name of the
merchant Name of the merchant, will be displayed at paybox.money pages while guiding the customer through the payment process pg_merchant_id                          Идентификатор продавца в PayBox. Выдается при подключении. pg_order_id                                               Идентификатор платежа в системе продавца. Рекомендуется поддерживать уникальность этого поля. pg_amount Сумма платежа в валюте pg_currency pg_currency KZT Валюта, в которой указана сумма. KZT, USD, EUR. В случае выбора покупателем способа платежа в другой валюте, производится пересчет по курсу ЦБ на день платежа. pg_check_url Из настроек магазина Check URL (string[256]) URL для проверки возможности платежа. Вызывается перед платежом, если платежная система предоставляет такую возможность. Если параметр не указан, то берется из настроек магазина. Если параметр установлен равным пустой строке, то проверка возможности платежа не производится. pg_result_url Из настроек магазина Result URL (string[256]) URL для сообщения о результате платежа. Вызывается после платежа в случае успеха или неудачи. Если параметр не указан, то берется из настроек магазина. Если параметр установлен равным пустой строке, то PayBox не сообщает магазину о результате платежа. pg_refund_url Из настроек магазина Refund URL (string[256]) URL для сообщения об отмене платежа. Вызывается после платежа в случае отмены платежа на стороне PayBoxа или ПС. Если параметр не указан, то берется из настроек магазина. pg_capture_url Из настроек магазина Capture URL (string[256]) URL для сообщения о проведении клиринга платежа по банковской карте. Если параметр не указан, то берется из настроек магазина. pg_request_method Из настроек магазина Request Method (string[4]) GET, POST или XML – метод вызова скриптов магазина Check URL, Result URL, Refund URL, Capture URL для передачи информации от платежного гейта. pg_success_url Из настроек магазина Success URL (string[256]) url, на который отправляется пользователь в случае успешного платежа (только для online систем) pg_failure_url Из настроек магазина Failure URL (string[256]) URL для сообщения об отмене платежа. Вызывается после платежа в случае отмены платежа на стороне PayBoxа или ПС. Если параметр не указан, то берется из настроек магазина. pg_success_url_method Из настроек магазина Success URL Method GET – кнопка, которая сабмитится методом GET. POST – кнопка, которая сабмитится методом POST. AUTOGET – 302 редирект. См. Автоматическая передача информации, п.1. AUTOPOST – форма, которая автоматически сабмитится. См. Автоматическая передача информации, п.2. Если выбран метод GET или POST, то страница с подтверждением оплаты показывается пользователю на сайте paybox.money, и предлагается нажать кнопку, чтобы вернуться на сайт магазина. Если выбран метод AUTOGET или AUTOPOST, то страница с подтверждением оплаты не показывается пользователю, и пользователь сразу передается магазину. pg_failure_url_method Из настроек магазина Failure URL Method GET – кнопка, которая сабмитится методом GET. POST – кнопка, которая сабмитится методом POST. AUTOGET – 302 редирект. См. Автоматическая передача информации, п.1. AUTOPOST – форма, которая автоматически сабмитится. См. Автоматическая передача информации, п.2. Если выбран метод GET или POST, то страница с сообщением о неудавшейся оплате показывается пользователю на сайте paybox.money, и предлагается нажать кнопку, чтобы вернуться на сайт магазина. Если выбран метод AUTOGET или AUTOPOST, то страница с сообщением о неудавшейся оплате не показывается пользователю, и пользователь сразу передается магазину. pg_state_url Из настроек магазина State URL (string[256]) URL скрипта на сайте магазина, куда перенаправляется покупатель для ожидания ответа от платежной системы. pg_state_url_method Из настроек магазина State URL Method GET – кнопка, которая сабмитится методом GET. POST – кнопка, которая сабмитится методом POST. AUTOGET – 302 редирект. См. Автоматическая передача информации, п.1. AUTOPOST – форма, которая автоматически сабмитится. См. Автоматическая передача информации, п.2. Если выбран метод GET или POST, то страница с сообщением о неудавшейся оплате показывается пользователю на сайте paybox.money, и предлагается нажать кнопку, чтобы вернуться на сайт магазина. Если выбран метод AUTOGET или AUTOPOST, то страница с сообщением о неудавшейся оплате не показывается пользователю, и пользователь сразу передается магазину. pg_site_url Из настроек магазина Site URL URL сайта магазина для показа покупателю ссылки, по которой он может вернуться на сайт магазина после создания счета. Применяется для offline ПС (наличные). pg_payment_system Идентификатор выбранной ПС или группы ПС. Примеры: WEBMONEY, YANDEXMONEY, EUROSET, CYBERPLATCASH, CASH. Полный список возможных значений см. в разделе Справочник платежных систем и групп. Этот параметр передается только если выбор платежной системы совершается на сайте продавца. Если параметр не указан, то выбор ПС совершается на сайте paybox.money pg_lifetime сутки URL сайта магазина для показа покупателю ссылки, по которой он может вернуться на сайт магазина после создания счета. Применяется для offline ПС (наличные). pg_encoding UTF-8 Кодировка, в которой указаны другие поля запроса (только в случае использования методов GET или POST) pg_user_phone2 (int[16]) телефон пользователя (для России начиная с цифр 79..), необходим для идентификации покупателя. Если не указан, выбор будет предложен пользователю на сайте платежного гейта. pg_user_contact_email2 (string[100]) Контактный адрес электронной почты пользователя. Если указан, на этот адрес будут высылаться уведомления об изменении статуса транзакции. pg_user_email2 (string[120]) адрес электронной почты пользователя, в платежной системе Деньги@Mail.ru. Необходим, если выбрана эта платежная система. Если не указан, выбор будет предложен пользователю на сайте платежного гейта. pg_user_ip2 IP-адрес клиента. Необходим для разбора спорных ситуаций в случае подозрения на мошенничество. Параметр можно не передавать при передаче информации через браузер пользователя, в этом случае будет записан тот IP, с которого пользователь перешёл на страницу инициализации платежа. pg_postpone_payment Создание платежа с отложенной оплатой (https://paybox.money/info/postponed_payment), если в этом параметре передано «1». В таком случае покупатель будет перенаправлен на страницу с информацией о том, что ему было выслано письмо со ссылкой на страницу для продолжения проведения платежа. Если этот параметр присутствует в запросе, то должен быть указан также pg_user_contact_email, иначе пользователь будет перенаправлен на уточнение платежных параметров, где он сможет, указать email и попробовать отложить платеж ещё раз. pg_user_ip2 IP-адрес клиента. Необходим для разбора спорных ситуаций в случае подозрения на мошенничество. Параметр можно не передавать при передаче информации через браузер пользователя, в этом случае будет записан тот IP, с которого пользователь перешёл на страницу инициализации платежа. pg_language ru Язык платежных страниц на сайте PayBoxа и (если возможно) платежных систем. Значение ru устанавливает русский язык, en – английский. pg_testing_mode Из настроек магазина Флаг, принимает значение 0 или 1. Подробное описание см. в разделе Тестирование. pg_recurring_start 0 Флаг, принимает значение 0 или 1. pg_recurring_lifetime Время на продолжении которого продавец рассчитывает использовать профиль рекуррентных платежей. Минимально допустимое значение 1 (1 месяц). Максимально допустимое значение: 156 (13 лет). В случае выхода за пограничные значения будет безакцептно присвоено минимальное или максимальное значение, соответственно. Дополнительные параметры продавца Можно передавать произвольные дополнительные параметры, имена которых не начинаются на pg_. Все эти параметры будут переданы на pg_check_url, pg_result_url, pg_success_url, pg_failure_url. Имена дополнительных параметров продавца должны быть уникальны. pg_salt Случайная строка pg_sig Подпись

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


ячейка 1, первый ряд ячейка 2, первый ряд

Need a consultation?

Send an enquiry and our managers will contact you in 15 minutes.