Eko Platform Services Logo

    PUTActivate BBPS Service

    Onboard an agent/retailer for BBPS bill payment services using service code 53.

    PUT/user/service/activate

    Before a retailer can process BBPS payments, the BBPS service (service_code = 53) must be activated for their user_code. This is a one-time setup call per agent. After activation, verify the status using the User Service Enquiry API. The agent's GPS coordinates (latlong) are mandatory for production compliance.

    Body parameters

    initiator_idstringRequired

    Registered mobile number of the API user (see Platform Credentials).

    example: 9962981729

    user_codestringRequired

    User code of the retailer/agent the service is run for.

    example: 20810200

    client_ref_idstringoptional

    Unique reference id per API call, generated by your system.

    example: REQ-20260101-001

    service_codenumberRequired

    Service identifier for BBPS. Always 53.

    example: 53

    latlongstringRequired

    Agent's GPS coordinates as `latitude,longitude`. Mandatory for BBPS agent activation.

    example: 28.6139,77.2090

    Headers

    developer_keystringRequired

    Static API key issued to your account after KYC.

    secret-keystringRequired

    Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

    secret-key-timestampstringRequired

    Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

    content-typestringRequired

    application/json

    example: application/json

    Responses

    • statusnumber

      Primary success indicator (0 = success).

    • messagestring

      Human-readable response / error message.

    • response_status_idnumber

      Granular status id; see the shared error-codes table.

    • response_type_idnumber

      A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.

    • dataobject

      API-specific response payload.

      • service_codenumber

        The service code that was activated.

      • service_statusstring

        Activation status for the service on the agent's account.