Прод среда: https://api.interhub.ae
\nАгенты \"InterHub\"а могут производить 3 вида оплаты: Top Up, Voucher, PIN.
\nНа рисунке 1 выше представлена транзакция Top Up. Первым делом, агент отправляет check-запрос(или /check_dest). Если InterHub возвращает \"success\", агент отправляет pay-запрос. Если оплата проходит успешно, InterHub возвращает \"success\" и процесс завершается. На рисунке 1 представлен успешный исход событий. Однако, после каждой отправки запроса агентом, если InterHub возвращает \"error\", процесс завершается.
Когда агент отправляет pay-запрос, InterHub может вернуть 3 разных ответа: success, process, error. В случае, если InterHub вернул \"process\", рекомендуется отправлять запрос \"check_status\" каждые 5 минут, чтобы не загружать сервер.
\nНа рисунке 2 представлена транзакция Voucher. В этой транзакции агент, первым делом, отправляет в InterHub \"calculate-запрос\". Если этот запрос прошёл успешно, дальше всё работает как в транзакции Top Up, описанной выше.
\nНа рисунке 3 выше представлена транзакция PIN. Отличие данной транзакции от двух предыдущих заключается в том, что в транзакции PIN агент приходит в InterHub с конкретным запросом: куда именно, на какой аккаунт какую сумму отправить. Здесь используется параметр fixed_amount - фиксированная сумма.
\nПроверять возможность проведения платежа - check
Оплачивать услуги клиентам \"InterHub\"а - pay
Проверять текущий статус транзакции перевода - check_status
Позволяет агентам просматривать свой баланс - deposit
Даёт возможность получать информацию обо всех сервисах через Api - service_list
Авторизация происходит при помощи токена.
\nurl и token предоставляются менеджерами в процессе интеграции.
Есть два вида оплаты: фиксированная оплата (voucher) и точная сумма оплаты (top-up).
Если услуга, за которую должен быть произведён платеж, требует определенную сумму, агентам необходимо будет использовать метод calculate.
Типы сервисов определяются через API-интерфейс service_list.
Агенты должны отправлять check запрос на проверку возможности проведения платежа ({{url}}/api/payment/check ).
Если на check запрос получен успешный ответ, агент может подтвердить платеж с помощью pay API. ( {{url}}/api/payment/pay )
API check_status используется для получения финального статуса платежа. Этот API используется, когда в запросе на pay не указывается финальный статус платежа. ( {{url}}/api/payment/check_status )
При успешном финальном статусе платежа средства автоматически перечисляются на аккаунт пользователя с Вашего агентского счета.
\nAPI Протокол приема платежей основан на принципах REST-архитектуры.
\nAPI в качестве основного протокола использует HTTPS-запросы.
\nПараметры API помещаются в JSON-тело запроса. В POST и GET - запросах параметры помещаются в URL запроса.
\nAPI всегда возвращает ответ в формате JSON.
\nBrio group.
\n","_postman_id":"603c65fc-f6a8-412e-b819-7bd679b5feaa"},{"name":"Получение суммы","item":[{"name":"/api/agent/payment/check/calculate","id":"c1fbcf67-5b30-44ca-bfce-49a30eaf6fe5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"service_id\": 111,\n\t\"account\": \"example@gmail.com\",\n\t\"agent_transaction_id\":\"agent_98765431\",\n \"params\":{}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/agent/payment/check/calculate","description":"Этот метод используются только в том случае, если тип услуги Top-Up-Fixed, PIN или Voucher. Calculate - API служит для получения фиксированной суммы услуги а так же проверить, возможно ли проведение реального платежа.Calculate метод должен выполниться до использования метода check.
После получения фиксированной суммы агент должен использовать метод check.
Параметры запроса:
\nЕсли внутри сервиса, полученного из API список услуг, поля fields не
пустые, тогда эти поля внутри params необходимо отправить в паре key-value (ключ-значение). Если значение required=true, отправлять обязательно.
В паре key-value:
\nKey – название поля field,
\nValue – связан с типом поля field.type:
- если field.type=”LIST”, отправляется id одного
из элементов списка value_list,
- если field.type=”TEXT”, отправляется обычный текст.
Рассмотрим пример заполнения params.
\nЕсли сервис, взятый из API «Список услуг», выглядит следующим
образом (это всего лишь пример):
{\n \"id\": 9983,\n \"name\": \"Vodafone\",\n \"category_name\": \"Мобильные операторы\",\n \"type\": \"TOP_UP_FIXED\",\n \"min_amount\": 11350.00,\n \"max_amount\": 11350000.00,\n \"fields\": [\n {\n \"id\": 500,\n \"name\": \"nominal\",\n \"type\": \"LIST\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": [\n {\n \"id\": 3333,\n \"title\": \"TRY 80.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n },\n {\n \"id\": 4444,\n \"title\": \"TRY 100.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n }\n ]\n },\n {\n \"id\": 501,\n \"name\": \"sender_name\",\n \"type\": \"TEXT\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n },\n {\n \"id\": 502,\n \"name\": \"receiver_name\",\n \"type\": \"TEXT\",\n \"required\": false,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n }\n ]\n}\n\nТогда заполнение params будет
следующим:
\"params\": {\n \"nominal\": 3333,\n \"sender_name\" : \"Falonchi Falonchiyev 1\",\n \"receiver_name\" : \"Falonchi Falonchiyev 2\" – это не обязательно (not required)\n}\n\nЕсли запрос обработан корректно, то в ответе возвращаются сведения о возможности проведения платежа.Если возвращается число 0 в теге status, запрос был успешным.
Параметры ответа:
\nЕсли сервер не смог обработать запрос, API возвращает ответ с кодом произошедшей ошибки.
Параметры ответа:
Этот метод используется только в том случае, если тип услуги Top-Up-Fixed, PIN или Voucher.
Calculate - API служит для получения фиксированной суммы услуги, а также для того, чтобы проверить, возможно ли проведение реального платежа.Calculate метод должен быть выполнен до использования метода check.
После получения фиксированной суммы агент должен использовать метод check.
check - С помощью этого запроса вам необходимо проверить, возможно ли оплатить на данную услугу. Должен выполниться до использования метода pay.
Параметры запроса:
\nЕсли внутри сервиса, полученного из API список услуг, поля fields не пустые, тогда эти поля внутри params необходимо отправить в паре key-value (ключ-значение). Если значение required=true, отправлять обязательно.
\nВ паре key-value:
\nKey – название поля field,
\nValue – связан с типом поля field.type:
\n- если field.type=”LIST”, отправляется id одного
из элементов списка value_list,
- если field.type=”TEXT”, отправляется обычный текст.
\nРассмотрим пример заполнения params.
\nЕсли сервис, взятый из API «Список услуг», выглядит следующим образом (это всего лишь пример):
\n{\n \"id\": 9983,\n \"name\": \"Vodafone\",\n \"category_name\": \"Мобильные операторы\",\n \"type\": \"TOP_UP_FIXED\",\n \"min_amount\": 11350.00,\n \"max_amount\": 11350000.00,\n \"fields\": [\n {\n \"id\": 500,\n \"name\": \"nominal\",\n \"type\": \"LIST\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": [\n {\n \"id\": 3333,\n \"title\": \"TRY 80.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n },\n {\n \"id\": 4444,\n \"title\": \"TRY 100.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n }\n ]\n },\n {\n \"id\": 501,\n \"name\": \"sender_name\",\n \"type\": \"TEXT\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n },\n {\n \"id\": 502,\n \"name\": \"receiver_name\",\n \"type\": \"TEXT\",\n \"required\": false,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n }\n ]\n}\n\nТогда заполнение params будет следующим:
\n\"params\": {\n \"nominal\": 3333,\n \"sender_name\" : \"Falonchi Falonchiyev 1\",\n \"receiver_name\" : \"Falonchi Falonchiyev 2\" – это не обязательно (not required)\n}\n\nЕсли запрос обработан корректно, то в ответе возвращаются сведения о возможности проведения платежа.Если возвращается число 0 в теге status, запрос был успешным
Параметры ответа:
\n","urlObject":{"path":["api","payment","check"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"013a2884-5132-4660-be98-64238a8ef1fb","name":"Success Check","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"\n{ \n \"service_id\":488,\n \"account\": \"550831976\",\n \"agent_transaction_id\":\"637553186520953102\",\n \"amount\":1000,\n \"params\": {\n \n\n\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/payment/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 26 Apr 2021 07:18:03 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\",\n \"success\": true,\n \"status\": 0,\n \"account\": \"550831976\",\n \"amount\": 1000.00,\n \"transaction_id\": 1619421479155,\n \"amount_in_currency\": 1000.00,\n \"comission\": 0,\n \"currency\": \"UZS\"\n}\n\n//or\n\n{ \n \"service_id\":488,\n \"account\": \"550831976\",\n \"agent_transaction_id\":\"637553186520953102\",\n \"amount\":1000,\n \"params\": {\n \"nominal\" : 4100,\n \"sender_name\" : \"Falonchi\"\n }\n}\n\n"},{"id":"fb630fbb-18b1-4551-a24c-fc0f782495f6","name":"Error - 500","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"service_id\":488,\n \"account\": \"550831976\",\n \"agent_transaction_id\":\"637553186520953102\",\n \"amount\":1000,\n \"params\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/api/payment/check","host":["{{url}}"],"path":["api","payment","check"],"query":[{"key":"","value":"","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 26 Apr 2021 07:59:59 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2021-04-26T07:59:59.922+0000\",\n \"status\": 500,\n \"error\": \"Internal Server Error\",\n \"message\": \"No message available\",\n \"path\": \"/api/payment/check\"\n}"}],"_postman_id":"fff2099e-e74a-4ab2-b57b-343ef3aaeeeb"}],"id":"9926218a-451e-42ed-933f-0fa0fafbb94c","description":"check - С помощью этого запроса вам необходимо проверить, возможно ли оплатить данную услугу. Метод должен быть выполнен до использования метода pay.
check_dest - Этот метод работает аналогично методу check, но отличается тем, что здесь используется не amount, а destination_amount — сумма, которую должен получить конечный аккаунт. Метод должен быть выполнен до использования метода pay.
Важно:
Пока не все сервисы поддерживают этот метод
Параметры запроса:
\nЕсли внутри сервиса, полученного из API список услуг, поля fields не пустые, тогда эти поля внутри params необходимо отправить в паре key-value (ключ-значение). Если значение required=true, отправлять обязательно.
\nВ паре key-value:
\nKey – название поля field,
\nValue – связан с типом поля field.type:
\n- если field.type=”LIST”, отправляется id одного
из элементов списка value_list,
- если field.type=”TEXT”, отправляется обычный текст.
\nРассмотрим пример заполнения params.
\nЕсли сервис, взятый из API «Список услуг», выглядит следующим образом (это всего лишь пример):
\n{\n \"id\": 9983,\n \"name\": \"Vodafone\",\n \"category_name\": \"Мобильные операторы\",\n \"type\": \"TOP_UP_FIXED\",\n \"min_amount\": 11350.00,\n \"max_amount\": 11350000.00,\n \"fields\": [\n {\n \"id\": 500,\n \"name\": \"nominal\",\n \"type\": \"LIST\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": [\n {\n \"id\": 3333,\n \"title\": \"TRY 80.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n },\n {\n \"id\": 4444,\n \"title\": \"TRY 100.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n }\n ]\n },\n {\n \"id\": 501,\n \"name\": \"sender_name\",\n \"type\": \"TEXT\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n },\n {\n \"id\": 502,\n \"name\": \"receiver_name\",\n \"type\": \"TEXT\",\n \"required\": false,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n }\n ]\n}\n\nТогда заполнение params будет следующим:
\n\"params\": {\n \"nominal\": 3333,\n \"sender_name\" : \"Falonchi Falonchiyev 1\",\n \"receiver_name\" : \"Falonchi Falonchiyev 2\" – это не обязательно (not required)\n}\n\nЕсли запрос обработан корректно, то в ответе возвращаются сведения о возможности проведения платежа.Если возвращается число 0 в теге status, запрос был успешным
Параметры ответа:
\n","urlObject":{"path":["api","agent","payment","check_dest"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9fa64d2e-560c-44dd-bf07-c08780322627","name":"Success Check","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"service_id\":488,\n \"account\": \"550831976\",\n \"agent_transaction_id\":\"637553186520953102\",\n \"destination_amount\":1000,\n \"params\": {\n \n\n\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/agent/payment/check_dest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 26 Apr 2021 07:18:03 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\",\n \"success\": true,\n \"status\": 0,\n \"account\": \"550831976\",\n \"amount\": 1000.00,\n \"transaction_id\": 1619421479155,\n \"amount_in_currency\": 1000.00,\n \"currency\": \"UZS\"\n}\n\n//or\n\n{\n \"service_id\":488,\n \"account\": \"550831976\",\n \"agent_transaction_id\":\"637553186520953102\",\n \"amount\":1000,\n \"params\": {\n \"nominal\" : 4100,\n \"sender_name\" : \"Falonchi\"\n }\n}\n\n"},{"id":"23375063-25b8-4b59-a4f8-fe0e2c96a742","name":"Error - 500","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"service_id\": 488,\n \"account\": \"550831976\",\n \"agent_transaction_id\": \"637553186520953102\",\n \"destination_amount\": 1000,\n \"params\": {}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/api/agent/payment/check_dest","host":["{{url}}"],"path":["api","agent","payment","check_dest"],"query":[{"key":"","value":"","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 26 Apr 2021 07:59:59 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2021-04-26T07:59:59.922+0000\",\n \"status\": 500,\n \"error\": \"Internal Server Error\",\n \"message\": \"No message available\",\n \"path\": \"/api/payment/check\"\n}"}],"_postman_id":"f89cce9a-da1f-4aa5-8301-36a3073a8d71"}],"id":"3e9bd7d6-7f14-4b4f-ad30-8be8452eb8a7","_postman_id":"3e9bd7d6-7f14-4b4f-ad30-8be8452eb8a7","description":""},{"name":"Подтверждение платежа","item":[{"name":"/api/payment/pay","id":"e26f04db-4093-40fb-8d53-f3bfc17e805c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"agent_transaction_id\": \"637553186520953102\"\n}\t","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/payment/pay","description":"pay - метод, который должен выполниться после того как метод check вернет значение True в параметре \"success\" .
Данный метод используется для того, чтобы выполнилась реальная транзакция.
Параметры запроса:
\nЕсли запрос обработан корректно, то в ответе возвращаются сведения о платеже. Дополнительная информация возвращается в параметре data.
Параметры ответа:
\n","urlObject":{"path":["api","payment","pay"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"528902b6-d113-46e4-82ef-91658353c0ac","name":"Success Pay","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"agent_transaction_id\": \"637553186520953102a\"\n}\t","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/payment/pay"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 26 Apr 2021 07:18:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction is success\",\n \"success\": true,\n \"status\": 0\n}"},{"id":"551d3fc0-9d2e-4943-b68c-a42b8f3fbd7e","name":"Proccessing","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"agent_transaction_id\": \"637553186520953102\"\n}\t","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/payment/pay"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 26 Apr 2021 08:00:58 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction is in proccessing\",\n \"success\": true,\n \"status\": 1\n}"}],"_postman_id":"e26f04db-4093-40fb-8d53-f3bfc17e805c"}],"id":"f8deffa0-4ab1-4e0d-9256-d5c762e13add","description":"StartFragment
\npay - метод, который должен быть выполнен после того, как метод check вернёт значение True в параметре \"success\" .
Данный метод используется для того, чтобы провести реальную транзакцию.
EndFragment
\n","_postman_id":"f8deffa0-4ab1-4e0d-9256-d5c762e13add"},{"name":"Проверка статуса платежа","item":[{"name":"/api/payment/check_status","id":"bbac71b1-2d90-424f-add7-08bd5f5246c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"agent_transaction_id\": 1619421479155\r\n}\t","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/payment/check_status","description":"check_status - метод, который должен выполниться если в методе pay не получили финальный статус . Используется для получения информации о транзакции в случае получения некорректного ответа. Возвращает значения True или False. Если ответ от сервиса не получен или получен нечеткий ответ (например: HTTP status 500), системе агента следует отправить check_status запрос для получения окончательного ответа. Рекомендуется следующий режим повтора: первый повтор через 1 минуту, следующие три с промежутком в 5 минут, далее не более одного раза в 30 минут.
Параметры запроса:
\nЕсли запрос обработан корректно, то в ответе возвращаются сведения о платеже. Дополнительная информация возвращается в параметре data.
Параметры ответа:
\n","urlObject":{"path":["api","payment","check_status"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f6037251-f767-45af-b87e-48720b7aa8ce","name":"Success check status","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"agent_transaction_id\": \"637553186520953102\"\r\n}\t","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/payment/check_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 26 Apr 2021 07:20:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction is success\",\n \"success\": true,\n \"status\": 0\n}"},{"id":"62b91922-a892-49fb-8a26-a89685bc34f0","name":"Not success check status","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"agent_transaction_id\": \"637553186520953102\"\r\n}\t","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/payment/check_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 26 Apr 2021 08:08:20 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction is not success\",\n \"success\": false,\n \"status\": -108\n}"}],"_postman_id":"bbac71b1-2d90-424f-add7-08bd5f5246c5"}],"id":"f7af480a-4853-43b8-b60b-f2a7fd528897","description":"check_status - метод, который должен быть выполнен, если в методе pay не получен финальный статус .
Он используется для получения информации о транзакции, в случае получения некорректного ответа. Метод возвращает значения True или False.
\nЕсли ответ от сервиса не получен или получен нечеткий ответ (например: HTTP status 500), системе агента следует отправить check_status запрос для получения окончательного ответа.
\nРекомендуется следующий режим повтора: первый повтор через 1 минуту, следующие три с промежутком в 5 минут, далее не более одного раза в 30 минут.
\n","_postman_id":"f7af480a-4853-43b8-b60b-f2a7fd528897"},{"name":"Получение списка услуг","item":[{"name":"/api/agent/service/list","id":"ea479c5b-0c47-4390-9219-479633538ac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{token}}","type":"text"}],"url":"{{url}}/api/agent/service/list","description":"service_list - данный запрос возвращает список услуг которые были предоставлены агенту
Если запрос обработан корректно, то в ответе возвращается список с активными услугами доступными агенту.
\nПараметры ответа:
\n","urlObject":{"path":["api","agent","service","list"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2990b023-4d5e-4476-a396-5ee9c40f8b40","name":"Success","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","type":"text"}],"url":"{{url}}/api/agent/service/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 27 Apr 2021 07:37:04 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 872,\n \"name\": \"Ucell\",\n \"min_amount\": 0.1,\n \"max_amount\": 95.36,\n \"type\": \"PIN\",\n \"fields\": []\n },\n {\n \"id\": 872,\n \"name\": \"Beeline\",\n \"min_amount\": 0.1,\n \"max_amount\": 95.36,\n \"type\": \"PIN\",\n \"fields\": []\n },\n {\n \"id\": 872,\n \"name\": \"Salamander\",\n \"min_amount\": 0.1,\n \"max_amount\": 95.36,\n \"type\": \"PIN\",\n \"fields\": []\n }\n]"}],"_postman_id":"ea479c5b-0c47-4390-9219-479633538ac6"}],"id":"5541f33c-6a21-4ceb-b14c-7716911dd1bd","description":"service_list - данный запрос возвращает список услуг, которые были предоставлены агенту.
deposit - данный запрос производится для получения баланса агента
Параметры ответа:
\n","urlObject":{"path":["api","agent","deposit"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ea5e2dfd-209a-498b-9ed6-db74dcad2291","name":"Success","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","type":"text"}],"url":"{{url}}/api/agent/deposit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Date","value":"Tue, 27 Apr 2021 07:38:26 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"balance\": 655929.26,\n \"currency\": 860,\n \"over_balance\": 9940300,\n \"over_limit\": 0\n}"}],"_postman_id":"a2d569b6-70ac-4f68-a432-3a5cabb20921"}],"id":"e87f8e1c-da98-419a-b006-200405a5d2a2","description":"deposit - данный запрос производится для получения баланса агента.
Агент ежесуточно (до 7 часов 00 минут 00 секунд времени по Ташкенту) в день, следующий за отчетным днём, независимо от количества принятых Платежей, формирует и направляет в OSON Ежедневный Реестр принятых платежей за отчетный операционный день в формате .csv по электронной почте на адрес: report@oson.uz.
\nЕжедневный Реестр Агента включает только успешно проведенные Платежи.
\nВ качестве идентификатора Платежа выступают:
\n0 - Success
1 - In processing
-100 - Unauthorized
-101 - Paramaters are missing
-102 - Paramaters are invalid
-103 - Merchant not found
-104 - You can not pay for this merchant
-105 - Amount is less from minimum
-106 - Amount is greater from maximum
-107 - Transaction not found
-108 - Transaction is not success
-109 - Transaction is not valid
-110 - Account not found
-111 - Deposit is not enough
-112 - Payment authorization error
-113 - Identification is not valid
-114 - Amount is not valid
-115 - Method not allowed
-116 - Deposit is not found
-117 - Transaction is too old
-118 - Transaction is duplicate
-119 - Agent is not active at the moment
-135 - Technical problems on the part of the supplier
-136 - Not enough gift cards
-137 - The amount is greater than the allowed limit
-139 - Required fields are not fully
-140 - The monthly limit is exceeded for this account
-141 - The daily limit is exceeded for this account
-142 - The service not active
-144 - The branch is not available
-145 - Merchant side error
-146 - Pay time exceeded
-147 - Error! This invoice already paid.
-156 - The balance is not enough.
-999 - Unknown error
Этот метод позволяет получить список успешных транзакций за день.
\n","urlObject":{"path":["agent","transaction","list"],"host":["api"],"query":[],"variable":[]}},"response":[{"id":"cce4833c-3494-4269-bfee-e6650a0c5f1c","name":"Transactions list","originalRequest":{"method":"GET","header":[],"url":{"raw":"api/agent/transaction/list?date=date","host":["api"],"path":["agent","transaction","list"],"query":[{"key":"date","value":"date","description":"дд.мм.гггг"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{ \r\n \"message\": \"Success\",\r\n \"success\": true,\r\n \"status\": 0,\r\n \"data\": [\r\n {\r\n \"transaction_id\": 1674245575322,\r\n \"account\": \"998883985588\",\r\n \"agent_transaction_id\": \"58555539\",\r\n \"amount\": 1000.0000,\r\n \"time\": \"20.01.2023 23:59:35\",\r\n \"service_id\": 96,\r\n \"service_name\": \"Mobiuz - Uzbekistan\"\r\n }}"}],"_postman_id":"a52449a7-a703-46c3-929a-9d380834a8dc"}],"id":"52f3ce6b-9412-45f3-8f39-d5aa35f23e1b","description":"Используя данный метод можно получить список успешных транзакций за день в json формате.
\nПараметры:
\n","_postman_id":"52f3ce6b-9412-45f3-8f39-d5aa35f23e1b"},{"name":"Часто задаваемые вопросы","item":[],"id":"bab6a6fb-44b8-4b58-8325-f5e233012653","description":"Вопрос:
\nВопрос по agent_transaction_id. Этот идентификатор должен быть сквозной в запросах check и pay в рамках одной транзакции? А в случае с Voucher также требуется запрос check/calculate, может ли agent_transaction_id в check/calculate отличаться от agent_transaction_id в check и pay?
Ответ:
Да, параметр agent_transaction_id является
сквозным в запросах check и pay в рамках одной транзакции. Это одно и то же значение. В
запросе pay Агент не может дать другое значение для параметра agent_transaction_id. Агент может дать в этом параметре
другое значение, но транзакция может не пройти. Например, если у Агента другая валюта, а у Поставщика – другая. Агент в pay запросе должен использовать то же значение параметра agent_transaction_id, что было использовано в check запросе.
Иначе транзакция не пройдёт.
Вопрос:
\nНе могли бы вы предоставить нам данные хотя бы по одному сервису каждого типа: Top Up, Voucher, PIN?
\nОтвет:
\nTop Up - Ucell, Voucher - PUBG, PIN - KSA.
\n","_postman_id":"bab6a6fb-44b8-4b58-8325-f5e233012653"}],"id":"188e138e-8603-4dba-ba12-dc7695160eb9","_postman_id":"188e138e-8603-4dba-ba12-dc7695160eb9","description":""},{"name":"Documentation in English","item":[{"name":"Introduction","item":[],"id":"a4ac8bda-d079-4ca0-8fff-b210a355c5f4","description":"Introduction
\nProtocol Agent API provides access to global services through a single gateway.
\nProduction environment: https://api.interhub.ae
\nTypes of transactions.
InterHub agents can make 3 types of payment: Top Up, Voucher, PIN.
Figure 1 above shows the Top Up transaction. First of all, the agent sends a check request. If InterHub returns \"success\", the agent sends a pay request. If the payment is successful, InterHub returns \"success\" and the process is completed. Figure 1 shows the successful outcome of the events. However, after each request is sent by the agent, if InterHub returns \"error\", the process ends.
\nWhen an agent sends a pay request, InterHub can return 3 different responses: success, process, error. In case InterHub returned \"process\", it is recommended to send a \"check_status\" request every 5 minutes so as not to load the server.
\nFigure 2 shows the Voucher transaction. In this transaction, the agent, first of all, sends a \"calculate request\" to InterHub. If this request was successful, then everything works as in the Top Up transaction described above.
\nFigure 3 above shows the PIN transaction. The difference between this transaction and the previous two is that in the PIN transaction, the agent comes to InterHub with a specific request: where exactly, to which account to send what amount. The fixed_amount parameter is used here - a fixed amount.
\nWhat does the protocol allow?
1. To check the possibility of making a payment - check
2. Pay for services to clients of \"InterHub\" - pay
3. Check the current status of the transfer transaction - check_status
4. Allows agents to view their balance - deposit
5. Makes it possible to get information about all services via the service_list
Authorization
- Authorization takes place using a token.
- The url and token are provided by the managers during the integration process.
How does it work?
\nThere are two types of payment: fixed payment (voucher) and exact payment amount (top-up).
If the service to be paid for requires a certain amount, agents will need to use the calculate method.
Service types are defined via the service_list API.
Agents must send a check request to verify the possibility of making a payment ({{url}}/api/payment/check).
If a successful response is received to the check request, the agent can confirm the payment using the pay API. ( {{url}}/api/payment/pay )
API check_status is used to get the final payment status. This API is used when the final payment status is not specified in the pay request. ( {{url}}/api/payment/check_status )
Upon successful final payment status, funds are automatically transferred to the user's account from your agency account.
Interaction format.
The API Protocol for accepting payments is based on the principles of REST architecture.
The API uses HTTPS requests as the main protocol.
API parameters are placed in the JSON body of the request. In POST and GET requests, parameters are placed in the request URL.
The API always returns a response in JSON format.
LLC \"BRIO GROUP\".
\n","_postman_id":"a4ac8bda-d079-4ca0-8fff-b210a355c5f4"},{"name":"Getting the amount","item":[{"name":"/api/agent/payment/check/calculate Copy","id":"0cc5735f-43ad-4c44-b026-fe1e73c82651","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"service_id\": 111,\n\t\"account\": \"example@gmail.com\",\n\t\"agent_transaction_id\":\"agent_98765431\",\n \"params\":{}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/agent/payment/check/calculate","description":"If the fields are not empty inside the service received from the API \"List of services\",
then these fields inside params must be sent in a key-value pair. If the value required=true,
it is mandatory to send.
In a key-value pair:
Key – field name,
Value – associated with the field.type:
field.type=”LIST\", the id of one of the items in the value_list is sent,field.type=”TEXT\", plain text is sent.params.{\n \"id\": 9983,\n \"name\": \"Vodafone\",\n \"category_name\": \"Мобильные операторы\",\n \"type\": \"TOP_UP_FIXED\",\n \"min_amount\": 11350.00,\n \"max_amount\": 11350000.00,\n \"fields\": [\n {\n \"id\": 500,\n \"name\": \"nominal\",\n \"type\": \"LIST\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": [\n {\n \"id\": 3333,\n \"title\": \"TRY 80.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n },\n {\n \"id\": 4444,\n \"title\": \"TRY 100.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n }\n ]\n },\n {\n \"id\": 501,\n \"name\": \"sender_name\",\n \"type\": \"TEXT\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n },\n {\n \"id\": 502,\n \"name\": \"receiver_name\",\n \"type\": \"TEXT\",\n \"required\": false,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n }\n ]\n}\n\nThen the filling of params will be as follows:
\"params\": {\n \"nominal\": 3333,\n \"sender_name\" : \"Falonchi Falonchiyev 1\",\n \"receiver_name\" : \"Falonchi Falonchiyev 2\" - it is not required\n}\n\nThis method is used only if the service type is Top-Up-Fixed, PIN or Voucher.
Calculate - API is used to get a fixed amount of the service, as well as to check whether it is possible to make a real payment.
The Calculate method must be executed before using the check method.
After receiving a fixed amount, the agent must use the check method.
POST
\n{{url}}/api/agent/payment/check/calculate\n\n/api/agent/payment/check/calculate
\nThis method is used only if the service type is Top-Up-Fixed, PIN or Voucher.
Calculate - API is used to get a fixed amount of the service and also check whether it is possible to make a real payment.
The Calculate method must be executed before using the check method. After receiving a fixed amount, the agent must use the check method.
Request format
Request Parameters:
Response format
If the request is processed correctly, the response returns information about the possibility of making a payment.If the number 0 is returned in the status tag, the request was successful.
Response Parameters:
\nResponse with errors
\nIf the server could not process the request, the API returns a response with the error code that occurred. Response Parameters:
\nHeaders
\ntoken {{token}}
\nBODY raw
\n{\n \"service_id\": 111,\n \"account\": \"example@gmail.com\",\n \"agent_transaction_id\":\"agent_98765431\",\n \"params\":{}\n}\n\nIf the fields are not empty inside the service received from the API \"List of services\",
then these fields inside params must be sent in a key-value pair. If the value required=true,
it is mandatory to send.
In a key-value pair:
Key – field name,
Value – associated with the field.type:
\n{\n \"id\": 9983,\n \"name\": \"Vodafone\",\n \"category_name\": \"Мобильные операторы\",\n \"type\": \"TOP_UP_FIXED\",\n \"min_amount\": 11350.00,\n \"max_amount\": 11350000.00,\n \"fields\": [\n {\n \"id\": 500,\n \"name\": \"nominal\",\n \"type\": \"LIST\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": [\n {\n \"id\": 3333,\n \"title\": \"TRY 80.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n },\n {\n \"id\": 4444,\n \"title\": \"TRY 100.00\",\n \"condition\": \"A\",\n \"field_id\": 54,\n \"parent_id\": -1\n }\n ]\n },\n {\n \"id\": 501,\n \"name\": \"sender_name\",\n \"type\": \"TEXT\",\n \"required\": true,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n },\n {\n \"id\": 502,\n \"name\": \"receiver_name\",\n \"type\": \"TEXT\",\n \"required\": false,\n \"service_id\": 9983,\n \"parent_id\": -1,\n \"value_list\": []\n }\n ]\n}\n\nThen the filling of params will be as follows:
\n\"params\": {\n \"nominal\": 3333,\n \"sender_name\" : \"Falonchi Falonchiyev 1\",\n \"receiver_name\" : \"Falonchi Falonchiyev 2\" - it is not required\n}\n\ncheck - With this request you need to check whether it is possible to pay for this service.
\nThe method must be executed before using the pay method.
POST
\n/api/payment/check
\n{{url}}/api/payment/check
\ncheck - With this request you need to check whether it is possible to pay for this service. Must be executed before using the pay method.
Request format
Request Parameters:
Responce format
\nIf the request is processed correctly, the response returns information about the possibility of making a payment.If the number 0 is returned in the status tag, the request was successful.
Response Parameters:
\nHEADERS
\ntoken {{token}}
\nBODY raw
\n{ \n \"service_id\":488,\n \"account\": \"550831976\",\n \"agent_transaction_id\":\"637553186520953102\",\n \"amount\":1000,\n \"params\": {}\n}\n\npay is the method that must be executed after the check method returns True in the \"success\" parameter.
This method is used in order to conduct a real transaction.
POST
\n/api/payment/pay
\n{{url}}/api/payment/pay
\npay is the method that should be executed after the check method returns the True value in the \"success\" parameter.
This method is used in order for a real transaction to be executed.
Request format
\nRequest parameters:
\nResponce format
\nIf the request is processed correctly, the payment information is returned in the response. Additional information is returned in the data parameter.
Response Parameters:
\nHEADERS
\ntoken {{token}}
\nBODY raw
\n{\n \"agent_transaction_id\": \"637553186520953102\"\n}\n\ncheck_status is the method that should be executed if the final status is not received in the pay method.
It is used to get information about the transaction, in case of receiving an incorrect response. The method returns True or False values.
\nIf no response is received from the service or a fuzzy response is received (for example: HTTP status 500), the agent's system should send a check_status request to receive a final response.
The following repeat mode is recommended: the first repeat after 1 minute, the next three with an interval of 5 minutes, then no more than once every 30 minutes.
\nPOST
\n/api/payment/check_status
\n{{url}}/api/payment/check_status
\ncheck_status is the method that should be executed if the final status is not received in the pay method. It is used to get information about the transaction in case of receiving an incorrect response. Returns True or False values. If no response is received from the service or a fuzzy response is received (for example: HTTP status 500), the agent's system should send a check_status request to receive a final response. The following repeat mode is recommended: the first repeat after 1 minute, the next three with an interval of 5 minutes, then no more than once every 30 minutes.
Request format
Request Parameters:
Responce format
\nIf the request is processed correctly, the payment information is returned in the response. Additional information is returned in the data parameter.
\nResponse Parameters:
\nHEADERS
\ntoken {{token}}
\nBODY raw
\n{\n \"agent_transaction_id\": 1619421479155\n} \n\nservice_list - this request returns a list of services that were provided to the agent.
GET
\n/api/agent/service/list
\n{{url}}/api/agent/service/list
\nservice_list - this request returns a list of services that were provided to the agent
Response format
If the request is processed correctly, the response returns a list with active services available to the agent.
Response Parameters:
\n","_postman_id":"517c70d9-dbbb-482a-84ce-db2a85ad09b4"},{"name":"Checking the balance","item":[{"name":"/api/agent/deposit","id":"f83ecea9-19e3-4e33-982e-72965520ddce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/agent/deposit","urlObject":{"path":["api","agent","deposit"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6cf78256-985a-4550-aa36-0773593799a2","name":"New Request","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"balance\": 655929.26,\r\n \"currency\": 860,\r\n \"over_balance\": 9940300,\r\n \"over_limit\": 0\r\n}"}],"_postman_id":"f83ecea9-19e3-4e33-982e-72965520ddce"}],"id":"c6e98e98-8cc7-499e-a489-e2c23c5a21b1","description":"deposit - this request is made to get the agent's balance.
GET
\n/api/agent/deposit
\n{{url}}/api/agent/deposit
\ndeposit - this request is made to get the agent's balance.
The Agent generates and sends to OSON a Daily Register of Accepted payments for the reporting operational day in the format every day (up to 7 hours 00 minutes 00 seconds of Tashkent time) on the day following the reporting day, regardless of the number of accepted Payments.csv by email to: report@oson.uz .
\nThe Agent's daily Register includes only successfully completed Payments.
\nThe Payment identifier is:
\n0 - Success
1 - In processing
-100 - Unauthorized
-101 - Paramaters are missing
-102 - Paramaters are invalid
-103 - Merchant not found
-104 - You can not pay for this merchant
-105 - Amount is less from minimum
-106 - Amount is greater from maximum
-107 - Transaction not found
-108 - Transaction is not success
-109 - Transaction is not valid
-110 - Account not found
-111 - Deposit is not enough
-112 - Payment authorization error
-113 - Identification is not valid
-114 - Amount is not valid
-115 - Method not allowed
-116 - Deposit is not found
-117 - Transaction is too old
-118 - Transaction is duplicate
-119 - Agent is not active at the moment
-135 - Technical problems on the part of the supplier
-136 - Not enough gift cards
-137 - The amount is greater than the allowed limit
-139 - Required fields is not fully
-140 - The monthly limit is exceeded for this account
-141 - The daily limit is exceeded for this account
-142 - The service not active
-144 - The branch is not available
-145 - Merchant side error
-146 - Pay time exceeded
-147 - Error! This invoice already paid.
-156 - The balance is not enough.
-999 - Unknown error
This request gets the list of transactions for a day.
\n","urlObject":{"path":["agent","transaction","list"],"host":["api"],"query":[],"variable":[]}},"response":[{"id":"227abe2c-d5c3-4eac-8c97-898fa2adfe2d","name":"Transactions list","originalRequest":{"method":"GET","header":[],"url":{"raw":"api/agent/transaction/list?date=date","host":["api"],"path":["agent","transaction","list"],"query":[{"key":"date","value":"date","description":"dd.mm.yyyy"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{ \r\n \"message\": \"Success\",\r\n \"success\": true,\r\n \"status\": 0,\r\n \"data\": [\r\n {\r\n \"transaction_id\": 1674245575322,\r\n \"account\": \"998883985588\",\r\n \"agent_transaction_id\": \"58555539\",\r\n \"amount\": 1000.0000,\r\n \"time\": \"20.01.2023 23:59:35\",\r\n \"service_id\": 96,\r\n \"service_name\": \"Mobiuz - Uzbekistan\"\r\n }}"}],"_postman_id":"bc966b88-532f-4ecc-9254-a3e50d0b34bb"}],"id":"d3c59f99-0b00-4f02-a3d8-e6f4c918b13a","description":"Using this method, you can get a list of successful transactions for the day in json format.
\nParams:
\n","_postman_id":"d3c59f99-0b00-4f02-a3d8-e6f4c918b13a"},{"name":"FAQ","item":[],"id":"70d982d7-649e-4277-b138-d83fcd7cb6b8","description":"Question:
\nQuestion about agent_transaction_id. Should this identifier be equal in the check and pay
requests within the same transaction? And in the case of Voucher, acheck/calculate request is also required, can the agent_transaction_id incheck/calculate differ from the agent_transaction_id in check and pay?
Answer:
\nYes, the agent_transaction_id parameter is equal in the check and pay requests within the same transaction. This is the same value. In the pay request, the Agent cannot give a different
value for the agent_transaction_id parameter. The agent can give a different
value in this parameter, but the transaction may not pass. For example, if the
Agent has a different currency and the Supplier has a different one. The agent
in the pay request must use the same value of the agent_transaction_id parameter
that was used in the check request. Otherwise, the transaction will not pass.
Question:
\nCould you provide us with data on at least one service of each type: Top Up, Voucher, PIN?
Answer:
\nTop Up - Ucell, Voucher - PUBG, PIN - KSA.