Banks of India

Характеристика

Схема работы

В проведении отдельного платежа с использованием Banks of India задействуются веб-сервис мерчанта, один из интерфейсов и платёжная платформа ECommPay, а также технические средства провайдера.

Основные операции

* Информацию необходимо уточнять у курирующего менеджера ECommPay.

** Базовое и предельное время определяются следующим образом:

• Базовое время — среднее расчётное время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Это время, определяемое для условий штатной работы всех технических средств и каналов связи, а также типичных действий со стороны пользователя (там, где они необходимы). Базовое время рекомендуется использовать для реагирования на отсутствие оповещений о результате платежа и выполнения опроса состояния платежа.
• Предельное время — максимально допустимое время проведения платежа от момента его инициирования на стороне платёжной платформы до момента отправки инициатору оповещения о результате. Если платёж не был проведён или отклонён за это время, он автоматически переводится в статус decline. Для индивидуальной настройки предельного времени следует обращаться к специалистам технической поддержки ECommPay.

Сценарии использования

Проведение оплат с использованием метода Banks of India выполняется с перенаправлением пользователей к сервису провайдера, проведение выплат и возвратов — с уведомлением пользователей через веб-сервис мерчанта.

Рис.: Оплата через Payment Page с выбором банка на стороне Payment Page

Рис.: Оплата через Payment Page с выбором банка на стороне провайдера

Рис.: Оплата через Gate с перенаправлением на сайт банка

Рис.: Оплата через Gate с выбором банка на стороне провайдера

Рис.: Выплата через Gate

Рис.: Возврат через Gate

Поддержка со стороны банков

Проведение выплат с применением метода Banks of India осуществляется через банки, поддерживающие работу с этим методом. Банкам соответствуют свои идентификаторы, которые используются при инициировании выплат через Gate.

Далее в таблице в ознакомительных целях представлена информация об этих банках, которую следует уточнять у курирующего менеджера ECommPay или по запросу /v2/info/banks/{payment_method}/{operationType}/list, отправляемым методом POST через Gate API: /v2/info/banks/india/sale/list для уточнения списка банков, поддерживающих проведение оплат, или /v2/info/banks/india/payout/list — проведение выплат. Запрос должен содержать идентификаторы проекта и платежа, подпись, валюту и сумму платежа, как указано в примере. Важно передавать реальные данные о платеже, но в случае если платёж еще не сформирован, для идентификатора платежа в запросе можно указать случайное значение.

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1500,
    "currency": "INR"
  }
}

Общая информация

Для оплаты через Payment Page с использованием метода Banks of India со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате оплаты. При этом метод Banks of India можно сделать предварительно выбранным (подробнее — в разделе Предварительный выбор платёжного метода). Полная схема проведения оплаты представлена далее.

Доступны два способа выбора банка: на стороне Payment Page или на стороне провайдера.

Рис.: Схема проведения оплаты с выбором банка на Payment Page

Рис.: Схема проведения оплаты с выбором банка на стороне провайдера

Информация о формате запросов и параметрах вызова Payment Page при работе с Banks of India, а также о формате оповещений о результатах оплат приведена далее; общая информация о работе с API см. в разделе Описание Payment Page API.

Формат запросов

При формировании запросов на открытие платёжной формы с применением метода Banks of India необходимо учитывать следующее:

1. Должен использоваться базовый минимум параметров — параметры, обязательные для любого платёжного метода:
   • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
   • payment_id — идентификатор платежа, уникальный в рамках проекта;
   • payment_currency — валюта платежа в формате ISO-4217 alpha-3;
   • payment_amount — сумма платежа в минорных единицах,
   • customer_id — идентификатор пользователя в рамках проекта.
2. В зависимости от провайдера, обрабатывающего платёж, для проведения оплаты может потребоваться указывать данные пользователя в следующих параметрах:
   • customer_first_name — имя,
   • customer_last_name — фамилия,
   • customer_phone — номер телефона, должен состоять из 10 цифр, или 12 с учётом телефонного кода Индии (91), обязательность этого параметра зависит от провайдера, который проводит платёж, подробности следует уточнять у курирующего менеджера ECommPay,
   • customer_email — адрес электронной почты,
   • customer_zip — почтовый индекс,
   • customer_city — город,
   • customer_address — адрес в указанном городе.
   Если параметры отсутствуют в запросе, на Payment Page пользователю отображаются поля для ввода недостающих значений. Подробнее об уточнении параметров — в разделе Дополнение информации о платеже.

3. При использовании платёжного метода Banks of India можно настраивать отображение страницы Payment Page с выбором метода оплаты.

   По умолчанию банки, поддерживающие проведение оплат методом Banks of India, объединены в группу и отображаются одной кнопкой Banks of India, поэтому выбор банка осуществляется в два этапа.

   Оплата через Payment Page с выбором банка на стороне сервиса провайдера

   При использовании платёжного метода Banks of India с выбором банка на стороне сервиса провайдера сначала выбирается метод Banks of India на Payment Page, а затем выполняется выбор конкретного банка на стороне сервиса провайдера. В данном случае можно настраивать отображение Payment Page с предварительно выбранным платёжным методом Banks of India. Для этого необходимо передать код online-indian-banks в параметре force_payment_method.

   Оплата через Payment Page с выбором банка на стороне Payment Page

   При использовании платёжного метода Banks of India с выбором банка на стороне Payment Page сначала выбирается метод Banks of India среди прочих, а затем на следующей странице с перечнем банков выбирается конкретный банк. Существует несколько вариантов отображения страницы Payment Page с выбором метода оплаты:

   • Отображение каждого банка группы отдельной кнопкой. Для этого необходимо передавать параметр split_banks со значением true в строке payment_methods_options.

     payment_methods_options={"online_indian_banks": {"split_banks": true}}
     

   • Отображение кнопок конкретных банков (одного или нескольких). В списке методов может присутствовать метод Banks of India. Для этого необходимо передавать идентификаторы банков в параметре banks_id. Для отображения нескольких банков необходимо перечислять идентификаторы этих банков через запятую c пробелом.

     payment_methods_options={"online_indian_banks": {"split_banks": true, "banks_id": [416, 415]}}

   • Отображение только банков группы без других методов. Для этого используется предварительный выбор метода Banks of India. Необходимо передавать код платежного метода online-indian-banks в параметре force_payment_method. Пользователю открывается страница с выбором банков, минуя страницу с выбором метода оплаты.
   • Отображение сайта конкретного банка. Для этого используется предварительный выбор метода Banks of India. Необходимо передавать код платежного метода online-indian-banks в параметре force_payment_method и идентификатор банка banks_id в параметре payment_methods_options. Перенаправление пользователя на сайта банка осуществляется без подтверждения готовности оплатить, минуя страницы с выбором метода оплаты и с выбором банков.

     Рис.: Пример запроса на оплату с перенаправлением на сайт банка

         { 
           payment_id: 'X03936', 
           payment_amount: 200000, 
           payment_currency: 'INR', 
           project_id: 115,
           customer_id: 'customer123',
           customer_first_name: 'John',
           customer_last_name: 'Smith',
           customer_email: 'smith@example.com',
           customer_phone: '911234567890',
           customer_zip: '400009',
           customer_city: 'Mumbai',
           customer_address: '99, Chakla Street, Masjid Bunder (east)'
           force_payment_method: 'online-indian-banks',
           payment_methods_options={"online_indian_banks": {"banks_id": [416]}},
           signature: "kUi2x9dKHAVNU0FYlSCQ9vySUkDJrOcZzUCwX6R\/ekpZhkIQg=="
         }

4. Дополнительно могут использоваться любые другие параметры из числа доступных для работы с Payment Page. Детальная информация обо всех параметрах приведена в разделе Параметры открытия платежной формы Payment Page.
5. После определения всех параметров необходимо составить подпись. Подробную информацию см. в Работа с подписью к данным.

Таким образом, корректный запрос на открытие платёжной формы с применением метода Banks of India должен содержать идентификаторы проекта и платежа, также валюту и сумму платежа, данные пользователя и подпись:

    { 
      payment_id: 'ID_183', 
      payment_amount: 10000, 
      payment_currency: 'INR', 
      project_id: 238,
      customer_id: 'customer123',
      customer_first_name: 'John',
      customer_last_name: 'Smith',
      customer_email: 'smith@example.com',
      customer_phone: '911234567890',
      customer_zip: '400009',
      customer_city: 'Mumbai',
      customer_address: '99, Chakla Street, Masjid Bunder (east)'
      signature: "hlhydUV+SmGJYhm6G.....5JuyamXS/BYQ1M2IUgBuVxa93HwzBbEjF9Veg=="
    }

Формат оповещений

Для оповещений о результатах оплат с применением метода Banks of India используется стандартный формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 239 была успешно проведена оплата в размере 10,00 INR.

{
        "project_id": 239,
        "payment": {
            "id": "EP8550-ad59",
            "type": "purchase",
            "status": "success",
            "date": "2020-05-13T09:06:45+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "test"
        },
        "customer": {
            "id": "345435435"
        },
        "operation": {
            "id": 548,
            "type": "sale",
            "status": "success",
            "date": "2020-05-13T09:06:45+0000",
            "created_date": "2020-05-13T09:05:47+0000",
            "request_id": "7b0f630c3f2f395bba2738cf9086622bd4dd50bd3-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2080,
                "payment_id": "15141-1589360772-25",
                "auth_code": ""
            }
        },
        "signature": "rSV33iKYiOVpXctCvTGTg3...GLZny35xplogtGYT1w=="
    }

В следующем примере оплата была отклонена.

{
        "project_id": 239,
        "payment": {
            "id": "EP8550-ad59",
            "type": "purchase",
            "status": "decline",
            "date": "2020-05-13T09:06:45+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "test"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 548,
            "type": "sale",
            "status": "decline",
            "date": "2020-05-13T09:06:45+0000",
            "created_date": "2020-05-13T09:05:47+0000",
            "request_id": "7b0f630c3f2f395bba2738cf9086622bd4dd50bd3-00000002",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "20000",
            "message": "decline",
            "provider": {
                "id": 2080,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "rSV33iKYiOVpXctCvTGTg3...GLZny35xplogtGYT1g=="
    }

Дополнительные материалы

Для организации работы с оплатами через Payment Page также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация о выполнении операций

Общая информация

Для оплаты через Gate с использованием метода Banks of India со стороны веб-сервиса необходимо:

1. Отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay.
2. Осуществить перенаправление пользователя на сайт банка (или на страницу выбора банка), поддерживающего работу с методом Banks of India.
3. Принять оповещение о результате оплаты.

Полная схема проведения оплаты представлена далее.

Рис.: Проведение оплаты через Gate с перенаправлением на сайт банка

Рис.: Проведение оплаты через Gate с выбором банка на стороне провайдера

Информация о формате запросов и параметрах инициации оплат методом Banks of India через Gate, а также о формате оповещений о результатах оплат приведена далее, общая информация о работе с API см. в разделе Работа с API.

Формат запросов

При работе с запросами на оплаты с применением метода Banks of India необходимо учитывать следующее:

1. Должен использоваться запрос /v2/payment/banks/india/sale, отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/banks/{payment_method}/sale.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
     • payment_id — идентификатор платежа, уникальный в рамках проекта;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным);
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в минорных единицах валюты,
     • currency — валюта платежа в формате ISO-4217 alpha-3;
   • customer — сведения о пользователе:
     • id — идентификатор в рамках проекта,
     • ip_address — используемый IP-адрес;
   • account — объект, содержащий сведения о банковском счёте пользователя:
     • bank_id — идентификатор банка;
   • return_url — объект, содержащий URL для перенаправления пользователя в веб-сервис:
     • success — URL для перенаправления пользователя при успешной оплате.
3. В зависимости от провайдера, обрабатывающего платёж, может потребоваться указывать данные пользователя. Если параметры отсутствуют в запросе, список недостающих параметров отправляется в оповещении на уточнение. Подробнее об уточнении параметров — в разделе Дополнение информации о платеже.

   Рекомендуется использовать следующие объекты и параметры:

   • customer — объект, содержащий сведения о пользователе:
     • first_name — имя пользователя,
     • last_name — фамилия пользователя,
     • phone— номер телефона, должен состоять из 10 цифр, или 12 с учётом телефонного кода Индии (91), обязательность этого параметра зависит от провайдера, который проводит платёж, подробности следует уточнять у курирующего менеджера ECommPay,
     • email — адрес электронной почты,
     • zip — почтовый индекс,
     • city — город,
     • address — адрес в указанном городе.
4. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на оплату с применением метода Banks of India должен содержать идентификаторы проекта, пользователя и платежа, подпись, данные пользователя, валюту и сумму платежа, URL для перенаправления:

{
  "general": {
    "project_id": 123,
    "payment_id": "ORDER_1558600157",
    "signature": "+K6jllym+PtObocZ...A4NcWxfWJTXdESkijfsBeR6bKROUsslA=="
  },
  "customer": {
    "email": "waynen@example.com",
    "first_name": "John",
    "last_name": "Waynen",
    "phone": "911234567890",
    "zip": "400009",
    "city": "Mumbai",
    "address": "99, Chakla Street, Masjid Bunder (east)",
    "ip_address": "1.2.3.4",
    "id": "customer1"
  },
  "payment": {
    "amount": 1500,
    "currency": "INR"
  },
  "return_url": {
    "success": "https://www.example.com"
  }
}

Форматы данных для перенаправления пользователей

Для перенаправления пользователя от веб-сервиса на сайт банка (или на страницу выбора банка) необходимо принять оповещение от платёжной платформы, содержащее ссылку для перенаправления в параметре redirect_data.url и данные для отправки в теле запроса redirect_data.body, и использовать эти параметры при открытии HTML-страницы сайта методом, указанным в redirect_data.method.

Далее приведён фрагмент оповещения, содержащего данные для перенаправления.

  "redirect_data": {
    "body": {...},
    "method": "GET",
    "url": "https://example.com/payment/initialize/api/123"
  }

Формат оповещений

Для оповещений о результатах оплат с применением метода Banks of India используется стандартный формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 239 была успешно проведена оплата в размере 10,00 INR.

{
        "project_id": 239,
        "payment": {
            "id": "EP8550-ad59",
            "type": "purchase",
            "status": "success",
            "date": "2020-05-13T09:06:45+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "test"
        },
        "customer": {
            "id": "345435435"
        },
        "operation": {
            "id": 548,
            "type": "sale",
            "status": "success",
            "date": "2020-05-13T09:06:45+0000",
            "created_date": "2020-05-13T09:05:47+0000",
            "request_id": "7b0f630c3f2f395bba2738cf9086622bd4dd50bd3-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2080,
                "payment_id": "15141-1589360772-25",
                "auth_code": ""
            }
        },
        "signature": "rSV33iKYiOVpXctCvTGTg3...GLZny35xplogtGYT1w=="
    }

В следующем примере оплата была отклонена.

{
        "project_id": 239,
        "payment": {
            "id": "EP8550-ad59",
            "type": "purchase",
            "status": "decline",
            "date": "2020-05-13T09:06:45+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "test"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 548,
            "type": "sale",
            "status": "decline",
            "date": "2020-05-13T09:06:45+0000",
            "created_date": "2020-05-13T09:05:47+0000",
            "request_id": "7b0f630c3f2f395bba2738cf9086622bd4dd50bd3-00000002",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "20000",
            "message": "decline",
            "provider": {
                "id": 2080,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "rSV33iKYiOVpXctCvTGTg3...GLZny35xplogtGYT1g=="
    }

Дополнительные материалы

Для организации работы с оплатами через Gate также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация об операциях

Общая информация

Banks of India поддерживает проведение полных и частичных возвратов. Для проведения возврата через Gate с использованием метода Banks of India со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате. Полная схема проведения возврата представлена далее.

Информация о формате запросов и параметрах инициации возвратов методом Banks of India через Gate, а также о формате оповещений о результатах возвратов приведена далее, общая информация о работе с API представлена в разделе Работа с API.

Формат запросов

При работе с запросами на возврат с применением метода Banks of India необходимо учитывать следующее:

1. Должен использоваться запрос /v2/payment/banks/india/refund, отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/banks/{payment_method}/refund.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ECommPay при интеграции;
     • payment_id — идентификатор платежа, уникальный в рамках проекта;
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Работа с подписью к данным);
   • payment — объект, содержащий сведения о возврате :
     • description — комментарий или описание возврата,
     • amount — сумма возврата в минорных единицах валюты (обязательный при частичном возврате),
     • currency — валюта возврата в формате ISO-4217 alpha-3 (обязательный при частичном возврате).
3. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на возврат с применением данного метода должен содержать идентификаторы проекта и платежа, подпись и описание возврата:

{
  "general": {
    "project_id": 101,
    "payment_id": "ECT_TEST_1572258898441234343232",
    "signature": "NUpXRpdrU/rRcwEa/jQYoYbXA/YIc/dgeuncPmD/BJZGZvt59GbTSAUKHI/WrQ=="
  },
  "payment": {
    "description":"test_refund"
  }

Формат оповещений

Для оповещений о результатах возврата с применением метода Banks of India используется стандартный формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 197 был успешно проведён возврат в размере 350,00 INR.

{
        "project_id": 197,
        "payment": {
            "id": "TEST_554862",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-09-09T10:02:18+0000",
            "method": "India banks",
            "sum": {
                "amount": 0,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554862",
            "description": "TEST_554862"
        },
        "customer": {
            "id": "1",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010271,
            "type": "refund",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090267",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1751,
                "payment_id": "4952688",
                "auth_code": ""
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

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

{
        "project_id": 197,
        "payment": {
            "id": "TEST_554863",
            "type": "purchase",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "method": "India banks",
            "sum": {
                "amount": 35000,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554863",
            "description": "TEST_554863"
        },
        "customer": {
            "id": "1",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010272,
            "type": "refund",
            "status": "decline",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090268",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

Дополнительные материалы

Для организации работы с возвратами через Gate также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация об операциях

Общая информация

Для выплаты через Gate с использованием метода Banks of India со стороны веб-сервиса необходимо отправить запрос, содержащий требуемые параметры и подпись, на рабочий URL ECommPay и принять оповещение о результате выплаты. Полная схема проведения выплаты представлена далее.

Информация о формате запросов и параметрах инициации выплат методом Banks of India через Gate, а также о формате оповещений о результатах выплат приведена далее, общая информация о работе с API см. в разделе Работа с API.

Формат запросов

При работе с запросами на выплаты с применением метода Banks of India необходимо учитывать следующее:

1. Должен использоваться запрос /v2/payment/banks/india/payout, отправляемый методом POST. Этот запрос относится к группе запросов /v2/payment/banks/{payment_method}/payout.
2. В запросе должны использоваться следующие объекты и параметры:
   • general — объект, содержащий основные идентификационные сведения запроса:
     • project_id — идентификатор проекта, полученный от ECommPay при интеграции.
     • payment_id — идентификатор платежа, уникальный в рамках проекта.
     • signature — подпись запроса, составленная после указания целевых параметров (подробнее — в разделе Использование подписи к данным).
   • payment — объект, содержащий сведения о платеже:
     • amount — сумма платежа в минорных единицах валюты.
     • currency — валюта платежа в формате ISO-4217 alpha-3.
   • customer — объект, содержащий сведения о пользователе:
     • id — идентификатор пользователя на стороне веб-сервиса.
     • ip_address — используемый IP-адрес.
     • first_name — имя пользователя.
     • last_name — фамилия пользователя.
     • phone— номер телефона, должен состоять из 10 цифр, или 12 с учётом телефонного кода Индии (91), обязательность этого параметра зависит от провайдера, который проводит платёж, подробности следует уточнять у курирующего менеджера ECommPay,
     • email — адрес электронной почты.
     • address — адрес проживания.
   • account — объект, содержащий сведения о счёте получателя:
     • number — номер счёта.
     • bank_code — код филиала банка в финансовой системе Индии (Indian Financial System Code, IFSC), для определения которого можно использовать официальный реестр; с примерами таких кодов можно ознакомиться в файле.
     • bank_id — идентификатор банка (обязательность этого параметра зависит от провайдера, который проводит выплату, подробности следует уточнять у курирующего менеджера ECommPay).
3. Дополнительно могут использоваться все параметры, указанные в спецификации.

Таким образом, корректный запрос на выплату с применением метода Banks of India должен содержать идентификаторы проекта и платежа, подпись, номер счёта и данные пользователя, валюту и сумму платежа, а также сведения о счёте получателя:

{
  "general": {
    "project_id": 818,
    "payment_id": "ORDER_I1558600157",
    "signature": "+K6jllym+PtObocZ1yS...xfWJTXdESkijfsBeR6bKROUsslA=="
  },
  "payment": {
    "amount": 150000,
    "currency": "INR"
  },
  "customer": {
    "id": "24900",
    "ip_address": "1.2.3.4",
    "first_name": "John",
    "last_name": "Waynen",
    "phone": "911234567890",
    "email": "waynen@example.com",
    "address": "99, Chakla Street, Masjid Bunder (east)"
  },
  "account": {
    "bank_code": "test_code",
    "bank_id": 401,
    "number": "5588994446666"
  }
}

Формат оповещений

Для оповещений о результатах выплат с применением метода Banks of India используется стандартный формат, описание которого представлено в разделе Оповещения.

В следующем примере оповещение свидетельствует о том, что в рамках проекта 239 была успешно проведена выплата в размере 1000,00 INR.

{
        "project_id": 239,
        "payment": {
            "id": "ORDER53",
            "type": "payout",
            "status": "success",
            "date": "2020-05-21T13:23:32+0000",
            "method": "India banks",
            "sum": {
                "amount": 100000,
                "currency": "INR"
            },
            "description": "description"
        },
        "account": {
            "number": "123456"
        },
        "customer": {
            "id": "24901"
        },
        "operation": {
            "id": 1386,
            "type": "payout",
            "status": "success",
            "date": "2020-05-21T13:23:32+0000",
            "created_date": "2020-05-21T13:23:28+0000",
            "request_id": "e48da2df266940ce5f534c84cae31237ca774b6fb-00000002",
            "sum_initial": {
                "amount": 100000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2080,
                "payment_id": "15141-1589360772-26",
                "auth_code": ""
            }
        },
        "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q=="
    }

В следующем примере выплата была отклонена.

{
        "project_id": 239,
        "payment": {
            "id": "ORDER54",
            "type": "payout",
            "status": "decline",
            "date": "2020-05-21T13:23:32+0000",
            "method": "India banks",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "description"
        },
        "account": {
            "number": "123456"
        },
        "customer": {
            "id": "24900"
        },
        "operation": {
            "id": 1386,
            "type": "payout",
            "status": "decline",
            "date": "2020-05-21T13:23:32+0000",
            "created_date": "2020-05-21T13:23:28+0000",
            "request_id": "e48da2df266940ce5fdc7ae31237ca774b6fb-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2080,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q=="
    }

Дополнительные материалы

Для организации работы с выплатами через Gate также могут быть полезны следующие материалы:

• Организация взаимодействия
• Работа с подписью к данным
• Модель проведения платежей
• Информация об операциях

Информация о проведении выплат отображается в разделе Платежи интерфейса Dashboard (Old Dashboard).

Более подробная информация о проведении выплат через Dashboard (Old Dashboard) представлена в разделе Проведение выплат.

Как и при работе с другими платёжными методами, которые предоставляет ECommPay, при использовании метода Banks of India доступны разные способы анализа информации о платежах и операциях с применением этого метода — как в отдельности, так и в совокупности с другими методами.

Всю необходимую информацию можно получать и анализировать средствами Dashboard (Old Dashboard), в том числе с помощью аналитических панелей на вкладке Analytics.

Также можно выгружать нужную информацию для последующего анализа с помощью специализированных аналитических средств сторонних разработчиков:

• Dashboard (Old Dashboard) позволяет выгружать данные в форматах CSV и XLS с помощью инструментов на вкладке Платежи. При этом можно выполнять разовые выгрузки информации на локальный компьютер и задействовать периодическую выгрузку и отправку информации на заданные адреса электронной почты.
• Data API позволяет получать информацию в формате JSON и отправлять ее на заданный URL — для этого применяются запросы /operations/get.

С любыми вопросами о возможностях анализа можно обращаться в службу технической поддержки ECommPay.