AtaraPay Docs

AtaraPay Docs

  • Integration
  • API Reference

›Resources

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

Product Features List

These are fully functioning features that come standard with the seller’s dashboard whether or not APIs or Plug-ins are deployed.

S NProduct FeatureFeature DescriptionDashboard Tab
1View VideosThe seller dashboard has YouTube videos located on strategic pages for the user to playback and get more understanding of the featureAtop the homepage page, Create P2P Transaction, Orders, Disputes
2Add Bank AccountsThis page provides the ability for the seller to add own bank details and those of their service providers. USD and NGN payout details are supportedPayout > Payout Details
3Verify Your IdentityThe seller uses this tool to verify their Identity before the first payout is made. This is done only oncePayout > Payout Details
4View Payout HistoryThis page provides the payout details such as amount, order ID, etc. for the seller and service providersPayout > Payout History
5Late cancellation feeThe seller can choose to set the time their customers are allowed to cancel after which a fee will apply which will be paid to them from their refund. No late cancellation fee is set by defaultDelivery Terms > Cancellation SLA, Delivery Terms > Cancellation Fee
6Refund policyThe seller can choose to allow refunds or only replacements. Refunds are allowed by defaultDelivery Terms > Refund Policy
7Non-split AmountThe seller can set the amount they do not want to split when the transaction involves a service provider. So, at payout, the seller will receive the non-split amount plus their share from the split with the service provider. No non-split amount is set by defaultDelivery Terms > Non-Split Amount
8Service Provider FeesThe seller uses this tool to indicate who pays service provider fees; Seller or Service Provider. The Seller is set by defaultDelivery Terms > Service Provider Fees
9Create a P2P TransactionThis button allows sellers to create an escrow transaction with their customer, if they do not have a website. The following transactions can be created;General, Project-based and Money marketCreate a P2P Transaction
10View P2P Transactions (Summary)This page provides the summary of P2P transactions that involve the seller such as item, amount, order ID, buyer name, status, creation date and the Action columnMy P2P Transactions
11View P2P Transactions (Detail)This page provides the details of P2P transactions such as product description, escrow and switch fee details, payment method used, contact details of the buyerMy P2P Transactions > View Transactions under the Action column against the order
12Cancel TransactionThe seller can cancel a Person to Person (P2P) transaction before the transaction is paid forMy P2P Transactions > Cancel Transaction under the Action column against the order
13Sharable Product LinkThe escrow form is pre-populated with product information such as quantity, description, price with an image and shared to customers who are then able to make payment without having to fill the form at allMy P2P Transactions > View Product Link
14View Order DetailsThis page provides the details of orders created and paid for via P2P or APIs through the seller’s website such as item, amount, order ID, buyer name, status, creation date and the Action columnOrders
15Add Service ProvidersThis function provides the ability to assign a service provider to an order created and paid for via P2P or APIs through the seller’s websiteOrders > Add Service Provider under the Action column against the order
16Complete DeliveryThis function provides the ability to indicate that the completion of the delivery for an order created and paid for via P2P or APIs through the seller’s websiteOrders > Complete Delivery under the Action column against the order
17Accept Part PaymentSellers can inform their customers to release part payment from escrow. Currently, customers can only release up to 50% of the product amount in escrow to the seller once and then the final payout is made after the buyer acceptsOrders > Release Part Payment under the Action column of the Buyer's dashboard
18Cancel TransactionThe seller can cancel a transaction created via P2P or APIs through the seller’s website after it has been paid for. If cancelled after payment is made, then the buyer will be refundedOrders > Cancel Order under the Action column against the order
19View Payment HistoryThis page provides details of orders that have been paid for such as order id, payment channel, payment number and payment datePayment History
20View DisputesThis page provides details of orders in dispute such as order ID, issue, creation date and the Action columnDisputes
21Cancel DisputesThis function allows the seller to cancel a dispute. If a dispute is cancelled by the seller, the buyer is refunded less applicable feesDisputes > Cancel Dispute under the Action column against the order
22Raise DisputesThis function allows the seller to formally raise a dispute. If a dispute is raised by the seller, our Dispute Managers will intercede within 24 hours to resolve the issue amicablyDisputes > Raise Dispute under the Action column against the order
23Sharable Payment LinkWhen this link is shared to the buyer, the seller’s details are pre-populated on the form, making it faster for the buyer to fill other parts of the form and make paymentSharable Link > Link Name
24Sharable Referral LinkWhen this link is shared to anyone, the seller enjoys discounts off the escrow fee, when the referral requirements are metSharable Link > Link Name
25Verify Your BVNThe seller uses this tool to verify their Bank Verification Number before the first payout is made. This is done only once (Only applicable to sellers located in Nigeria)Settings > BVN Verification
26Indicate Who Pays the Switch FeesThe seller uses this tool to indicate who pays switch fee; Seller or Buyer. The Seller is set by defaultSettings > Payment Switch Fees
27AtaraPay Mobile AppThe mobile app has all the features mentioned above and can be downloaded from the PlayStore or App StoreNA
← Marketplace Integration
Docs
IntegrationeCommerce PluginsAPI ReferenceAtaraPay
Other Links
About UsFrequently Asked QuestionsReport a Bug
Merchants
BenefitsOur Merchants
Follow @atarapayonline
AtaraPay
Copyright © 2022 AtaraPay