African Banks

Обзор

African Banks — платёжный метод, позволяющий производить выплаты на банковские счета. Для работы с этим методом доступно проведение выплат через Gate.

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

Тип платёжного метода интернет-банкинг
Регионы использования NG, GH, KE, UG, TZ, ZA
Валюты платежей GHS, KES, NGN, TZS, UGX, ZAR, XOF
Конвертация валют на стороне ECommPay
Оплаты
Выплаты +
Оплаты по сохранённым данным
Полные возвраты
Частичные возвраты
Опротестования
Особенности
Организация и стоимость подключения по согласованию с курирующим менеджером ECommPay

Схема работы

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



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

Интерфейсы Суммы, в любой поддерживаемой валюте Время*
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) минимум максимум базовое предельное
Выплаты + 100,00 в пределах двух часов

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

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

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

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

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



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

Проведение платежей с применением метода African Banks осуществляется через банки, поддерживающие работу с этим методом. Банкам соответствуют свои идентификаторы, которые используются при инициировании выплат через Gate. Далее в таблице в ознакомительных целях представлена информация об этих банках, которую следует уточнять у курирующего менеджера ECommPay или по запросу /v2/info/banks/africa/payout/list, отправляемому методом POST через Gate API и относящемуся к группе запросов /v2/info/banks/{payment_method}/{operationType}/list.

Запрос должен содержать идентификаторы проекта и платежа, подпись, валюту и сумму платежа, как указано в примере. Важно передавать реальные данные о платеже, но в случае если платёж еще не сформирован, для идентификатора платежа в запросе можно указать случайное значение.

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

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 10000,
    "currency": "GHS"
  }
}
Табл. 1. Список банков
Банк ID
Access Bank Nigeria 193
Access Mobile 194
ABC Capital Bank Limited 659
Access Bank 269
Accessbank Tanzania Ltd 687
African Banking Corp. Bank Ltd 235
African Banking Corporation Tanzania Limited 691
Agricultural Development Bank Limited 618
Airtel Mobile Money 614
Akiba Commercial Bank Plc 669
Amalgamated Bank Ltd 625
Amana Bank Limited 695
ARB Apex Bank Ltd 617
ASO Savings & Loans 196
Azania Bank Ltd 696
Bank M Tanzania Plc 689
Bank Of Africa Uganda Ltd 654
Bank Of Baroda 628
Bank Of Baroda 649
Bank Of Baroda (Tanzania) Ltd 694
Bank Of Ghana 615
Bank Of India (Tanzania) Limited 690
Bank Of Tanzania 693
Barclays Bank 616
Barclays Bank Of Kenya 257
Barclays Bank Of Uganda Limited 643
Barclays Bank Tanzania Limited 679
BOA Bank Tanzania 677
BSIC Ghana Ltd 629
Cairo International Bank Ltd 662
Cal Bank 265
Canara Bank (Tanzania) Ltd 697
Cellulant 604
Centenary Rural Development Bank Limited 641
Cfc Stanbic Bank Kenya Limited 234
Chamsmobile 598
Chase Bank Limited 233
China Commercial Bank Limited 674
Citibank 587
Citibank N.A. 229
Citibank Tanzania Ltd 664
Citibank Uganda Ltd 651
Commercial Bank Of Africa (Tanzania) Limited 673
Commercial Bank Of Africa Limited 254
Commercial Bank Of Africa Uganda 656
Consolidated Bank Of Kenya Limited 231
Co-Operative Bank Of Kenya Limited 226
Coronation Merchant Bank 222
Covenant Bank For Women (Tanzania) Limited 681
Covenant Microfinance Bank 600
CRDB Bank Limited 684
DFCU Bank 642
Diamond Bank Plc 197
Diamond Trust Bank Limited 249
Diamond Trust Bank Tanzania Ltd 667
Diamond Trust Bank Uganda Limited 646
Eartholeum 588
Ecobank 264
Ecobank Mobile 198
Ecobank Nigeria Limited 199
Ecobank Tanzania Limited 671
Ecobank Uganda Limited 647
Energy Bank 270
Enterprise Bank Limited 200
Equatorial Commercial Bank Limited 240
Equity Bank Limited 251
Equity Bank Tanzania Limited 665
Equity Bank Uganda Ltd 660
Etranzact 586
Exim Bank Uganda Ltd 652
Eximbank (Tanzania) Ltd 699
FBN Bank Ghana 624
FBN Mobile 201
Fet 609
Fidelity Bank 275
Fidelity Bank Plc 202
Fidelity Mobile 592
Fina Bank Limited 243
Finance Trust Bank Ltd 655
First Atlantic Merchant 622
First Bank Plc 203
First Capital Plus Bank 630
First City Monument Bank Ltd 204
First National Bank 272
First National Bank Of Tanzania 663
Fortis Microfinance Bank 596
Fortismobile 582
FSDH 607
GCB Bank Limited 259
GN Bank Limited 631
GTBank Mobile Money 205
GTBank Plc 206
Guaranty Trust Bank 267
Guardian Bank Limited 245
Habib African Bank 676
Hedonmark 589
Heritage Bank 207
HFC Bank 262
Housing Finance Bank Ltd 653
I&M Bank (T) Ltd 680
I&M Bank Limited 246
Imperial Bank Limited 236
Imperial Homes Mortgage Bank 601
Intercontinental Bank Plc 627
International Commercial Bank (Tanzania) Ltd 678
Jaiz Bank 591
Jamii Bora Bank 242
Jubilee Life Mortgage Bank 605
KCB Bank Tanzania Limited 688
KCB Bank Uganda Limited 657
Kenya Commercial Bank Limited 253
Keystone Bank Limited 208
Kilimanjaro Co-Operative Bank Ltd 700
K-Rep Bank Limited 250
M&F bank 581
Maendeleo Bank Ltd 683
Middle East Bank Kenya Limited 230
Mkombozi Commercial Bank Ltd 670
Mkudi 608
Moneybox 590
M-Pesa 640
MTN Mobile Money 611
Mwanga Community Bank Ltd 672
National Bank Of Commerce 701
National Bank Of Kenya Limited 227
National Investment Bank 260
NC Bank Uganda Limited 645
NIC Bank (Tanzania) Limited 666
NIC Bank Limited 237
NIP Virtual Bank 594
NMB Bank Plc 692
NPF Microfinance Bank 602
Omnibank Ghana Ltd 634
Omoluabi Mortgage Bank 585
Orient Bank Ltd 644
Oriental Commercial Bank Limited 228
Pagatech 606
Paramount Universal Bank Limited 241
Parkway 209
Parralex Bank 224
Payattitude Online 597
Paycom 210
People`s Bank Of Zanzibar 685
Premium Bank 633
Prime Bank Limited 225
Prudential Bank Ltd 623
Royal Bank 271
Safetrust Mortgage Bank 599
SG-SSB Ltd 619
Skye Bank Plc 211
Sovereign Bank 632
Stanbic Bank 266
Stanbic Bank Tanzania Limited 675
Stanbic Bank Uganda Limited 658
Stanbic Ibtc Bank Plc 212
Stanbic Mobile 213
Standard Chartered Bank 258
Standard Chartered Bank Nigeria Limited 214
Standard Chartered Bank Tanzania Ltd 686
Standard Chartered Bank Uganda Limited 661
Sterling Bank Plc 215
Sterling Mobile 584
Suntrust Bank 603
Tagpay 583
Teasymobile 593
Tigo Mobile Money 612
Trans-National Bank Limited 232
Tropical Bank 648
Trust Bank Limited 620
Trustbond 610
UBA Kenya Bank Limited 252
UBL Bank (Tanzania) Limited 682
Uchumi Commercial Bank Ltd 698
Unibank Limited (Ghana) 626
Union Bank Of Nigeria Plc 216
United Bank For Africa 268
United Bank For Africa (Tanzania) Limited 668
United Bank For Africa Plc 217
United Bank For Africa Uganda Limited 650
Unity Bank Plc 218
Universal Merchant Bank 261
UT Bank 621
Victoria Commercial Bank Ltd 244
Vodafone Mobile Money 613
Vtnetworks 595
Wema Bank Plc 219
Zenith Bank 263
Zenith Bank Plc 220
Zenith Mobile 221

Детальные сведения о том, что необходимо делать со стороны мерчанта для проведения платежей, а также о том, что можно использовать для анализа информации о проведённых платежах и операциях, представлены далее.

Выплаты через Gate

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

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



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

  1. От веб-сервиса на заданный URL ECommPay передаётся запрос на проведение выплаты через Gate.
  2. Запрос на проведение выплаты поступает в платёжную платформу.
  3. Выполняется начальная обработка запроса, в рамках которой обеспечивается проверка наличия обязательных параметров и корректной подписи.
  4. От платёжной платформы к веб-сервису направляется ответ с информацией о получении запроса и его корректности. Подробнее см. в разделе Формат ответа.
  5. В платёжной платформе выполняются дальнейшая обработка запроса и его отправка в сервис African Banks.
  6. На стороне African Banks выполняется обработка платежа.
  7. От African Banks к платёжной платформе направляется оповещение о результате.
  8. От платёжной платформы к веб-сервису направляется оповещение о результате.
  9. От веб-сервиса пользователю направляется результат выплаты.

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

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

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

  1. Должен использоваться запрос /v2/payment/banks/africa/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 — фамилия;
    • account — объект, содержащий сведения о счёте пользователя:
      • bank_id — идентификатор банка;
      • number — номер счёта;
  3. Валютой платежа может быть только GHS, KES, NGN, TZS, UGX, ZAR, XOF.
  4. Дополнительно могут использоваться любые другие параметры, указанные в спецификации.

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

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

{
    "general": {
        "project_id": 2990,
        "payment_id": "test-002",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7aRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 10000,
      "currency": "XOF"
      },
    "customer": {
      "id": "2901",
      "ip_address": "104.164.142.205"
      "first_name": "Mary"
      "last_name": "Johnson"
    },
    "account":{
      "bank_id": 300,
      "number": "1543647567",
    }
}

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

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

В следующем примере оповещение свидетельствует о том, что в рамках проекта 2990 для пользователя user45 была успешно проведена выплата в размере 100,00 XOF со счёта № 1543647567 банка.

Рис.: Пример оповещения о проведенной выплате

{
        "project_id": 2990,
        "payment": {
            "id": "payout-1",
            "type": "payout",
            "status": "success",
            "date": "2019-02-15T06:52:42+0000",
            "method": "africa",
            "sum": {
                "amount": 10000,
                "currency": "XOF"
            },
            "description": "payout"
        },
        "account": {
            "bank_id": " "
            "number": "1543647567"
        },
        "customer": {        
            "ip_address": "104.164.142.205"
            "first_name": "Mary"
            "last_name": "Johnson"
            "id": "2901"
        },
        "operation": {
            "id": 3950000003219,
            "type": "payout",
            "status": "success",
            "date": "2019-02-15T06:52:42+0000",
            "created_date": "2019-02-15T06:48:39+0000",
            "request_id": "b8dcdecbdd842017c91efd752a71a2afa790884b
                            -70151ed2a85d685602a73045c2e07fdbf027182a",
            "sum_initial": {
                "amount": 10000,
                "currency": "XOF"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "XOF"
            },
            "provider": {
                "id": 1150,
                "payment_id": "53313",
                "date": "2019-02-15T06:48:40+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Qg9YTDQhe6VG4O9WtvtW4VqQRfWVb/iDs4z8TKuYGq1DA3sFCtB
                                  wKCxWXSjytuX+FpBqAiomhYD1GBGzo3HG1w=="
    }

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

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

{
        "project_id": 2990,
        "payment": {
            "id": "payout-2",
            "type": "payout",
            "status": "decline",
            "date": "2019-02-15T06:42:42+0000",
            "method": "africa",
            "sum": {
                "amount": 9000,
                "currency": "XOF"
            },
            "description": "payout"
        },
        "account": {
            "bank_id": " "
            "number": "1543647567"
        },
        "customer": {        
            "ip_address": "104.164.142.205"
            "first_name": "Susan"
            "last_name": "Johnson"
            "id": "2902"
        },
        "operation": {
            "id": 3950000003224,
            "type": "payout",
            "status": "decline",
            "date": "2019-02-15T06:42:42+0000",
            "created_date": "2019-02-15T06:38:39+0000",
            "request_id": "b8dcdecbdd842017c91efd752a71a2afa790884b
                            -70151ed2a85d685602a73045c2e07fdbf027182b",
            "sum_initial": {
                "amount": 9000,
                "currency": "XOF"
            },
            "sum_converted": {
                "amount": 9000,
                "currency": "XOF"
            },
            "provider": {
                "id": 1150,
                "payment_id": "53314",
                "date": "2019-02-15T06:42:40+0000",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "Qg9YTDQhe6VG4O9WtvtW4VqQRfWVb/iDs4z8TKuYGq1DA3sFCtBwKCxWXSjytuX+FpBqAiomhYD1GBGzo3HG1w=="
    }

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

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

Анализ результатов проведения платежей

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

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

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

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

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