GETGet States

List the states (with their state_id) available for AePS Fingpay agent onboarding.

GET/user/collection/aeps-fingpay/get-states

Read-only: Changes nothing; only returns data.

Returns the list of states. Use the value of the chosen state as the state_id inside the address_as_per_proof and office_address objects in the Activate AePS Fingpay request.

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

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

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
`2127`	State list returned successfully	Activate AePS Fingpay for Agent

Responses

2127State list returned successfullyNext:Activate AePS Fingpay for Agent

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.
- param_attributesobject
  Container for the returned list.
  - list_elementsarray
    Array of available states.
    - stateCodestring
      Two-letter state code.
    - labelstring
      State name (display to the agent).
    - valuenumber
      Integer state ID — use as `state_id` in the address objects.

Next steps

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

const client = new EpsClient({

developerKey: process.env.EPS_DEVELOPER_KEY,

accessKey: process.env.EPS_ACCESS_KEY,

initiatorId: "9962981729",

environment: "sandbox",

});

const result = await client.call("aeps-fingpay-states");

console.log(result);

{

"response_status_id": 0,

"param_attributes": {

"list_elements": [

{

"stateCode": "HR",

"label": "Haryana",

"value": 8

{

"stateCode": "KA",

"label": "Karnataka",

"value": 12

{

"stateCode": "MH",

"label": "Maharashtra",

"value": 15

{

"stateCode": "SK",

"label": "Sikkim",

"value": 23

{

"stateCode": "UP",

"label": "Uttar Pradesh",

"value": 27

}

]

"response_type_id": 2127,

"message": "Success",

"status": 0

}

Request

Query parameters

Response types

Responses

Next steps

Related