Payment Methods

{
  "status_code": 200,
  "response_type": "success",
  "data": [
    {
      "id": "paveway_mobile_money",
      "name": "Mobile Money",
      "active": true,
      "fee_type": "percentage",
      "supported_countries": ["CM"]
    },
    {
      "id": "paveway_card",
      "name": "Credit/Debit Card",
      "active": true,
      "fee_type": "percentage",
      "supported_countries": ["CM"]
    }
  ],
  "message": "Successfully fetched payment methods"
}

The Payment Methods API allows you to programmatically determine which payment options (Mobile Money, Cards, etc.) are available for a specific region and calculate the exact fees associated with a transaction.

List Available Methods

Retrieve active payment methods supported for a specific country.

API Endpoint

GET /payment-methods

Query Parameters

country_code

string

default:"CM"

The two-letter ISO country code (e.g., CM, CI, SN, GH). This filters the methods to those available in the specified region.

Response

{
  "status_code": 200,
  "response_type": "success",
  "data": [
    {
      "id": "paveway_mobile_money",
      "name": "Mobile Money",
      "active": true,
      "fee_type": "percentage",
      "supported_countries": ["CM"]
    },
    {
      "id": "paveway_card",
      "name": "Credit/Debit Card",
      "active": true,
      "fee_type": "percentage",
      "supported_countries": ["CM"]
    }
  ],
  "message": "Successfully fetched payment methods"
}

Calculate Transaction Fees

Get a detailed breakdown of the fees for a specific amount, currency, and payment method.

API Endpoint

GET /payment-methods/fee/{payment_method}/{currency}/{amount}

Path Parameters

payment_method

string

required

The code of the payment method (e.g., mobile_money, card).

currency

string

required

Three-letter ISO currency code (e.g., XAF, USD).

amount

number

required

The transaction amount.

Query Parameters

country_code

string

ISO country code where the transaction is taking place. This can affect local vs. international fee rules.

card_type

string

default:"local"

For card payments, specify if the card is local or international.

Response

{
  "status_code": 200,
  "response_type": "success",
  "data": {
    "amount": 10000,
    "currency": "XAF",
    "fee": 150,
    "total_payable": 10150
  },
  "message": "Successfully calculated fees"
}

Check Payment Status Retrieve a Transaction

Payments API

Customers

Sessions

Subscriptions API

Financial Services API

Webhooks

List Available Methods

API Endpoint

Query Parameters

Response

Calculate Transaction Fees

API Endpoint

Path Parameters

Query Parameters

Response

​List Available Methods

​API Endpoint

​Query Parameters

​Response

​Calculate Transaction Fees

​API Endpoint

​Path Parameters

​Query Parameters

​Response

List Available Methods

API Endpoint

Query Parameters

Response

Calculate Transaction Fees

API Endpoint

Path Parameters

Query Parameters

Response