Skip to main content

Get Products API

Retrieves a list of available payment products and their associated fees.

  • URL: /v1/payment/products

  • Method: GET

  • Auth Required: Yes

  • Success Response:

    {
      "status": 404,
      "message": "products",
      "data": [
          {
              "product_id": 10011,
              "product_name": "Mobile Money push",
              "product_code": "MOBILE_MONEY",
              "transaction_type": "PUSH",
              "status": "active",
              "currency": "UGX",
              "fee_type": "FLAT",
              "fee_amount": 2000,
              "created_at": "2025-02-17T12:31:44.000Z"
          },
          {
              "product_id": 10012,
              "product_name": "Mobile Money pull",
              "product_code": "MOBILE_MONEY",
              "transaction_type": "PULL",
              "status": "active",
              "currency": "UGX",
              "fee_type": "PERCENTAGE",
              "fee_amount": 2,
              "created_at": "2025-02-17T12:31:44.000Z"
          }
      ]
    }

  • Error Response:

    {
      "status": 400,
      "message": "Failed to fetch products",
      "data": null
    }

Response Fields​

  • product_id: Unique identifier for the product
  • product_name: Human-readable name of the product
  • product_code: Product code identifier (e.g., MOBILE_MONEY)
  • transaction_type: Type of transaction (PUSH or PULL)
  • status: Product status (active, inactive)
  • currency: Currency code for the product
  • fee_type: Type of fee calculation (FLAT or PERCENTAGE)
  • fee_amount: Fee amount (flat rate or percentage value)
  • created_at: Product creation timestamp in ISO format

Transaction Types​

The API supports the following transaction types:

  • PUSH: Outgoing payment (sending money)
  • PULL: Incoming payment/collection (receiving money)

Fee Types​

Two types of fee calculations are supported:

  • FLAT: A fixed amount charged per transaction
  • PERCENTAGE: A percentage of the transaction amount

For example:

  • If fee_type is "FLAT" and fee_amount is 2000, a flat fee of 2000 currency units is charged
  • If fee_type is "PERCENTAGE" and fee_amount is 2, a 2% fee of the transaction amount is charged

Support​

For API support, please contact: