Skip to documentation
SparkGlimSparkGlim Developer
Search all documentation

Try a topic in your language or an exact API path.

    API reference

    Campaign payment options

    Lists enabled checkout method names for an approved campaign’s selling country, currency and client context without exposing provider secrets.

    GEThttps://api.sparkglim.net/api/public/payment-methods/:campaignId

    Access model

    Access model
    Public access with validation
    Documented availability
    Implemented in source

    Availability is verified from source, not a live production guarantee.

    Open the returned checkout URL. SparkGlim Server owns prices, methods, payment verification and fulfillment; browser returns are navigation only.

    Parameters

    NameTypeValidation
    campaignIdRequired

    Existing campaign record within the caller’s account and any narrower campaign credential.

    stringValidation: UUID or documented resource identifier.
    app_typeOptional

    Existing caller context used to select Web or User App configuration; it grants no extra permissions.

    enumValidation: user selects user_app; otherwise web.

    Request

    Examples describe the contract and are not executed. Use authorized test records; never paste a real secret into these pages.

    GET /api/public/payment-methods/:campaignId
    http
    GET /api/public/payment-methods/11111111-1111-4111-8111-111111111111 HTTP/1.1
    Host: api.sparkglim.net
    

    Response

    Success response · HTTP 200
    json
    {
      "success": true,
      "data": {
        "methods": [],
        "currency": "GHS",
        "country": "GH"
      }
    }
    Error response · HTTP 400
    json
    {
      "success": false,
      "error": "<ERROR_MESSAGE>"
    }

    Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

    Limits & retries

    Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

    Source compatibility

    Authorized operations require account-specific testing.

    • server/src/api/router.ts
    • server/src/api/routes/public.ts