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

Activate Service (AePS)

This process activates a service for a user using shop_type from the Get MCC Category API and state_id from the Get States API.

❗️

Mandatory Parameters for AePS activation :

For the AePS API activation, you need to pass user_code, initiator_id, service_code = 43, modelname, devicenumber, office_address, address_as_per_proof, pan_card as mandatory and aadhar_front and aadhar_back.

Make sure that you enter correct modelname and devicenumber. Do not do testing with your production credentials

If you are integrating AePS Gateway solution then activate the service using service_code as 43 .

By activating AePS API service for merchants using the service code = 43, they will be able to conduct AePS. If we find any mismatch in documents, the merchant’s AePS business will be paused. We will communicate the same to you within 24 working hours of merchant activation and ask for re-uploading updated documents. Post re-upload, the status will go in PENDING state and waiting for the action to be taken by the OPS team.

📘

AePS Activation TAT

For AePS API - After activation, the user state goes into pending state and it will take 2-3 business day for any user to get onboarded on fingpay .

🚧

Please Note:

  1. Please use correct and clear images, as these are checked in the back-end and your service will be deactivated if the images are incorrect or not in the correct format.
  2. The file size for the documents for AePS activation should be less than 1MB.
  3. We accept the images in JPEG, JPG, and PDF format, not in PNG. PNG images are rejected from the partner bank.
  4. Make sure you're passing the correct device number and model name for the BIOMETRIC device that you're using.
  5. The withdrawal amount for AEPS transactions must strictly adhere to being in multiples of 50 or 100, ensuring compliance with standard banking guidelines.
  6. The AEPS transaction limit for a merchant is ₹10,000 for all transactions combined within a one-week period.
Form Data
string
required

User code value of the retailer from whom the service needs to be activated

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

you will the get shop_type from Get MCC Category API. For reference: https://developers.eko.in/reference/get-mcc-category

string
required

model name of the biometric device

string
required

Device number / serial number of bio-metric device

string
required

this shall be the latitude and longitute coordinates of the merchant's shop. E.g : 43.8345322,51.3254522

string
required

This shall be aadhar of the merchant, for which the service needs to be activated

string
required

This shall be the bank account number of the merchant

string
required

This is the IFSC code of the merchant's bank account.

json
required

This will contain "state_id","line", "city", "state" and "pincode". Get state_id from : https://developers.eko.in/reference/get-states

json
required

This will contain "state_id","line", "city", "state" and "pincode". Get state_id from : https://developers.eko.in/reference/get-states

file
required

For AePS activation

file
required

For AePS Activation

file
required

For AePS Activation

string
required
Defaults to 43
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