Мы предоставляем возможность наиболее гибкого и полного метода интеграции систем для приема платежей. Вы можете скомпоновать платежную форму, исходя из своих пожеланий. В данном случае плательщик может вообще не видеть процессов взаимодействия с нашей системой.
Формат данных — "json", кодовая страница — "uft8".
Протокол обмена — "https", метод "POST".
Адрес API: https://api.artpay.by/v2/
При использовании тестового режима: https://api-sandbox-artpay.dev-3c.by/v2/
Название | Тип | Обязательность | Значение | Пример |
---|---|---|---|---|
ap_request | String(1..30) | Да | Константа Register | Register |
ap_storeid | String(1..30) | Да | Идентификатор точки обслуживания. | 43434 |
ap_operation | String(1..30) | Да | Тип операции. Константа Sale | Sale |
ap_order_num | Int64 | Да | Номер заказа. | 123 |
ap_client_dt | Int32 | Да | Дата и время: UNIX-время. Дата и время не должны отличаться более чем на 12 часов от даты и времени на сервере. |
1466602065 |
ap_amount | Double | Да | Сумма платежа | 12.10 |
ap_currency | String(3..3) | Да | Цифровой трехсимвольный код валюты либо его буквенное обозначение согласно ISO4271. | BYN|USD|EUR|RUB |
ap_invoice_desc | String (max 2500) | Да | Краткое описание приобретаемых товаров или оказываемых услуг. | Холодильник |
ap_proto_ver | String(5..10) | Да | Версия протокола. | 1.3.0 |
ap_lang | String(2..2) | Нет | Язык пользовательского интерфейса. Принимает значения (ISO 639-1). Если выбранный язык не поддерживается, то используется русский. | ru|en|pl|by |
ap_test | Boolean | Нет |
Уведомляет сервер об использовании тестового режима. В случае если значение параметра установлено в "1" или "true", возможно использование только тестового платежного шлюза.
При отсутствии в запросе, по умолчанию, параметр принимает значение "0" или "false" (реальный режим). |
1|0 |
up_... | String (1..1024) | Нет | Набор пользовательских параметров. Разрешается добавлять до 16 пользовательских параметров с любыми именами, начинающимися с префикса "up_" (например, "up_any_param"). Данные параметры не обрабатываются и не учитываются в платежной системе при оплате, но передаются предприятию (точке обслуживания) после успешного выполнения операции в уведомлении. Пользовательские параметры учитываются при расчете хеш-подписи. |
up_any_param=success |
ap_signature | String (32…512) | Да | Хеш-Подпись. | ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579 |
Название | Тип | Обязательность | Значение | Пример |
---|---|---|---|---|
ap_storeid | String(1..30) | Да | Идентификатор точки обслуживания. | 43434 |
ap_order_num | Int64 | Да | Номер заказа. Для ответа регистрации операции, в случае нулевого значения данного параметра система генерирует номер заказа для точки обслуживания, во всех других случаях значение номера заказа берется из запроса. | 123 |
ap_server_dt | Int32 | Да | Дата и время: UNIX-время. Дата и время не должны отличаться более чем на 12 часов от даты и времени на сервере. |
1466602065 |
ap_status | Enum | Да |
Статус выполнения операции.
Принимает значения:
|
Success|Warning|Error|Malfunction |
ap_result_code | Int32 | Нет |
Целочисленный код выполнения операции. Значения: «0» - выполнено успешно; «1..99» - выполнено с замечаниями; иначе – ошибка операции. |
0 |
ap_result_text | String | Нет | Описание результата выполнения операции. | Выполнено успешно |
ap_test | Boolean | Нет |
Уведомляет сервер об использовании тестового режима. В случае если значение параметра установлено в "1" или "true", возможно использование только тестового платежного шлюза.
При отсутствии в запросе, по умолчанию, параметр принимает значение "0" или "false" (реальный режим). |
1|0 |
ap_service_id | UID | Нет | Уникальный идентификатор операции. | 7a29-724a-f26e-9a78-4b4c-f7a7-9da5-7b72 |
ap_signature | String (32…512) | Да | Хеш-Подпись. | ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579 |
{"ap_request":"Register","ap_storeid":"1234","ap_order_num":"0","ap_operation":"Sale","ap_amount":"10","ap_currency":"933","ap_invoice_desc":"Test Order","ap_client_dt":"Mon, 11 Sep 2017 18:22:34 +0300","ap_lang":"ru","ap_test":"1","up_btn_name":"super!","ap_signature":"8583ea5313741aa02dd668c1b9a5cfcb3dd860510b53ac921af8d3a92093b435a4e08a22b10fdbe3b99c94b3372edabe44aaafc41db4a68928fc425edc59c5af"}
{"ap_storeid":"1234","ap_store_desc":"my test","ap_order_num":894361,"ap_status":"Success","ap_result_code":0,"ap_result_text":"Выполнено успешно","ap_service_id":"37cf-4275-9f4e-751a-0905-f2d0-05df-2b33","ap_server_dt":"2017-09-11T18:13:07+03:00","ap_test":1,"ap_signature":"fecbfe9cea4f150d601d38b7f991b4d1ff4a8c710328b64a9f46b7b34becd936a483bb90eaa7fa0d6967a5e0e80722ad297b5122337279071e9e992ff37f3e45"}
Название | Тип | Обязательность | Значение | Пример |
---|---|---|---|---|
ap_request | String(1..30) | Да | Константа EripAddInvoice | Register |
ap_storeid | String(1..30) | Да | Идентификатор точки обслуживания. | 43434 |
ap_client_dt | Int32 | Да | Дата и время: UNIX-время. Дата и время не должны отличаться более чем на 12 часов от даты и времени на сервере. |
1466602065 |
ap_proto_ver | String(5..10) | Да | Версия протокола. | 1.3.0 |
ap_lang | String(2..2) | Нет | Язык пользовательского интерфейса. Принимает значения (ISO 639-1). Если выбранный язык не поддерживается, то используется русский. | ru|en|pl|by |
ap_test | Boolean | Нет |
Уведомляет сервер об использовании тестового режима. В случае если значение параметра установлено в "1" или "true", возможно использование только тестового платежного шлюза.
При отсутствии в запросе, по умолчанию, параметр принимает значение "0" или "false" (реальный режим). |
1|0 |
ap_erip_service_no | Int32 | Нет | Номер услуги в системе ЕРИП. Является обязательным, если у продавца зарегистрировано более 1 услуги в ЕРИП. При отсутствии будет использован номер услуги, указанный в системе по умолчанию. | 123 |
ap_order_num | Int64 | Нет | Номер заказа. | 123 |
ap_amount | Double | Да | Сумма платежа. | 12.10 |
ap_currency | String(3..3) | Да | Цифровой трехсимвольный код валюты либо его буквенное обозначение согласно ISO4271. | BYN|USD|EUR|RUB |
ap_invoice_desc | String (max 2500) | Нет | Краткое описание приобретаемых товаров или оказываемых услуг. | Холодильник |
ap_invoice_expire | Int32 | Нет | Дата и время: UNIX-время. Срок действия счета. Счет нельзя будет оплатить позже указанной даты и времени. При отсутствии данного поля, счет актуален 3 суток. Срок действия счета не может быть меньше 1 часа и больше 1 месяца. |
1466602065 |
up_... | String (1..1024) | Нет | Набор пользовательских параметров. Разрешается добавлять до 16 пользовательских параметров с любыми именами, начинающимися с префикса "up_" (например, "up_any_param"). Данные параметры не обрабатываются и не учитываются в платежной системе при оплате, но передаются предприятию (точке обслуживания) после успешного выполнения операции в уведомлении. Пользовательские параметры учитываются при расчете хеш-подписи. |
up_any_param=success |
ap_signature | String (32…512) | Да | Хеш-Подпись. | ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579 |
Название | Тип | Обязательность | Значение | Пример |
---|---|---|---|---|
ap_storeid | String(1..30) | Да | Идентификатор точки обслуживания. | 43434 |
ap_server_dt | Int32 | Да | Дата и время: UNIX-время. Дата и время не должны отличаться более чем на 12 часов от даты и времени на сервере. |
1466602065 |
ap_status | Enum | Да |
Статус выполнения операции.
Принимает значения:
|
Success|Warning|Error|Malfunction |
ap_result_code | Int32 | Нет |
Целочисленный код выполнения операции. Значения: «0» - выполнено успешно; «1..99» - выполнено с замечаниями; иначе – ошибка операции. |
0 |
ap_result_text | String | Нет | Описание результата выполнения операции. | Выполнено успешно |
ap_test | Boolean | Нет |
Уведомляет сервер об использовании тестового режима. В случае если значение параметра установлено в "1" или "true", возможно использование только тестового платежного шлюза.
При отсутствии в запросе, по умолчанию, параметр принимает значение "0" или "false" (реальный режим). |
1|0 |
ap_service_id | UID | Нет | Уникальный идентификатор операции. | 7a29-724a-f26e-9a78-4b4c-f7a7-9da5-7b72 |
ap_erip_service_no | Int32 | Да | Номер услуги в ЕРИП. | 123 |
ap_erip_invoice_id | String | Да | Уникальный номер счета в разрезе «ap_erip_service_no» для оплаты в системе ЕРИП. Система "Artpay" генерирует номер счета методом последовательного инкремента в разрезе указанного "ap_erip_service_no". | 123 |
ap_signature | String (32…512) | Да | Хеш-Подпись. | ac9afb894a07a92fde3bc8638f475b1e3d6ca6f1780d1a711f11ba77f61236579 |
{"ap_request":"EripAddInvoice","ap_storeid":"120037","ap_order_num":"12","ap_client_dt":"Thu, 25 Jan 2018 13:20:41 +0300","ap_proto_ver":"1.3.0","ap_lang":"ru","ap_test":"1","ap_erip_service_no":"0","ap_amount":"10","ap_currency":"933","ap_invoice_desc":"Test Erip","ap_signature":"7bca35a812abcf11289c8881ef22cc6dea7d533ab535559cb653c9542d5649870c443ffc60551200d6f3e2ed4e8b500cf8325ba2ae47cd043d15eb9f06564a03"}
{"ap_storeid":"120037","ap_store_desc":"my test","ap_erip_service_no":"37011","ap_erip_invoice_id":"20506","ap_status":"Success","ap_result_code":0,"ap_result_text":"Выполнено успешно","ap_service_id":"0766-7bd7-ef69-7c26-6753-2fe3-b085-972f","ap_server_dt":"2018-01-25T13:46:28+03:00","ap_test":1,"ap_signature":"62e4e1e5df507dd1bfeae5a549707432b8365b5400180826a175352aa62a32266a044a74da06c4b57cab867a2c22391f537256377eb448add8f1a54737f718b8"}
Документация по другим методам API предоставляется по запросу.
Полная интеграция, упрощенная интеграция, без интеграции.
Информация для интеграторов.
Если ваш сайт уже написан на CMS, то велика вероятность, что Вам вообще не понадобится тратить время технических специалистов: у нас уже есть готовый модуль для вашей CMS.
Всего один шаг до начала работы с нами. Пожалуйста, заполните заявку.