POSTInitiate Settlement

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

POST/user/payment/aeps/settlement

Settles an agent's collected AePS funds to one of their registered settlement bank accounts (recipient_id from Add Settlement Bank Account). Returns the financial response envelope with tx_status, tid, fee, and updated balance.

The settleable amount equals the agent's total AePS business over the last 7 days minus any settlements already made in that window.

Operating window

Important

Settlement runs Monday–Friday, 10:00–17:00 IST, excluding RBI bank holidays. A request placed after 17:00 settles on the next working day.

Maximum ₹2,00,000 per transaction.

Settlement rail (`payment_mode`)

`payment_mode`	Rail
4	NEFT
5	IMPS
13	RTGS

Status & auto-refund

`tx_status`	Meaning
0	Success
2	Initiated / response awaited
4	Refunded
5	Hold (inquiry required)

If the bank declines the settlement it moves to the refunded state and the balance is auto-reversed — no manual action needed. After initiating, confirm the outcome with the Transaction Inquiry API using either the Eko tid or your client_ref_id.

Request

Body 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
`amount`	integer	required	Settlement amount requested (INR). Max 200000 per transaction.e.g. 100
`recipient_id`	integer	required	Settlement recipient identifier (from Add / Get Settlement Account).e.g. 1829
`payment_mode`	integer	required	Transfer method: 4 = NEFT, 5 = IMPS, 13 = RTGS.e.g. 5

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

amountintegerRequired

Settlement amount requested (INR). Max 200000 per transaction.

example: 100

recipient_idintegerRequired

Settlement recipient identifier (from Add / Get Settlement Account).

example: 1829

payment_modeintegerRequired

Transfer method: 4 = NEFT, 5 = IMPS, 13 = RTGS.

example: 5

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.
tx_statusstring
Transaction state: 0=Success, 1=Fail, 2=Awaited, 3=Refund Pending, 4=Refunded, 5=On Hold.
txstatus_descstring
Human-readable transaction status.
dataobject
API-specific response payload.
- tx_statusstring
  Transaction status code (0 = success).
- amountstring
  Settled amount (INR).
- txstatus_descstring
  Human-readable transaction status.
- feestring
  Base fee charged for the settlement (INR).
- gststring
  GST charged on the settlement fee (INR).
- sender_namestring
  Name of the settling agent.
- tidstring
  Eko transaction ID for the settlement.
- client_ref_idstring
  Client reference id echoed for the settlement.
- balancestring
  Agent balance after the settlement (INR).
- user_codestring
  Code of the user/agent the settlement was run for.
- totalfeestring
  Total fee charged for the settlement, incl. GST (INR).
- recipient_namestring
  Name on the destination bank account.
- ifscstring
  Destination branch IFSC.
- bank_ref_numstring
  Bank reference / UTR number. Empty until the bank confirms the transfer.
- accountstring
  Destination account number.
- timestampstring
  Settlement timestamp. Empty on the initial response.

POSTInitiate Settlement

Operating window

Settlement rail (`payment_mode`)

Status & auto-refund

Request

Body parameters

Responses

Next steps

Related

Operating window

Settlement rail (payment_mode)

Status & auto-refund

Request

Body parameters

Responses

Next steps

Related

Settlement rail (`payment_mode`)