AtaraPay Docs

AtaraPay Docs

  • Integration
  • API Reference

›Milestone Payments

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

Milestone Payments

Milestone Payments refer to the ability for the buyer to create multiple escrow transactions under one main one. Each milestone must complete before the next commences. The completion includes the seller being paid (or buyer refunded) at the end of every milestone.

Milestone payments are useful for creating a project that has its deliverables divided into phases, making it possible to pay the seller in installments. Here, the buyer or seller creates a project, however only the buyer is able to add milestones to it. Each milestone represents an escrow transaction that must complete before the next milestone commences.

All other escrow features from AtaraPay work seamlessly with the solution.

Use Case

The project milestone API could be used in freelancer or delivery app marketplaces where service providers exist in a tripartite transaction involving service provider, buyer or client, and seller or marketplace operator.

In order to settle the seller and service providers, the developer is able to use the Service Provider APIs to associate each Service Provider to the respective order, enabling automatic payout of product amount and commission to the service provider and seller respectively. Cancellation fee will also be paid out to both parties, if the seller sets a delivery SLA. For details, see Service Provider API

Note

In order to deploy the solution, Milestone Payments APIs mentioned below are required in combination with the existing Standard Payment API. To create a milestone payment all that is required to be passed, along other payment parameters, is the project id (project_id). The milestone payment associates the project id to the order id created after a successful payment has been made into escrow.

There are basically three (3) APIs required to integrate to deploy AtaraPay milestone payment on your app;

  1. Create Project
  2. Update Project
  3. Get Projects
← Marketplace IntegrationCreate Project →
  • Note
Docs
IntegrationeCommerce PluginsAPI ReferenceAtaraPay
Other Links
About UsFrequently Asked QuestionsReport a Bug
Merchants
BenefitsOur Merchants
Follow @atarapayonline
AtaraPay
Copyright © 2024 AtaraPay