Fintech APIs & Platform for KYC, Verification & Transactions in India | Eko Platform Services
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 DigiKhata sender.

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

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

Request

Path parameters

customer_idstringRequired

Sender's 10-digit mobile number.

example: 8617567988

Query parameters

initiator_idstringRequired

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

example: 9962981729

client_ref_idstringoptional

Unique reference ID per API call, generated by your system (max 20 characters).

example: 2026010100123456789

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.

      • bankstring

        Beneficiary's bank name.

      • accountstring

        Masked beneficiary account number.

      • ifscstring

        Beneficiary branch IFSC.

      • beneficiary_idnumber

        Beneficiary identifier, when bank-registered.

Next steps

NextPOSTAdd RecipientRegister a new beneficiary under a DigiKhata sender's account.

Related