Payment Apps

Payment Apps are the core configuration entities in the Salami Payments module. Each app binds a payment provider driver to a set of credentials and settings.

List Payment Apps

Retrieve all payment apps belonging to the authenticated user.

GET /api/pay/apps

Authentication

Requires Bearer token.

Response

{
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "name": "My M-Pesa STK",
        "type": "MpesaKeExpress",
        "is_live": false,
        "dedicated": true,
        "parent_app_id": null,
        "created_by": 1,
        "updated_by": 1,
        "created_at": "2026-01-15T10:30:00.000000Z",
        "updated_at": "2026-01-15T10:30:00.000000Z"
      },
      {
        "id": 2,
        "name": "B2C Disbursements",
        "type": "MpesaKeB2C",
        "is_live": true,
        "dedicated": true,
        "parent_app_id": null,
        "created_by": 1,
        "updated_by": 1,
        "created_at": "2026-02-01T08:00:00.000000Z",
        "updated_at": "2026-02-01T08:00:00.000000Z"
      }
    ],
    "per_page": 15,
    "total": 2
  }
}

Response Fields

Status Codes

Creating Payment Apps

Payment Apps are created through the Salami web dashboard. Navigate to Payments > Apps > Create New App.

Required Fields (All Providers)

Driver Types and Configuration Fields

M-Pesa Express (STK Push) -- MpesaKeExpress

M-Pesa C2B -- MpesaKeC2B

M-Pesa B2C -- MpesaKeB2C

M-Pesa B2B -- MpesaKeB2B

Airtel Kenya -- AirtelKe

Equity Bank Kenya -- EquityBankKe

PayPal IPN -- PaypalIPN

Pesalink Kenya -- PesalinkKe

Kopokopo -- Kopokopo

Shared vs Dedicated Apps

Payment Apps can be either dedicated or shared:

• Dedicated: The app has its own credentials and operates independently.
• Shared: The app references a parent app (parent_app_id) and shares its credentials. Useful when multiple users or services need to receive callbacks for the same paybill.

Checking App Type

dedicated = true  --> Dedicated app (standalone)
dedicated = false AND parent_app_id != null --> Shared app (inherits from parent)

Related Documentation

• Payments API Overview
• Transactions
• Callbacks
• M-Pesa Guide