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

    GETGet List of Recipients

    Retrieve the list of saved beneficiaries for a PPI Levin sender.

    GET/customer/payment/ppi-levin/sender/{customer_id}/recipients

    Returns every recipient saved under a PPI Levin sender, with bank/account details, verification status, available channels (IMPS/NEFT), and the sender's remaining limit before PAN becomes mandatory.

    Path parameters

    customer_idstringRequired

    Sender's 10-digit mobile number.

    example: 9444444444

    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

    wallet_tokenstringoptional

    Wallet authentication token, when applicable.

    example:

    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.

      • pan_requirednumber

        Whether PAN is required to continue transacting (2 = not yet required).

      • remaining_limit_before_pan_requirednumber

        Amount the sender can still transfer before PAN is required (INR).

      • recipient_listarray

        Saved beneficiaries for this sender.

        • recipient_idnumber

          Unique recipient identifier — use to transact.

        • recipient_namestring

          Beneficiary's name.

        • recipient_mobilestring

          Beneficiary's mobile number.

        • bankstring

          Beneficiary's bank name.

        • accountstring

          Masked beneficiary account number.

        • ifscstring

          Beneficiary branch IFSC.

        • beneficiary_idnumber

          Beneficiary identifier, when bank-registered.

        • channelnumber

          Allowed transfer channel (0 = IMPS, 2 = NEFT).