These docs are for v1. Click to read the latest docs for v3.

Initiate Settlement

This will allow users to transfer funds to his account for his/her AePS business

📘

Please Note

  1. The amount that a user can settle: Total AePS business (last 7 days) minus settlement done (last 7 days).
    For example: If a user has done AePS business worth of Rs. 1 lakh in the last 7 days and he/she has settled Rs. 25k in the last 7 days so he/she can now settle Rs 75k (1 lakh - 25k)
    2. Place a request for AePS settlement and get money in your bank account within 3 hours.
  2. Service will be available from Monday to Friday between 10 AM to 5 PM except for RBI bank holidays.
  3. Any transaction done after 5 PM will be settled on the next working day.
  4. Maximum amount per transaction: ₹ 2 Lakh
payment_modeDescription
4NEFT
5IMPS
13RTGS
tx_statusDescription
0Success
2Initiated /Response Awaited
4Refunded
5Hold

🚧

Once the transaction has been done it will go in the initiated state. After this, you will make an inquiry of the transaction using the Eko's TID or the client_ref_id which is being generated from your end. The transaction inquiry will be done in the same way as of DMT.

If the Transaction got failed from the bank side then, in this case, it will go in the refunded state and the balance will be auto reversed.

If you get tx_status other than 0 and 4, you need to do the inquiry before updating the tx_status in your system.

You can test the AePS fund settlement in your postman by downloading the collection from the following link:

Path Params
string
required

User code value of the retailer / partner from whom the request is coming

Form Data
string
required

The unique cell number with which you are onboarded on Eko's platform. For UAT refer to [Platform Credentials] (https://developers.eko.in/docs/platform-credentials)

int32
required

This is the code of the service for fund settlement. The value of service code for AePS fund settlement is 39

int32
required

Amount which user want to settle

int32
required

unique recipient_id against which user want to settle the amount

int32
required

Please refer to the below table for values

string
required

Unique transaction ID which you will generate from you end for every transaction

Headers
string
required

Your unique API key that will authenticate your request. For UAT, refer to [Platform Credentials] (https://developers.eko.in/docs/platform-credentials)

string
required

Refer to [authentication section] (https://developers.eko.in/docs/authentication)

string
required

Refer to [authentication section] (https://developers.eko.in/docs/authentication)

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json