This package was not developed, owned or maintained by Azam Pay Development Team The package was created as a open source project for Golang developers who are looking to consume Azam Pay API's.
AzamPay is specialized in the development of end-to-end online payment management solutions for companies operating in East Africa. Our range of digital solutions and services are carefully designed not only to streamline your payment and collection processes, but to also allow easy integration with your current Accounting or Enterprise Resource Planning (ERP) systems thus leaving you time to focus on your customers. AzamPay offers bespoke solutions that guarantee optimal business performance and efficiency whether you are transacting locally, regionally, or internationally.
Install package by go get github.com/elirehema/azampay. Import the azampay package on your import statement:
import "github.com/elirehema/azampay"Download and modify the .env file with the Azam Client information provided in you Azam Mechant application. Put the .env file in the root directory of your golang app. With right information provided in .env file the package will take care or creating and generating the access token required to access the Azampay public endpoints.
Your .env file will looks like this
# AZAMPAY CLIENT
APP_NAME={{YOUR-APPLICATION-NAME}}
BASE_URL=https://sandbox.azampay.co.tz
AUTHENTICATOR_URL=https://authenticator-sandbox.azampay.co.tz
CLIENT_ID={{YOUR-CLIENT-ID}}
CLIENT_SECRET={{YOUR-CLIENT-SECRET}}
CLIENT_TOKEN={{YOUR-CLIENT-TOKEN}}
This function will return the registered partners of provided mechant informations
import "github.com/elirehema/azampay"
func RetrieveRegisteredPartners(){
clients := azampay.GetPaymentPartners()
print(clients)
}This will return array list of partners of azampay.datas.PaymentPartner struct
Sample Response example
[
{
"id": "6ebafc56-6d4d-4265-a8d4-c0e1e7806c19",
"logoUrl": "https://azampay-sarafutest.s3.eu-central-1.amazonaws.com/azampesa.png",
"partnerName": "Azampesa",
"provider": 5,
"vendorName": "your@mechane.email_com",
"paymentVendorId": "your-payment-vendor-id",
"paymentPartnerId": "08d997ae-1961-4c32-8b2f-e00f53003b00",
"paymentAcknowledgmentRoute": "https://your/callback/endpoint",
"currency": "TZS",
"status": "1",
"vendorType": "seller"
},
{
"id": "bbb6121c-b158-4078-aa09-67a584100746",
"logoUrl": "https://pg-vnext-banners.s3.eu-central-1.amazonaws.com/vnext-images/pgvnext-payment-images/halopesa.svg",
"partnerName": "HaloPesa",
"provider": 4,
"vendorName": "your@mechane.email_com",
"paymentVendorId": "your-payment-vendor-id",
"paymentPartnerId": "08d99549-2d49-4694-8320-f60b4e76be6a",
"paymentAcknowledgmentRoute": "https://your/callback/endpoint",
"currency": "TZS",
"status": "1",
"vendorType": "seller"
},
{
"id": "bf61faec-1421-4e93-bc5b-41090fde3aa9",
"logoUrl": "https://pg-vnext-banners.s3.eu-central-1.amazonaws.com/vnext-images/pgvnext-payment-images/tigopesa.svg",
"partnerName": "Tigopesa",
"provider": 3,
"vendorName": "your@mechane.email_com",
"paymentVendorId": "your-payment-vendor-id",
"paymentPartnerId": "8f2b5341-78c1-4aa2-a8a4-0e1fbe263f1c",
"paymentAcknowledgmentRoute": "https://your/callback/endpoint",
"currency": "TZS",
"status": "1",
"vendorType": "seller"
},
{
"id": "e21d2941-804f-42e6-a547-66bbbfc7d533",
"logoUrl": "https://pg-vnext-banners.s3.eu-central-1.amazonaws.com/vnext-images/pgvnext-payment-images/airtel.svg",
"partnerName": "Airtel",
"provider": 2,
"vendorName": "your@mechane.email_com",
"paymentVendorId": "your-payment-vendor-id",
"paymentPartnerId": "08d9945a-c9df-4834-876e-04b2df375d8e",
"paymentAcknowledgmentRoute": "https://your/callback/endpoint",
"currency": "TZS",
"status": "1",
"vendorType": "seller"
}
]The function checkout and make payment to requested MNO Provider.
It accept datas.CheckoutRequest and return datas.TransactionResponse. For MNO Checkout OneTimePassword,Account Number and MechantName are optional (i.e they add no changes with MNO Checkout)
import (
"github.com/elirehema/azampay"
"github.com/elirehema/azampay/datas"
)
func RequestPaymentFromMNO() {
mnoCheckoutRequest := datas.CheckoutRequest{
CurrencyCode: "TZS",
Provider: "Tigo",
ExternalId: "08d99549-2d49-4694-8320-f60b4e76be6a",
Amount: "200",
AccountNumber:"255716000000",
Properties: &datas.Properties{
PropertyOne: "John Doe",
PropertyTwo: "255742000000",
},
}
response := azampay.MNOCheckout(mnoCheckoutRequest)
print(response)
}By the time of creating this package there were the list of supported providers "Airtel" "Tigo" "Halopesa" "Azampesa" "Mpesa". You can refer to Azampay Documentation for more clients. The package can accept new providers if any.
{
"success": true,
"transactionId": "49fc49562d84436cbdcce67c229fd99c",
"message": "Your request has been received and is being processed."
}Bank Checkout us the same flow as MNO Checkout but for bank checkout all fields are Mandatory. It accept CheckoutRequest and Return TransactionResponse structs.
Example
import (
"github.com/elirehema/azampay"
"github.com/elirehema/azampay/datas"
)
func RequestPaymentFromMNO() {
mnoCheckoutRequest := datas.CheckoutRequest{
AccountNumber:"0552000000000",
OneTimePassword: 12345,
MechantName: "Azam Pay Go Client".
CurrencyCode: "TZS",
Provider: "Tigo",
ExternalId: "08d99549-2d49-4694-8320-f60b4e76be6a",
Amount: "200",
AccountNumber: "255716000000",
Properties: &datas.Properties{
PropertyOne: "John Doe",
PropertyTwo: "255742000000",
},
}
response := azampay.BankCheckout(mnoCheckoutRequest)
print(response)
}The function return TransactionResponse struct but now with additional field data
{
"success": true,
"msg": "",
"data": {
"properties": {
"ReferenceID": "ac8232323cb74110a8a26c4368eaf5ba"
}
}
}This function excute Post Checkout in Azampay endpoint and returns back to you a URL to proceed with payment on web app. On payment confirmation Azampay will send notification to mechant app callback url if provided