AtaraPay Docs

AtaraPay Docs

  • Integration
  • API Reference

›eCommerce Plugin

Integration Overview

  • Get Started
  • Ground-up Development
  • Framework Development

Authentication

  • Calculation of Auth Token

Payment Plugin

  • Inline Integration
  • Standard Integration
  • Go Live

eCommerce Plugin

  • WooCommerce Payment Plugin
  • Magento Payment Extension
  • Shopify Payment Plugin

Payouts

  • Service Provider API
  • Create Service Provider
  • Get Service Provider
  • Delete Service Provider
  • Update Order Commission (Business Seller)
  • Update Order Commission (Marketplace Operator)

Milestone Payments

  • Overview
  • Create Project
  • Update Project
  • Get Project

Order Status Automation

  • Overview
  • Delivery Completed API.
  • Seller Cancels Order API
  • Buyer Cancels Order API
  • Order Status API

Order Notification

  • Overview
  • Delivery Complete Notification
  • Buyer Accepts Order Notification
  • Buyer Rejects Order Notification
  • Buyer Cancels Order Notification
  • Buyer Cancels Disputed Order Notification
  • Seller Cancels Order Notification
  • Seller Cancels Disputed Order Notification
  • Second Delivery Attempt Notification
  • Generation of Security Token

Resources

  • Status Definition
  • Get Bank Details
  • Marketplace Integration
  • Product Features List

WooCommerce Payment Plugin

Installing the AtaraPay WooCommerce plugin on the WooCommerce store is a very simple, 4-staged process.

If you want to integrate to the plug-in as a Marketplace Operator, please visit the Marketplace Integration page for details on two options that we have available.

Stage 1: Retrieve the Test Public Key

For the first stage, please follow the steps below:

  1. Register your seller account on the AtaraPay test environment at http://staging.atarapay.com/#/register/seller/ Register as a Business or Individual seller or as a Marketplace Operator.
  2. Make sure you are able to successfully login to access your account.
  3. Go to the “API” tab on the sidebar, click “API Key” and copy ONLY the Public key as shown in the screenshot Figure 1

Stage 2: Installation

  1. Download the plugin zip file from the Wordpress Marketplace
  2. Login to your WordPress Admin. Click on "Plugins > Add New" from the left menu then click on upload. Figure 2
  3. After clicking the "Upload" option, then click "Choose File" to select the zip file you downloaded. Click "OK" and "Install Now" to complete the installation. Figure 3
  4. Activate the plugin.
  5. Click on "WooCommerce > Settings" from the left menu and click the "Payment" tab.
  6. Click on the "Setup" or "Manage" button infront of the AtaraPay Method Figure 4
  7. Configure the AtaraPay Payment Plugin settings accordingly.

Stage 3: Plugin Configuration

To configure the plugin, go to WooCommerce > Settings from the left menu, click Payment tab. Click on the "Setup" or "Manage" button infront of the AtaraPay Method.

  1. Your Callback URL – Copy the callback URL provided. Then login to your AtaraPay seller dashboard, navigate to the human icon at the top right > Settings > Callback URL. Click open the accordion and paste the URL into the text field and hit the Save button to save.
  2. Enable/Disable – Check the box to enable AtaraPay Payment Gateway.
  3. Test Mode – Check the box to enable Test Mode if you are using a test key for setup purpose, once you are done testing remember to uncheck the Test Mode to enable LIVE usage.
  4. Test Public Key – Input the Public Key generated from your http://staging.atarapay.com seller account under the API tab
  5. Test Private Key – Input the Test Private Key generated from your http://staging.atarapay.com seller account under the API tab.
  6. MarketPlace – Do not check the box Enable MarketPlace Mode, even if you registered on AtaraPay as a registered Marketplace Operator. You will still achieve the desired result even if your portal is a marketplace.
  7. Split Payment – Check Allow Service Provider Payout, if you want to include service providers in commission-based transactions. If not, leave unchecked.

Figure 5

Stage 4: Add Service Providers

  1. To add service providers, navigate to AtaraPay tab on the left pane of your WordPress admin dashboard. Here you can add service providers and also see service providers that were already created by you on your AtaraPay dashboard. (Please note that you must first add your own account in your AtaraPay dashboard in order to see the list of service providers on this page).
  2. To add your own bank account, login to your seller account at http://staging.atarapay.com, then navigate to Payout > Payout Details and click the Add Bank Details button to add your own bank account.
  3. You can add service providers from your AtaraPay or WordPress admin dashboards.
  4. To associate service provider and their commission per product, login to your WordPress admin dashboard, then navigate to Product > Add New > General to add a new product or Product > All Products to edit an existing one.
  5. If you are registered and integrating to the plug-in as a Marketplace Operator, send the following to support@atarapay.com;
    1. List of AtaraPay registered phone numbers of your merchants that are signed up on AtaraPay
    2. Your registered phone number with AtaraPay. ] This will enable us associate your AtaraPay registered merchants with your Marketplace account.

Go-Live

Once you are done testing and ready to go live, reference steps 3, 4 and 5 under stage 3 above and do the following;

  1. Uncheck Test Mode
  2. Replace the test keys with the live Public and Private Keys generated from your live seller account which you are to create on https://app.atarapay.com seller account

Note

The cart can not contain products or services from more than one service provider. The merchant shall be responsible to ensure this on their website.

← Go LiveMagento Payment Extension →
  • Stage 1: Retrieve the Test Public Key
  • Stage 2: Installation
  • Stage 3: Plugin Configuration
  • Stage 4: Add Service Providers
  • Go-Live
  • Note
Docs
IntegrationeCommerce PluginsAPI ReferenceAtaraPay
Other Links
About UsFrequently Asked QuestionsReport a Bug
Merchants
BenefitsOur Merchants
Follow @atarapayonline
AtaraPay
Copyright © 2024 AtaraPay