Developer Docs
API Endpoints
Eko Platform ServicesGithubAsk GPT
These docs are for v1. Click to read the latest docs for v3.

Retrieve Settlement Bank Accounts

get
https://staging.eko.in/ekoapi/v1/agent/user_code:

This will return the list of recipients mapped to the user for fund settlement services

📘

Please Note

This API is needed to retrieve the recipient id to which the user plans to settle the funds

📘

Please Note:

unsettled_fund : 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).

remaining_limit : Total remaining limit of the maximum amount that you can settle per day.

Path Params
string
required

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

Query Params
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)

string
required

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

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

Updated almost 6 years ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated almost 6 years ago