Eko Platform Services Logo
    Open in ChatGPTOpen in ClaudeView as Markdown
    Get Postman CollectionDownload OpenAPI

    GETGet BBPS Locations

    Retrieve the list of supported state/location IDs for filtering BBPS operators.

    GET/customer/payment/bbps/locations

    Returns all supported location (state) identifiers. Pass the returned location_id as the location query parameter in the Get Operators call to narrow results to a specific state or circle.

    Query 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

    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.

      • locationsarray

        List of supported state/location entries.

        • idnumber

          Location identifier to use as the `location` filter when querying operators.

        • location_namestring

          State or circle name.