---
title: "Get List of Recipients API Reference"
description: "Retrieve the list of saved beneficiaries for a DigiKhata sender."
canonical: "https://eps.eko.in/docs/ppi-digikhata-get-recipients"
---


> **Canonical URL:** https://eps.eko.in/docs/ppi-digikhata-get-recipients
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# Get List of Recipients API Reference

`GET https://staging.eko.in/ekoapi/v3/customer/payment/ppi-digikhata/sender/{customer_id}/recipients`

Retrieve the list of saved beneficiaries for a DigiKhata sender.

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.

> View product & pricing details: [PPI Wallet](https://eps.eko.in/products/ppi-api.md)

## Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| customer_id | string | yes | Sender's 10-digit mobile number. e.g. 8617567988 |

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| user_code | string | yes | User code of the retailer/agent the service is run for. e.g. 20810200 |

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| developer_key | string | yes | Static API key issued to your account after KYC. |
| secret-key | string | yes | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
| secret-key-timestamp | string | yes | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
| content-type | string | yes | application/json e.g. application/json |

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | Granular status id; see the shared error-codes table. |
| response_type_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| data | object | API-specific response payload. |
| data.pan_required | number | Whether PAN is required to continue transacting (2 = not yet required). |
| data.remaining_limit_before_pan_required | number | Amount the sender can still transfer before PAN is required (INR). |
| data.recipient_list ⭐ | array | Saved beneficiaries for this sender. |
| data.recipient_list.recipient_id ⭐ | number | Unique recipient identifier — use to transact. |
| data.recipient_list.recipient_name ⭐ | string | Beneficiary's name. |
| data.recipient_list.bank | string | Beneficiary's bank name. |
| data.recipient_list.account | string | Masked beneficiary account number. |
| data.recipient_list.ifsc | string | Beneficiary branch IFSC. |
| data.recipient_list.beneficiary_id | number | Beneficiary identifier, when bank-registered. |

## Example response

```json
{
  "response_status_id": 0,
  "data": {
    "pan_required": 2,
    "recipient_list": [
      {
        "channel_absolute": 0,
        "available_channel": 0,
        "account_type": "Bank Account",
        "ifsc_status": 1,
        "is_self_account": "0",
        "channel": 0,
        "is_imps_scheduled": 0,
        "recipient_id_type": "acc_ifsc",
        "imps_inactive_reason": "",
        "allowed_channel": 0,
        "is_verified": 0,
        "beneficiary_id": 40378,
        "bank": "Kotak Mahindra Bank",
        "is_otp_required": "0",
        "recipient_mobile": "9999999990",
        "recipient_name": "Aditya",
        "ifsc": "KKBK0000878",
        "account": "1XXXXXX90657",
        "pipes": {
          "3": {
            "pipe": 3,
            "status": 1
          }
        },
        "recipient_id": 10018839,
        "is_rblbc_recipient": 1
      },
      {
        "channel_absolute": 2,
        "available_channel": 2,
        "account_type": "Bank Account",
        "ifsc_status": 1,
        "is_self_account": "0",
        "channel": 2,
        "is_imps_scheduled": 0,
        "recipient_id_type": "acc_ifsc",
        "imps_inactive_reason": "",
        "allowed_channel": 2,
        "is_verified": 0,
        "beneficiary_id": null,
        "bank": "State Bank of India",
        "is_otp_required": "0",
        "recipient_mobile": "6888888886",
        "recipient_name": "Madness",
        "ifsc": "SBIN00005656",
        "account": "43XXXXXXXXX45",
        "pipes": {
          "3": {
            "pipe": 3,
            "status": 1
          }
        },
        "recipient_id": 10065177,
        "is_rblbc_recipient": 1
      }
    ],
    "remaining_limit_before_pan_required": 50000,
    "is_insured": ""
  },
  "response_type_id": 23,
  "message": "Success",
  "status": 0
}
```