AtaraPay Docs

AtaraPay Docs

  • Integration
  • API Reference

›Integration Overview

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

Ground-up Development

Building website from ground-up

Below is the table showing the API/ end points you require, if you wish to integrate certain escrow features to your website. Suitable for eCommerce developments that are built from scratch.

S/NName of APIAPI URLFunction of the APICombination of APIs Required
1Standard IntegrationStandard Integration URLUsed for standard integration of escrow payments at checkout. It supports single and multi-vendor payments.
  1. Registration
  2. Standard Integration
2Inline IntegrationInline Integration URLUsed for inline integration of escrow payments at checkout. It supports single and multi-vendor payments.
  1. Registration
  2. Inline Integration
3Service Provider APIService Provider API URLUsed for handling payouts to service providers during commission-based transaction between you and the service provider
  1. Registration
  2. Inline Integration or Standard Integration
  3. Create Service Provider
  4. Get Service Provider
  5. Delete Service Provider
  6. Update Order Commission (Business Seller)
  7. Update Order Commission (Marketplace Operator)
  8. Marketplace Integration
4Milestone PaymentsMilestone Payments URLMilestone payments refer to the ability for the buyer to create multiple escrow transactions under one project. This allows the buyer to make payment to you per milestone. Each milestone is created under the project and adds up to the total project sum. You can add unlimited milestones under a project.
  1. Registration
  2. Milestone Payments
  3. Create Project
  4. Update Project
  5. Get Project
5Order Status AutomationOrder Status Automation URLFor convenience and seamless management of orders from a single view, we have developed APIs that expose these statuses to the eCommerce app.
  1. Registration
  2. Inline Integration or Standard Integration
  3. Order Status Automation
  4. Delivery Completed API.
  5. Seller Cancels Order API
  6. Buyer Cancels Order API
  7. Order Status API
6Notification for the OrdersNotification for the Orders URLOrder notification refers to status information being provided to eCommerce portals such as retail marketplaces, gig websites, delivery app services, etc. when certain actions are carried out from user dashboards on AtaraPay.
  1. Registration
  2. Inline Integration or Standard Integration
  3. Notification for the Orders
  4. Delivery Complete Notification
  5. Buyer Accept Notification
  6. Buyer Rejects Order Notification
  7. Buyer Cancels Order Notification
  8. Buyer Cancels Disputed Order Notification
  9. Seller Cancels Order Notification
  10. Seller Cancels Disputed Order Notification
  11. Second Delivery Attempt Notification
← Get StartedFramework Development →
  • Building website from ground-up
Docs
IntegrationeCommerce PluginsAPI ReferenceAtaraPay
Other Links
About UsFrequently Asked QuestionsReport a Bug
Merchants
BenefitsOur Merchants
Follow @atarapayonline
AtaraPay
Copyright © 2024 AtaraPay