Freelance Workspace

Getting Started

Authentication

Base URL

PayOut

IMPS Send Payout Request

UPI Send Payout Request

Get Payout Status

Get Balance

Callback Response

Invoice Payin

Create Transaction

Get Transaction Status

The S2S PayIN section of the EFIPAY Payment API allows users to securely process card payments and retrieve detailed information about card transactions. With this API section, users can seamlessly integrate card payment functionality into their applications, ensuring a smooth and secure payment experience for their customers.

S2S PayIn Manual

Get Payment Method

Update Transaction

S2S PayIn Automatic

Payin Mobile UPI Intent

EFIPAY - Payment API's

EFIPAY - API Documentation

Production

Sandbox

<p class="slate-p" placeholder="Type / for widgets">Welcome to EFIPAY API Doc!</p><p class="slate-p" placeholder="Type / for widgets">
The EFIPAY payment solution designed to streamline transactions in the modern economy. With EFIPAY, users can enjoy a seamless and secure payment experience.</p><p class="slate-p" placeholder="Type / for widgets"></p><h1 class="slate-h1">How to get keys</h1><p class="slate-p" placeholder="Type / for widgets">Our API integration starts in your dashboard. Browse to the account settings section and get your first API Key and Salt Key.</p><p class="slate-p" placeholder="Type / for widgets"></p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1706863093874.jpg" alt="" style="width:50%"/></div><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3"> Security Measures:  </h3><p class="slate-p" placeholder="Type / for widgets">  Following these steps fortifies your API against potential threats, ensuring the integrity and confidentiality of your data.</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Safeguard your keys: Keep API keys and salt keys confidential to prevent unauthorized access.</div></li><li class="slate-li"><div style="position:relative">Ensure HTTPS Usage: Encrypt data transmission using HTTPS to prevent eavesdropping and tampering.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>


The EFIPAY payment solution designed to streamline transactions in the modern economy. With EFIPAY, users can enjoy a seamless and secure payment experience.

Our API integration starts in your dashboard. Browse to the account settings section and get your first API Key and Salt Key.

  Following these steps fortifies your API against potential threats, ensuring the integrity and confidentiality of your data.

 algorithm to authenticate your requests. The idea is simple, every request (URL path + body) needs to be signed using your API Secret. Then our server makes sure the signature is correct and processes the query. 

This  provides a comprehensive guide on encrypting and signing API requests using JavaScript. It utilizes the CryptoJS library to implement HMAC-SHA256 encryption for securing the requests.

All private REST requests must contain the following headers:

1. Encryption and Signing Function:

This function takes four parameters:

It returns a string representing the generated signature for the API request.

You can use this function to sign your API requests before sending them to ensure their authenticity and integrity.

 function that you can use to generate a signature for your API request. To get started, ensure that CryptoJS is installed in your project. You can install it via npm using the following command:

> with your actual API key and salt key, respectively. After executing this code, you will obtain the generated signature for your API request.

4. How to Include Signing Keys in API Headers:

After generating the necessary keys, you can include them in your API headers to authenticate and authorize your requests. Below is an example of how to include the generated keys in your API headers using JavaScript:

 with the actual URL of your API endpoint. This code snippet demonstrates how to send an authenticated API request using the Fetch API in JavaScript.

<p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(13, 13, 13);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(13, 13, 13);font-size:16px" class="slate-backgroundColor">The base URL is the root address for all API calls. Depending on the stage of development or deployment, you will use either the production or sandbox base URL. Ensure you are using the correct base URL to avoid unintended effects, such as affecting live data when testing.</span></span></p><p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(13, 13, 13);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(13, 13, 13);font-size:16px" class="slate-backgroundColor"></span></span></p><h3 class="slate-h3">Production Environment</h3><p class="slate-p" placeholder="Type / for widgets">The production environment is meant for live applications. When your application is ready for deployment and intended for real users, use the production base URL for all API requests.</p><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Sandbox Environment</h3><p class="slate-p" placeholder="Type / for widgets">The sandbox environment is a testing environment that mirrors the production environment but does not affect live data. Use the sandbox base URL for testing, development, and experimentation to ensure that your application behaves as expected before deploying it to production.</p><p class="slate-p" placeholder="Type / for widgets"></p><h3 class="slate-h3">Choosing the Right Environment</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Use the <span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">production environment</strong></span> for all API calls related to your live application. This environment should be used with real transactions and when your application is being used by actual users.</div></li><li class="slate-li"><div style="position:relative">Use the <span style="color:var(--tw-prose-bold)" class="slate-color"><strong style="color:var(--tw-prose-bold)" class="slate-bold">sandbox environment</strong></span> for development, testing, and experimentation. This environment is ideal for trying out new features or making changes to your application without the risk of affecting your live data.</div></li></ul><h3 class="slate-h3">Notes and Best Practices</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Always ensure you are using the correct base URL for your intended environment to prevent data corruption or unintended side effects.</div></li><li class="slate-li"><div style="position:relative">Regularly test your application in the sandbox environment before any production deployment.</div></li><li class="slate-li"><div style="position:relative">Keep your API keys or authentication credentials separate for each environment to enhance security and prevent accidental access to the production environment.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p>

The base URL is the root address for all API calls. Depending on the stage of development or deployment, you will use either the production or sandbox base URL. Ensure you are using the correct base URL to avoid unintended effects, such as affecting live data when testing.

The production environment is meant for live applications. When your application is ready for deployment and intended for real users, use the production base URL for all API requests.

The sandbox environment is a testing environment that mirrors the production environment but does not affect live data. Use the sandbox base URL for testing, development, and experimentation to ensure that your application behaves as expected before deploying it to production.

<p class="slate-p" placeholder="Type / for widgets"><span style="background-color:rgb(255, 255, 255);color:rgb(13, 13, 13);font-size:16px" class="slate-color"><span style="background-color:rgb(255, 255, 255);color:rgb(13, 13, 13);font-size:16px" class="slate-backgroundColor">The Payout API allows users to withdraw funds from their wallet using two methods: IMPS (Immediate Payment Service) and UPI (Unified Payments Interface). This document outlines the steps for initiating a payout, handling callbacks for transaction outcomes, and checking transaction status.</span></span></p><h2 class="slate-h2">1. Payout Methods</h2><h3 class="slate-h3">1.1 IMPS Transaction</h3><p class="slate-p" placeholder="Type / for widgets">To initiate a payout via IMPS, the user must provide their bank account details. The required information typically includes the account number, IFSC code, and the account holder&apos;s name.</p><h4 class="slate-h4">Request Parameters:</h4><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">beneficiaryAccount</code>: The bank account number of the user.</div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">beneficiaryIFSC</code>: The IFSC code of the user&apos;s bank branch.</div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">beneficiaryAddress</code>: The address of the account holder as per bank records.</div></li></ul><h3 class="slate-h3">1.2 UPI Transaction</h3><p class="slate-p" placeholder="Type / for widgets">For a UPI transaction, the user needs to provide their UPI ID. A UPI transaction is generally quicker and requires less information.</p><h4 class="slate-h4">Request Parameters:</h4><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">upi_id</code>: The UPI ID of the user (e.g., <code class="slate-code">test@icici </code>).</div></li></ul><h2 class="slate-h2">2. Transaction Callback</h2><p class="slate-p" placeholder="Type / for widgets">After a transaction is success/failed, a callback will be sent to a predefined URL with the transaction details. This callback contains information about the transaction&apos;s success or failure.</p><h2 class="slate-h2">3. Status API</h2><p class="slate-p" placeholder="Type / for widgets">The Status API can be used to check the current status of a transaction. This is useful for verifying transactions when a callback has not been received.</p><h3 class="slate-h3">Request:</h3><p class="slate-p" placeholder="Type / for widgets">To check the status of a transaction, the <code class="slate-code">orderId</code> must be provided.</p><h4 class="slate-h4">Request Parameters:</h4><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">orderId</code>: The unique identifier for the transaction whose status you wish to check.</div></li></ul><p class="slate-p" placeholder="Type / for widgets">
</p>

The Payout API allows users to withdraw funds from their wallet using two methods: IMPS (Immediate Payment Service) and UPI (Unified Payments Interface). This document outlines the steps for initiating a payout, handling callbacks for transaction outcomes, and checking transaction status.

To initiate a payout via IMPS, the user must provide their bank account details. The required information typically includes the account number, IFSC code, and the account holder's name.

For a UPI transaction, the user needs to provide their UPI ID. A UPI transaction is generally quicker and requires less information.

After a transaction is success/failed, a callback will be sent to a predefined URL with the transaction details. This callback contains information about the transaction's success or failure.

The Status API can be used to check the current status of a transaction. This is useful for verifying transactions when a callback has not been received.

To check the status of a transaction, the 

<p class="slate-p" placeholder="Type / for widgets">With Invoice Payin, you can start invoice transactions using the payment interface from efipay. </p><p class="slate-p" placeholder="Type / for widgets">Unlike S2S Payin, you don&apos;t have to handle designs. Simply use our payment page to collect payments from users.</p><p class="slate-p" placeholder="Type / for widgets"></p><ol class="slate-ol"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Create Transaction: </strong>Provide all required parameters to initialize the transaction. Upon completion, obtain the &quot;redirect_url&quot; from the response, which can be accessed via browser or utilized in your application as needed.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Get Transaction status:</strong> Monitor the transaction status through the dedicated API, providing updates on the ongoing verification process and allowing you to stay informed about the current status.</div></li></ol><p class="slate-p" placeholder="Type / for widgets"></p>

With Invoice Payin, you can start invoice transactions using the payment interface from efipay. 

Unlike S2S Payin, you don't have to handle designs. Simply use our payment page to collect payments from users.

<p class="slate-p" placeholder="Type / for widgets">For customizing your payment page with your brand design, leverage the S2S Payin API to access payment details and effortlessly update transactions. S2S Payin provides convenient REST API access for payment processing. Follow the outlined steps below for comprehensive guidance on integration and customization.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Follow the below steps to complete </strong></p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 1 - Create Transaction</strong>: Begin by creating a transaction using the API, ensuring all required parameters are filled, especially the accurate order_id, pivotal for retrieving payment information in the next step.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 2 - Get Payment Method</strong>: Retrieve payment method details by passing the order_id, acquiring essential information like QR Code or UPI details. Proceed to transfer money via UPI using this provided information.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 3 - Update Transaction:</strong> After completing the UPI payment, proceed to update the transaction by entering the UTR number and attaching the payment reference file. Once submitted, the transaction will be verified using the provided UTR number.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 4 - Get Transaction Status: </strong>Monitor the transaction status through the dedicated API, providing updates on the ongoing verification process and allowing you to stay informed about the current status.</p><p class="slate-p" placeholder="Type / for widgets"></p>

For customizing your payment page with your brand design, leverage the S2S Payin API to access payment details and effortlessly update transactions. S2S Payin provides convenient REST API access for payment processing. Follow the outlined steps below for comprehensive guidance on integration and customization.

: Begin by creating a transaction using the API, ensuring all required parameters are filled, especially the accurate order_id, pivotal for retrieving payment information in the next step.

: Retrieve payment method details by passing the order_id, acquiring essential information like QR Code or UPI details. Proceed to transfer money via UPI using this provided information.

 After completing the UPI payment, proceed to update the transaction by entering the UTR number and attaching the payment reference file. Once submitted, the transaction will be verified using the provided UTR number.

Monitor the transaction status through the dedicated API, providing updates on the ongoing verification process and allowing you to stay informed about the current status.

<p class="slate-p" placeholder="Type / for widgets">For customizing your payment page with your brand design, leverage the S2S Payin API to access payment details and effortlessly update transactions. S2S Payin provides convenient REST API access for payment processing. Follow the outlined steps below for comprehensive guidance on integration and customization.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Follow the below steps to complete </strong></p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 1 - Create Transaction</strong>: Begin by creating a transaction using the API, ensuring all required parameters are filled, especially the accurate order_id.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 2 - Redirection</strong>: You will get a redirection URL in the response, which is used to redirect back to the payment page where user can pay for the transaction.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 3 - Get Transaction Status: </strong>Monitor the transaction status through the dedicated API, providing updates on the ongoing verification process and allowing you to stay informed about the current status.</p><p class="slate-p" placeholder="Type / for widgets"></p>

: Begin by creating a transaction using the API, ensuring all required parameters are filled, especially the accurate order_id.

: You will get a redirection URL in the response, which is used to redirect back to the payment page where user can pay for the transaction.

<p class="slate-p" placeholder="Type / for widgets">This API is designed specifically for mobile applications to integrate a payment button, enabling a seamless redirection to the payment application installed on the user&apos;s device. Follow the outlined steps below for comprehensive guidance on integration and customization.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Follow the below steps to complete </strong></p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 1 - Create Transaction</strong>: Begin by creating a transaction using the API, ensuring all required parameters are filled, especially the accurate order_id.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 2 - Redirection</strong>: After successfully creating a transaction, you&apos;ll use the upi_url from the response in your website or mobile application to redirect the user to their payment application to complete the transaction.</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Step 3 - Get Transaction Status: </strong>Monitor the transaction status through the dedicated API, providing updates on the ongoing verification process and allowing you to stay informed about the current status.</p><p class="slate-p" placeholder="Type / for widgets"></p>

This API is designed specifically for mobile applications to integrate a payment button, enabling a seamless redirection to the payment application installed on the user's device. Follow the outlined steps below for comprehensive guidance on integration and customization.

: After successfully creating a transaction, you'll use the upi_url from the response in your website or mobile application to redirect the user to their payment application to complete the transaction.

<p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">1 . Where to find the saltKey or API key?</strong></p><p class="slate-p slate-indent-1" style="margin-left:24px" placeholder="Type / for widgets">Login into your account → Go to “Account Settings” → Check “View Api Key”/ “View Salt Key”</p><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">2. How long it will take to verify the transaction? </strong></p><p class="slate-p slate-indent-1" style="margin-left:24px" placeholder="Type / for widgets"> After the transaction initiated, it will take 15 to 20mins. if still not verified, please contact our support team. </p><p class="slate-p" placeholder="Type / for widgets"></p>

1 . Where to find the saltKey or API key?

Login into your account → Go to “Account Settings” → Check “View Api Key”/ “View Salt Key”

2. How long it will take to verify the transaction? 

 After the transaction initiated, it will take 15 to 20mins. if still not verified, please contact our support team. 

Sections