Package: azampay
azampayPython Wrapper to Azampay Payment GatewayAzampay API FlowAll Azampay APIs follow two step process:Step 1: Get token against the application authentication credentials.
Step 2: Consume the actual api by providing x-api-key header and token acquired in step 1.
Following diagram shows the general flow on how to consume the Azampay api.Getting StartedTo get started with Azampay, you need to install the azampay package. You can either do it manually or use pip to install it.Manual Installation$gitclonehttps://github.com/Neurotech-HQ/azampay
$cdazampay
$sudopythonsetup.pyinstallUsing pip$pipinstallazampayAuthenticationAzampay offers two forms of authentication:API KeyBearer Auth - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.
API-Key is the key that is provided in the http request header. Key Name is X-API-KEY.Bearer Tokenis the JWT token that you get against your application Name, Client Id and Client Secret. For Sanbox Environment, You can get these application credentials fromSandbox portal. For production environment, you will be provided these keys after you submit your business KYC to Azampay from Sandbox portal.AzampayPackage handles the authentication for you. You just need to provide it with its credentials and it will do the rest. Here is the example of how to use it.>>>fromazampayimportAzampay>>>azampay=Azampay(app_name='<app_name'>,client_id='<client_id>',client_secret='<client_secret>',x_api_key='<x_api_key>',sandbox=True)Note: When you want to use the package in production environment, No need to specify the X-API-Key.>>>fromazampayimportAzampay>>>azampay=Azampay(app_name='<app_name>',client_id='<client_id>',client_secret='<client_secret>',sandbox=False)CheckoutAzampay offers two types of checkout:Mobile Checkout - for mobile checkout (Tigopesa, AirtelMoney, Mpesa)Bank Checkout - for bank checkout (CRDB, NMB)Mobile CheckoutHere is the example of how to use the mobile checkout.>>>fromazampayimportAzampay>>>azampay=Azampay(app_name='<app_name>',client_id='<client_id>',client_secret='<client_secret>',x_api_key='<x_api_key>',sandbox=True)>>>checkout_response=azampay.mobile_checkout(amount=100,mobile='<mobile>',external_id='<external_id>',provider='<provider>')Bank CheckoutHere is the example of how to use the bank checkout.>>>fromazampayimportAzampay>>>azampay=Azampay(app_name='<app_name>',client_id='<client_id>',client_secret='<client_secret>',x_api_key='<x_api_key>',sandbox=True)>>>checkout_response=azampay.bank_checkout(amount=100,merchant_account_number='<merchant_account_number>',merchant_mobile_number='<merchant_mobile_number>',reference_id='<external_id>',provider='<provider>')Generate Payment LinkHere is the example of how to use the generate payment link.>>>fromazampayimportAzampay>>>azampay=Azampay(...app_name='<app_name>',...client_id='<client_id>',...client_secret='<client_secret>',...x_api_key='<x_api_key>',...sandbox=True)>>>payment_link=azampay.generate_payment_link(amount='<amount>',external_id='<external_id>',provider='<provider>')>>>payment_link=azampay.generate_payment_link(amount='5000',external_id='12345343',provider='Airtel')['data']CallbackNow that you already know to initiate payments with Azampay package, Let's get started with the callback.Note: You will need to have a webhook endpoint set up on your application to receive the callback from Azampay.I have added a starterFastAPI webhook endpointto this repository. You can either use it or set up your own.Webhook DataHere an example of the webhook data that you will receive from Azampay.{"msisdn":"0178823","amount":"2000","message":"any message","utilityref":"1292-123","operator":"Tigo","reference":"123-123","transactionstatus":"success","submerchantAcc":"01723113",}IssuesIf you will face any issue with the usage of this package please raise one so as we can quickly fix it as soon as possible;ContributingThis is an opensource project underMIT Licenseso any one is welcome to contribute from typo, to source code to documentation,JUST FORK IT.RelatedPython-DPOPypesaTigopesaAll the creditkalebuAll other contributors