ePay User Guide

How to Get Started

1. Create an Account

   To start using TAMAYYUZ ePay, the first step is to create an account. Go to the registration page, provide your information, and activate your account as requested in the platform.

   

   Once your account is set up, you'll have the option to create multiple applications within the same account.

2. Create an Application or Update the existing one

   An application represents a unique project, website, or business entity. Each application is a self-contained environment that allows you to manage your payment integration independently. When you create an application, you receive a unique API key and secret key, which are used to authenticate and secure transactions for that specific application.

   Think of an application as a container for your payment settings and transaction history. This means that each application has its own isolated transaction records, ensuring that payments and orders are clearly attributed to the correct project or website. Additionally, using separate applications for different projects helps prevent conflicts between order numbers, as each website maintains its own numbering system. This flexibility allows you to organize your payment integrations efficiently and scale your business with ease.

   When you first set up your account, a default application named "My new app" is created automatically. You can edit this application or create new ones as needed to manage multiple projects or websites.

   2.1. Click on the current application's name on the left sidebar.

   2.2. Click on the New application button.

   

3. Activate ePayment

   3.1. Add your bank account information. This account will be used to receive your payouts and/or direct payments.

   

   3.2. Click on the Activate Epay button and fill in required information. Wait for a member of our team to review and approve your activation request.

   
   

   If you don't have an RC, please enter N/A in the corresponding fields. In this case, please make sure your profile information is correct, and upload your identity proof (ID card).

   3.3. After your ePayment is activated, you can start accepting payments. For this, you will get API KEY and SECRET KEY.

   

   3.4. Register your webhook URL. To register your webhook URL, go to your Application, click "Edit BusinessApp", then edit and save your webhook URL.

   Note:

   • It is possible to edit an existing application. Access it by clicking on the application's name and edit the desired information. Please note that after e-payment activation, it will not be possible to edit a number of fields on the application.

   Important:

   • To process payments, you must activate your User Account and request ePay activation.

   • Make sure to NEVER share your keys in public places such as GitHub or client-side code.

4. Use the e-Payment Functionality

   Using the API key and secret key, you can configure your website to start accepting electronic payments.

   The configuration depends on the type of the website. For example, for WordPress websites, you simply install our WordPress plugin and add the keys to its configuration as shown below.

   

   For all types of websites (languages & frameworks), please check this documentation for the integration steps - Developer Guide.

Payments and Payouts

As buyers are paying for the goods that you sell on your websites, transactions are made through our ePay gateway.

Here's how these transactions relate to bills and withdrawals.

1. Transactions

   A transaction occurs whenever a buyer completes a payment for a purchase on your website. This can include purchases of physical goods, digital products, or services.

   Transactions can be successful (approved) or unsuccessful (declined). Successful transactions result in funds being held in your account which you can request their transfer to your bank account via a withdrawal request.

   For example, for a successful payment of 4000 DA, your account will have an available balance to withdraw of 3940 DA, if we consider a fee of 1.5%.

   

2. Bills

   Bills refer to the payment you make to us. You will see the current amount due to pay on your Bills screen.

   

   This amount is the total of the possible fees below:

   • Fees of successful withdrawals – check our pricing page for details.
   • The final customer refund amounts (case of Intermediary Merchant and Indirect Merchant)*
   • Fees of successful transactions if the payment was made to the customer's bank account directly (case of Direct Merchant)*

   Please check merchant types in the section "Fees" below

3. Withdrawals

   A withdrawal is the process of transferring funds from your merchant account to your bank account. This is how you receive the money from successful transactions.

   After transactions are settled, you can initiate a withdrawal to move the funds to your bank account. Withdrawals are typically subject to processing times and incur different fees depending on the merchant type.

4. Fees

   We define the following merchant types:

   • Direct Merchant: A merchant who has established a web merchant contract with their bank, accepts electronic payments, and made an agreement with us to receive the final consumer payment directly into their bank account.
   • Intermediary Merchant: A merchant who has established a web merchant contract with their bank but does not receive the final consumer payment directly. Our e-pay platform collects the payment and makes an electronic payout to the merchant.
   • Indirect Merchant: A merchant who has not established a web merchant contract with their bank. Our e-pay platform collects the final consumer payment and makes a bank transfer to the merchant.

   By default, a new customer is created as an Indirect Merchant. Upon request from users, we may validate switching this user from the Indirect Merchant to the other types. For additional information regarding our pricing and available plans, please visit [our pricing page].

How to Integrate TAMAYYUZ ePay into Your Website/Application

1. WooCommerce Plugin

   First, download the WooCommerce Plugin that we send you after registration.

   Next, watch the video tutorial for installation and configuration instructions. The video will be available soon.

2. Other Languages and Platforms

   Please visit our TAMAYYUZ ePay Developer Guide for a detailed description of how to integrate electronic payments into your website or application.