GETGet Recipients

Retrieve the list of saved beneficiaries for a DMT-Levin sender.

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

Warning

The UAT environment is not available for this API — requests to https://staging.eko.in/ekoapi/v3 return an error response. Test it in Production.

Returns all recipients (beneficiaries) registered under the sender's DMT-Levin account, including each recipient's name, IFSC, beneficiary ID and recipient ID. Use this before initiating a transfer — if the desired recipient already exists you can use their recipient_id directly, skipping Add Recipient.

Request

Path parameters

Field	Type	Required	Description
`customer_id`	string	required	Sender's 10-digit mobile number.e.g. 8969622436

customer_idstringRequired

Sender's 10-digit mobile number.

example: 8969622436

Query parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`client_ref_id`	string	optional	Unique reference ID per API call, generated by your system (10–20 characters; 10 recommended). The SDKs generate one for every non-GET call when you don't.e.g. 2026010100123456789
`user_code`	string	required	User code value of the retailer from whom the request is coming (sent as a query parameter).e.g. 32515001
`additional_info`	integer	optional	Send a fixed value of 1 (sent as a query parameter).e.g. 1

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 (10–20 characters; 10 recommended). The SDKs generate one for every non-GET call when you don't.

example: 2026010100123456789

user_codestringRequired

User code value of the retailer from whom the request is coming (sent as a query parameter).

example: 32515001

additional_infointegeroptional

Send a fixed value of 1 (sent as a query parameter).

example: 1

These headers authenticate and sign every request. See How Auth Works for details.

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

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

Response types

response_type_id	Meaning	Next step
`23`	Recipient list returned — proceed to Send Transaction OTP	Send Transaction OTP

Responses

23Recipient list returned — proceed to Send Transaction OTPNext:Send Transaction OTP

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
UI display hint only (-1/0 success, 1 failure, 2 initiated, 3 refund initiated, 4 refunded). Never branch on it — use `status` (and `tx_status` for financial APIs), or `response_type_id` where documented.
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
  PAN requirement flag for the sender.
- remaining_limit_before_pan_requirednumber
  Amount the sender can still transfer before PAN becomes mandatory (INR).
- is_insuredstring
  Insurance flag for the sender.
- recipient_listarray
  Registered beneficiaries for this sender.
  - recipient_idnumber
    Recipient identifier used to send money.
  - beneficiary_idnumber
    Beneficiary identifier (may be null).
  - recipient_namestring
    Beneficiary name.
  - recipient_mobilestring
    Beneficiary mobile number.
  - bankstring
    Beneficiary bank name.
  - ifscstring
    Beneficiary bank IFSC code.
  - accountstring
    Masked beneficiary bank account number.
  - account_typestring
    Type of the beneficiary account.
  - recipient_id_typestring
    How the recipient is identified.
  - ifsc_statusnumber
    Whether the IFSC is valid/active (1 = valid).
  - is_verifiednumber
    Whether the account has been penny-drop verified (1 = verified).
  - is_self_accountstring
    Whether the account belongs to the sender (1 = self).
  - is_otp_requiredstring
    Whether an OTP is required to transact to this recipient.
  - channelnumber
    Transfer channel for this recipient.
  - allowed_channelnumber
    Channel allowed for transfers to this recipient.
  - available_channelnumber
    Channel currently available for this recipient.
  - imps_inactive_reasonstring
    Reason IMPS is inactive for this recipient, if any.
  - pipesobject
    Available settlement pipes for this recipient, keyed by pipe id.

Next steps

NextPOSTAdd RecipientAdd a new beneficiary, or update an existing one, under a DMT-Levin sender.