search

Payment Options

Before any transaction request is performed, it's recommended that the list of payment options is retrieved to obtain some of the required parameters/

The API description below shows how the list of payment options can be obtained. The request requires that the merchant filters by country and transaction type to get the appropriate list of the payment options.

hashtag
Get Payment Options List

GET https://gwapisdbx.govbill.ug/data/payment-providers

Returns the list of payment options based on currency and transaction type

hashtag
Query Parameters

Name
Type
Description

currency*

String

The 3 character ISO currency code e.g. UGX

transaction_type*

String

The transaction type. Allowed types at the moment are; COLLECTION

hashtag
Headers

Name
Type
Description

public-key*

String

The Public Key as shared in the approval email

{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": {
        "payment_providers": [
            {
                "provider_name": "MTN Mobile Money Uganda",
                "provider_code": "mtn_momo_ug",
                "transaction_method": "MOBILE_MONEY",
                "transaction_method_name": "Mobile Money",
                "transaction_type": "Collection",
                "transaction_currency": "UGX",
                "min_amount": 500,
                "max_amount": 3000000,
                "max_daily_amount": 7000000,
                "is_active": true,
                "option_prefixes": [
                    "77",
                    "78",
                    "76",
                    "39"
                ]
            },
            {
                "provider_name": "Airtel Money Uganda",
                "provider_code": "airtel_money_ug",
                "transaction_method": "MOBILE_MONEY",
                "transaction_method_name": "Mobile Money",
                "transaction_type": "Collection",
                "transaction_currency": "UGX",
                "min_amount": 500,
                "max_amount": 3000000,
                "max_daily_amount": 7000000,
                "is_active": true,
                "option_prefixes": [
                    "74",
                    "75",
                    "70"
                ]
            }
        ]
    }
}
Parameter
Type
Description

provider_code

string

The unique code for the payment option. It is required for the transaction requests

provider_name

string

The name of the option

transaction_type

string

The transaction type

transaction_method

string

The transaction method code supported by this option

transaction_method_name

string

The name of the transaction method

transaction_currency

string

The currency in which the option transacts

country_code

string

The 2 character ISO country code

min_amount

float

The minimum amount allowed when using this option

max_amount

float

The maximum amount allowed when using this option

max_daily_amount

float

The maximum amount a single account can transact in a 24hr period

option_prefixes

array

String prefixes that validate the phone numbers. Applies to mobile money options

PreviousBalance InquiryNextHandling Notifications/Callbacks

Last updated