Создание платежа. Метод Register.
Параметры инициализации платежа.
| Название | Тип | Обязательность | Значение | Пример |
|---|---|---|---|---|
| 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 | DateTime | Нет | Дата и время. Дата и время не должны отличаться более чем на 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|by|en|pl |
| 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 | DateTime | Да | Дата и время. | 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"}