latestOpenAPI 3.0.02026-08-1071532.8 KB

cfd1b00f674f

DATA

get/data/payment-providers

Query parameters

currencystring required
transaction_typestring required

Headers

public-keystring required
x-api-versionnumber required
Accept-Language'en' | 'fr' | 'sw' required

Response

Payment providers retrieved successfully.

codenumber required

HTTP Status code

status'success' | 'accepted' | 'error' required

The status of the response

messagestring required

The message of the response

dataobject required

Response data

Example response

{
  "code": 200,
  "status": "success",
  "message": "Request completed successfully",
  "data": {
    "payment_providers": [
      {
        "provider_name": "MTN Mobile Money Zambia",
        "provider_code": "mtn_zm",
        "transaction_method": "MOBILE_MONEY",
        "transaction_method_name": "Mobile Money",
        "transaction_type": "Collection",
        "transaction_currency": "ZMW",
        "min_amount": 1,
        "max_amount": 10000,
        "max_daily_amount": 100000,
        "is_active": true,
        "option_prefixes": [
          "76",
          "96"
        ]
      },
      {
        "provider_name": "Airtel Money Zambia",
        "provider_code": "airtel_zm",
        "transaction_method": "MOBILE_MONEY",
        "transaction_method_name": "Mobile Money",
        "transaction_type": "Collection",
        "transaction_currency": "ZMW",
        "min_amount": 1,
        "max_amount": 10000,
        "max_daily_amount": 100000,
        "is_active": true,
        "option_prefixes": [
          "57",
          "77",
          "97"
        ]
      }
    ]
  }
}