- First, you need to onboard your agents (users) using the Onboard Agent API. This is a one-time process for each agent on our platform.
- Then, follow these guidelines to design the PPI transaction flow in your app:
- Check if the customer has already been onboarded on EKO’s platform using the Get Sender Information API.
- For a new customer, use the Onboard Sender , Verify Customer OTP,Validate Aadhar and Validate Pan APIs to onboard them on the platform.
- Note: OTPs will not be dispatched on UAT for testing.
- For an existing customer, use the Get Sender Information and Verify OTP APIs to get the customer monthly limit .
- For a new customer, use the Onboard Sender , Verify Customer OTP,Validate Aadhar and Validate Pan APIs to onboard them on the platform.
- Then, Get List of Recipients which are already registered for that customer.
- If the desired recipient is not registered, Add Recipient and Add Recipient Bank API for that customer.
- Then, use the PayPoint Transaction API to initiate PPI transaction to a registered recipient for that customer.
- Check if the customer has already been onboarded on EKO’s platform using the Get Sender Information API.
- Also, note the following:
- Check the status of any transaction later using the Transaction Inquiry API.
- If the transaction goes into Refund Pending state, checkout the Initiate Refund API.
Every transaction response will contain a tx_status code with the following possible values:
tx_status | txstatus_desc |
---|---|
0 | Success |
1 | Fail |
2 | Initiated |
3 | Refund Pending |
4 | Refunded |
5 | Hold (Transaction Inquiry Needed) |
In case if any other value is returned in tx_status parameter then the transaction should be treated as initiated and transaction inquiry should be done until final status is received.
Transaction Timeout
A transaction can timeout due to multiple reasons, such as, bad internet connection or slow response from the partner bank. In such cases, transaction should not be treated as declined or failed. Ideally, it should be inquired using the Transaction Inquiry API by the passing your own reference number, i.e.,
client_ref_id
.