---
title: "Initiate Settlement API Reference"
description: "Settle an agent's AePS funds to a registered bank account via NEFT/IMPS/RTGS."
canonical: "https://eps.eko.in/docs/aeps-initiate-settlement"
---


> **Canonical URL:** https://eps.eko.in/docs/aeps-initiate-settlement
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# Initiate Settlement API Reference

`POST https://staging.eko.in/ekoapi/v3/user/payment/aeps/settlement`

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

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.

> View product & pricing details: [AePS Cashout](https://eps.eko.in/products/aeps-api.md)

## Body parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| user_code | string | yes | User code of the retailer/agent the service is run for. e.g. 20810200 |
| client_ref_id | string | no | Unique reference id per API call, generated by your system. e.g. REQ-20260101-001 |
| amount | integer | yes | Settlement amount requested (INR). Max 200000 per transaction. e.g. 100 |
| recipient_id | integer | yes | Settlement recipient identifier (from Add / Get Settlement Account). e.g. 1829 |
| payment_mode | integer | yes | Transfer method: 4 = NEFT, 5 = IMPS, 13 = RTGS. e.g. 5 |

## Headers

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

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | Granular status id; see the shared error-codes table. |
| response_type_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| tx_status | string | Transaction state: 0=Success, 1=Fail, 2=Awaited, 3=Refund Pending, 4=Refunded, 5=On Hold. |
| txstatus_desc | string | Human-readable transaction status. |
| data | object | API-specific response payload. |
| data.tid ⭐ | string | Eko transaction ID for the settlement. |
| data.tx_status ⭐ | string | Transaction status (2 = initiated). |
| data.txstatus_desc ⭐ | string | Human-readable transaction status. |
| data.amount | string | Settled amount (INR). |
| data.totalfee | string | Total fee charged for the settlement (INR). |
| data.balance ⭐ | string | Agent balance after the settlement (INR). |
| data.account | string | Destination account number. |
| data.ifsc | string | Destination branch IFSC. |

## Example request

```json
{
  "initiator_id": "9962981729",
  "user_code": "20810200",
  "client_ref_id": "REQ-20260101-001",
  "amount": 100,
  "recipient_id": 1829,
  "payment_mode": 5
}
```

## Example response

```json
{
  "response_status_id": 0,
  "data": {
    "tx_status": "2",
    "amount": "100.00",
    "balance": "2.251010664E7",
    "txstatus_desc": "Initiated",
    "totalfee": "5.00",
    "ifsc": "BKID0006701",
    "account": "987867867967969",
    "tid": "12937465"
  },
  "response_type_id": 1329,
  "message": "Transaction initiated successfully",
  "status": 0
}
```