POSTInitiate Settlement

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

POST/user/payment/aeps/settlement

Initiates a fund settlement of the requested amount to a registered recipient_id. Returns the financial response envelope with tx_status, transaction id (tid), fee, and updated balance. Settlement is available Mon–Fri 10am–5pm; max ₹2,00,000 per transaction.

Body parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`user_code`	string	required	User code of the retailer/agent the service is run for.e.g. 20810200
`client_ref_id`	string	optional	Unique reference id per API call, generated by your system.e.g. REQ-20260101-001
`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

user_codestringRequired

User code of the retailer/agent the service is run for.

example: 20810200

client_ref_idstringoptional

Unique reference id per API call, generated by your system.

example: REQ-20260101-001

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

Headers

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.
- tidstring
  Eko transaction ID for the settlement.
- tx_statusstring
  Transaction status (2 = initiated).
- txstatus_descstring
  Human-readable transaction status.
- amountstring
  Settled amount (INR).
- totalfeestring
  Total fee charged for the settlement (INR).
- balancestring
  Agent balance after the settlement (INR).
- accountstring
  Destination account number.
- ifscstring
  Destination branch IFSC.