Initiate AePS Fund Settlement

This will allow agents to transfer funds to their account for their 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 ₹ 1 lakh in the last 7 days and he/she has settled ₹ 25k in the last 7 days so he/she can now settle ₹ 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:

Body Params
string
required

Your registered mobile number (See Platform Credentials for UAT)

string
required

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

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 static API key (See Guide)

string
required

Your dynamically generated security key, unique for every request (See Guide)

string
required

The current timestamp used to generate secret-key

Responses

Language
Credentials
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json