Token Technical Integration

STEP 1: Use the following APIs to generate and send Token to your users:

• Token API Integration Overview
• Generate Token API
• Token Inquiry API
• Cancel Token API
• Resend Token API

docs.google.com

API Response Code Master List

STEP 2: Expose These APIs:

You also need to expose the following mandatory APIs at your end (so that Token can talk to your server and get the necessary information or inform you about a payment):

🚧

NOTE

1. Content-Type for every API should be application/json.
2. Authorization can only be Basic.

📘

Common Parameter Description in Response

All the parameters which were sent in Token Generation request.
status: Values will be from the table given in Token generation request.
response_code: Unique code corresponding to description
response_code_desc: Description of response code

1. Fetch Details API

This API will be exposed if the partner wants the details of the token to be fetched from the server before the payment. It should be exposed on the same client_ref_id by which the token was generated by the partner.

Sample Request:
https://domain/apipath?client_ref_id=8927349327493

Response Format:
{  
   "status":0,
   "status_desc":"Success",
   "response_code":"00",
   "response_code_desc":"Details Found",
   "data":{  
      "client_ref_id":"8927349327493",
      "amount":"1500",
      "customer_name":"Ram",
      "customer_mobile":"9400000000"
   }
}

2. Acknowledgement API

This will be called once the payment is done at Eko's end to acknowledge the partner that the payment has been received, the same amount will be credited in the partner enterprise account maintained at Eko's end.

Sample Request URL: 
https://domain/apipath (No Certification Authentication)

Sample Request Payload:
{  
   "client_ref_id":"5541284999",
   "amount":1500,
   "customer_name":"Ram",
   "customer_id":"9400000000",
   "tid":"173873868332",
   "token":"910039283462841"
 }

Response Format:
{  
   "status":0,
   "status_desc":"Success",
   "response_code":"00",
   "response_code_desc":"Success",
   "data":{  
      "partner_tid":"493979593"
   }
}

📘

Parameter description in Request and Response

1. client_ref_id: This will be same which was given at the time of token generation.
2. tid: Unique reference of Eko server.Uniqueness of Eko TID should be maintained at partner's end in case of multiple acknowledgements sent.
3. customer_id: Mobile number of the customer given at the time of token generation.
4. partner_tid: Unique reference of the partner server given for every acknowledgement

Note: System will try to acknowledge the transaction till 200 HTTP status code is not received from partner server (max 3 days and every 1 hour).