Get available payment methods

Retrieve all configured payment methods for the store, including their supported currencies, integration types, and environment status.

Supported Providers:

• Cash: Manual payment method
• Bank Transfer: Manual payment method
• Stripe: Card payments with redirect to Stripe Checkout
• Paystack: Card payments with popup integration (Africa-focused)
• M-Pesa: Mobile money STK Push (Kenya)
• Airtel Money: Mobile money collection (Kenya, Uganda, Tanzania, Rwanda)

Key Type Support:

• ✅ Secret keys (full access)
• ✅ Publishable keys (read-only)

GET /v1/payments/methods

Get available payment methods

cURL

curl --request GET \
  --url https://api.tybritelabs.com/v1/payments/methods \
  --header 'Authorization: Bearer <token>'

200

{
  "methods": [
    {
      "provider": "stripe",
      "display_name": "Card (Stripe)",
      "type": "redirect",
      "supported_currencies": [
        "usd"
      ],
      "environment": "test",
      "is_configured": true
    },
    {
      "provider": "paystack",
      "display_name": "Card (Paystack)",
      "type": "popup",
      "supported_currencies": [
        "NGN",
        "GHS",
        "ZAR",
        "KES",
        "USD"
      ],
      "environment": "test",
      "is_configured": true
    },
    {
      "provider": "mpesa",
      "display_name": "M-Pesa",
      "type": "stk_push",
      "supported_currencies": [
        "KES"
      ],
      "environment": "sandbox",
      "is_configured": true
    },
    {
      "provider": "airtel",
      "display_name": "Airtel Money",
      "type": "stk_push",
      "supported_currencies": [
        "KES",
        "UGX",
        "TZS",
        "RWF"
      ],
      "environment": "staging",
      "is_configured": true
    },
    {
      "provider": "cash",
      "display_name": "Cash",
      "type": "manual",
      "supported_currencies": [
        "*"
      ],
      "environment": "production",
      "is_configured": true
    }
  ]
}

Authorizations

Authorization · string · header · required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

Key Types:

Secret Keys (Server-Side Only):

• Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
• Full read/write access to all endpoints
• ⚠️ NEVER expose in client-side code or public repositories
• Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

• Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
• Read-only access (GET requests only, plus POST semantic search)
• ✅ Safe for client-side JavaScript, mobile apps, and public code
• Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

• Authentication endpoints (/v1/auth/*): Secret key required
• Payment verification (POST /v1/payments/verify): Secret key required
• AI Recommendations (POST /v1/recommendations): Secret key required
• Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
• All write operations: Secret key required
• All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Query Parameters

fields · string

Comma-separated list of fields to include in the response.

Allowed Fields:

• provider, display_name, type
• supported_currencies
• environment, is_configured

Response

200

application/json

Successfully retrieved payment methods

methods · object[]

Show child attributes