GETGet Settlement Bank Accounts

List an agent's registered AePS settlement recipients with unsettled funds and remaining limit.

GET/user/payment/aeps/settlement/accounts

Returns the agent's saved settlement bank accounts (each with a recipient_id), the total unsettled fund, and the remaining daily settlement limit.

Request

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 (max 20 characters).e.g. 2026010100123456789
`user_code`	string	required	Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your userse.g. 20810200

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

user_codestringRequired

Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your users

example: 20810200

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

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.
- unsettled_fundstring
  Total unsettled AePS fund available to settle (INR).
- remaining_limitstring
  Remaining settlement limit for the day (INR).
- fund_transfer_listarray
  Registered settlement recipients.
  - recipient_idstring
    Settlement recipient identifier — pass to Initiate Settlement.
  - namestring
    Account holder name.
  - accountstring
    Bank account number.
  - ifscstring
    Bank branch IFSC.

Next steps

NextPOSTInitiate SettlementSettle an agent's AePS funds to a registered bank account via NEFT/IMPS/RTGS.

import { EpsClient } from "@ekoindia/eps-sdk";

const client = new EpsClient({

developerKey: process.env.EPS_DEVELOPER_KEY,

accessKey: process.env.EPS_ACCESS_KEY,

initiatorId: "9962981729",

userCode: "20810200",

environment: "sandbox",

});

const result = await client.call("aeps-get-settlement-accounts");

console.log(result);

{

"response_status_id": -1,

"data": {

"unsettled_fund": "6100.0",

"remaining_limit": "190000",

"fund_transfer_list": [

{

"name": "Test Recipient",

"ifsc": "SBIN0000000",

"account": "00000000000001",

"recipient_id": "1828"

{

"name": "Test Recipient",

"ifsc": "SBIN0000000",

"account": "00000000000002",

"recipient_id": "1829"

}

]

"response_type_id": 1321,

"message": "List of fund transfer recipients",

"status": 0

}

Request

Query parameters

Responses

Next steps

Related