Telenor API Gateway Developer’s Guide

[Pages:250]Telenor API Gateway Developer's Guide

Telenor Microfinance Bank

Telenor API Gateway Developer's Guide

Telenor API Gateway Developer's Guide

Document Version

Version 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0 1.1 1.2 1.3 1.4 1.5 1.6

Date 08-04-2021 15-04-2021 22-04-2021 06-05-2021 17-05-2021 24-05-2021 08-06-2021 11-06-2021 21-06-2021 09-07-2021 15-07-2021 01-09-2021 22-09-2021 08-12-2021 25-01-2022 03-02-2022

2

Telenor API Gateway Developer's Guide

Table Of Contents

Introduction to API Gateways ............................................................................................................................7 Why We Need API Gateway ...........................................................................................................................7 Resolution ....................................................................................................................................................... 8

Overview of the API Developer's guide..............................................................................................................9 Intended Audience of the document ...............................................................................................................10 TMB Open API platform ...................................................................................................................................10

Components of TMB Open API Platform......................................................................................................10 Getting Started .................................................................................................................................................11 Requesting Staging Inventory for Testing ........................................................................................................13 Utilities..............................................................................................................................................................14

Get Banks List ...............................................................................................................................................14 Get Billing Companies List ............................................................................................................................17 Get Loan Companies.....................................................................................................................................20 Get Fee Companies.......................................................................................................................................23 BVS Login ..........................................................................................................................................................26 BVS OTP Generation .....................................................................................................................................26 BVS Login ......................................................................................................................................................29 Login .................................................................................................................................................................32 Encryption Guidelines...................................................................................................................................32 Obtaining RSA Public Key .............................................................................................................................32 Token Generation for Login..........................................................................................................................34 Login Page.....................................................................................................................................................36 Use cases ..........................................................................................................................................................39 Subscriber IBFT .................................................................................................................................................39 Subscriber IBFT Inquiry.................................................................................................................................39 Subscriber IBFT Transfer...............................................................................................................................44 Subscriber IBFT OTP..........................................................................................................................................48 Subscriber IBFT Inquiry OTP .........................................................................................................................48 Subscriber IBFT Transfer OTP .......................................................................................................................58 Bill Payments ....................................................................................................................................................64 Subscriber Utility Bill Inquiry ........................................................................................................................64 Subscriber Utility Bill Payment .....................................................................................................................68 Easypaisa Account Registration........................................................................................................................72

3

Telenor API Gateway Developer's Guide

Subscriber New Account Registration ..........................................................................................................72 Money Transfer (P2P).......................................................................................................................................76

Mobile Account to Mobile Account Inquiry .................................................................................................76 Mobile Account to Mobile Account Transfer ...............................................................................................80 Money Transfer (P2P) OTP ...............................................................................................................................85 Mobile Account to Mobile Account Inquiry OTP..........................................................................................85 Mobile Account to Mobile Account Transfer OTP........................................................................................92 Money Transfer To CNIC...................................................................................................................................98 Mobile Account to CNIC Inquiry ...................................................................................................................98 Mobile Account to CNIC Transfer ...............................................................................................................101 Money Transfer To CNIC OTP .........................................................................................................................104 Mobile Account to CNIC Inquiry OTP .........................................................................................................104 Mobile Account to CNIC Transfer OTP .......................................................................................................110 Cash Deposit - Non BVS ..................................................................................................................................114 Retailer Cash Deposit .................................................................................................................................114 Cash Withdrawal - Non BVS ...........................................................................................................................118 Retailer Cash Withdrawal ...........................................................................................................................118 Retailer Bill Payments.....................................................................................................................................122 OTC Bill Inquiry ...........................................................................................................................................122 OTC Bill Payment ........................................................................................................................................127 Retailer IBFT Transfer .....................................................................................................................................131 OTC IBFT Inquiry .........................................................................................................................................131 OTC IBFT Transfer .......................................................................................................................................136 Easypaisa Account Registration - BVS ............................................................................................................141 Easypaisa Account Registration BVS...........................................................................................................141 Easypaisa Account Registration BVS OTP ...................................................................................................147 Easypaisa Account Registration ? Non BVS ....................................................................................................155 Easypaisa Account Registration Non BVS ...................................................................................................155 Easypaisa Account Registration Non BVS OTP ...........................................................................................160 Cash Deposit - BVS..........................................................................................................................................165 Cash Deposit (BVS) .....................................................................................................................................165 Cash Deposit (BVS) Confirmation ...............................................................................................................171 Cash Withdrawal - BVS ...................................................................................................................................177 Cash Withdrawal (BVS)...............................................................................................................................177

4

Telenor API Gateway Developer's Guide

Cash Withdrawal (BVS) Confirmation.........................................................................................................183 CNIC to CNIC Sending (MTS + Agent Assisted) ...............................................................................................189

OTC Send Money CNIC to CNIC ..................................................................................................................189 OTC Send Money CNIC to CNIC OTP T&C ...................................................................................................195 CNIC to CNIC Receiving (MTS + Agent Assisted + MA - OTC Receiving) .........................................................201 OTC Receive Money CNIC to CNIC..............................................................................................................201 OTC Receive Money CNIC to CNIC OTP T&C...............................................................................................207 Payment Solutions..........................................................................................................................................212 Encryption Guidelines.................................................................................................................................212

................................................................................................................................................................213 Generate QR RSA API..................................................................................................................................215 Initiate MA Transaction ..............................................................................................................................220 Reversal RSA ...............................................................................................................................................224 Inquire Transaction.....................................................................................................................................228 Pinless Mobile Account Payment ...................................................................................................................232

............................................................................................................................................................232 Pinless Payment - Generate OTP API..........................................................................................................235 Pinless Payment - Initiate Link Transaction API..........................................................................................239 Pinless Payment - Initiate Pinless Transaction ...........................................................................................243 Pinless Payment ? Deactivate Link .............................................................................................................247

5

Telenor API Gateway Developer's Guide

Table Of Figures

Figure 1: Accessing Microservices through direct call.................................................................................. 7 Figure 2: Accessing Microservice through API Gateway .............................................................................. 8 Figure 3: TMB Open API Platform ................................................................................................................ 9 Figure 4: API Open Platform ....................................................................................................................... 11 Figure 5: Subscriber IBFT Inquiry....................................................................Error! Bookmark not defined. Figure 6: Subscriber IBFT Transfer..................................................................Error! Bookmark not defined. Figure 7: Subscriber Utility Bill Inquiry ....................................................................................................... 64 Figure 8: Subscriber Utility Bill Payment .................................................................................................... 68 Figure 9: Subscriber New Account Registration ......................................................................................... 72 Figure 10: Mobile Account to Mobile Account Inquiry .............................................................................. 76 Figure 11: Mobile Account to Mobile Account Transfer ............................................................................ 80 Figure 12: Retailer Cash Deposit .............................................................................................................. 114 Figure 13: Retailer Cash withdrawal......................................................................................................... 118 Figure 14: OTC Bill Inquiry ........................................................................................................................ 122 Figure 15: OTC Bill Payment ..................................................................................................................... 127 Figure 16: OTC IBFT Inquiry ...................................................................................................................... 131 Figure 17: OTC IBFT Transfer .................................................................................................................... 136 Figure 18: Easypaisa Account Registration BVS ....................................................................................... 141 Figure 19: Easypaisa Account Registration BVS OTP ................................................................................ 148 Figure 20: Easypaisa Account Registration Non BVS................................................................................ 155 Figure 21: Cash Deposit (BVS) .................................................................................................................. 165 Figure 22: Cash Withdrawal (BVS) ............................................................................................................ 177 Figure 23: OTC Send Money CNIC to CNIC ............................................................................................... 189 Figure 24: OTC Receive Money CNIC to CNIC........................................................................................... 201

6

Telenor API Gateway Developer's Guide

Introduction to API Gateways

An API Gateway is an API management server that has information about endpoints. It is also capable of performing authentication, rate limiting, load balancing, and more. An API Gateway is an important concept in micro services architecture. It acts an entry point for external clients (that is not part of the micro service system) and application.

Why We Need API Gateway

Consider a case study of a complex page (Product page) of an e-commerce application. If we look at the below page of Amazon product listing, we can see a lot of information needed to be rendered by this specific page. As all micro services have been deployed separately on a different server, if a client wants to access these services, at least seven (7) calls have to be requested for a single page.

Figure 1: Accessing Microservices through direct call

Seven different calls will be made for calling serviced. Performance, resource consumption and load time will be affected. The clients are closely coupled with all the services, and if Reviews and rating micro services are separated in two different services, the client code needs to be updated. One call will be made to get reviews, and other to get ratings, which will affect the performance and load time.

7

Telenor API Gateway Developer's Guide

Resolution

The recommended solution and approach to avoid multiple call is an API Gateway. An API Gateway acts a layer between the Client and micro services. It is front-facing service for all of the micro services. Any client who wants to access the micro services, will only call API gateway. API Gateway further makes a call to the required micro services and gets the response. This process is called API Composition.

Figure 2: Accessing Microservice through API Gateway

8

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download