Getting Started - Overview

Welcome to our API documentation!

This documentation describes the resources that make up the Zoop API. The API conforms to the design principles of Representational State Transfer (REST). All API responses are in JSON data format.

With the Zoop API, you can instantly and securely accept card-present and card-not-present payments straight from your App on any platform or device.

We've created this API to enable you and other clever developers to invent great new ways to transform the generally unmagical burden of exchanging money for goods and services. With just a few lines of code and you are ready to go. Our credit card reader SDK takes the headache out of your integration and this RESTful API gets you paid. We got you covered!

Using REST

  • Methods to retrieve data from the Zoop API require an HTTP GET request.
  • Methods that submit data to the Zoop API require an HTTP POST request.
  • Methods that change data in the Zoop API require an HTTP PUT request.
  • Methods that destroy data in the Zoop API require an HTTP DELETE request.

Follow us & get updated!

Join our community to be notified of API changes and stay up to date.

If you have technical questions about the API, please email api@pagzoop.com.

For general communication, including media and partnership enquiries, please get in touch at hello@pagzoop.com


API Endpoints

Default Base URL

https://api.zoop.ws

Available resources

/v1/marketplaces/{marketplace_id}/buyers
/v1/marketplaces/{marketplace_id}/buyers/{id}
/v1/marketplaces/{marketplace_id}/sellers/individuals
/v1/marketplaces/{marketplace_id}/sellers/businesses
/v1/marketplaces/{marketplace_id}/sellers/{id}
/v1/marketplaces/{marketplace_id}/sellers/{id}/transfers
/v1/marketplaces/{marketplace_id}/sellers/{id}/transactions
/v1/marketplaces/{marketplace_id}/cards
/v1/marketplaces/{marketplace_id}/cards/{id}
/v1/marketplaces/{marketplace_id}/cards/tokens
/v1/marketplaces/{marketplace_id}/bankaccounts
/v1/marketplaces/{marketplace_id}/bankaccounts/{id}
/v1/marketplaces/{marketplace_id}/bankaccounts/tokens
/v1/marketplaces/{marketplace_id}/bankaccounts/{id}/transfers
/v1/marketplaces/{marketplace_id}/tokens/{id}
/v1/marketplaces/{marketplace_id}/transactions
/v1/marketplaces/{marketplace_id}/transactions/{id}
/v1/marketplaces/{marketplace_id}/transfers
/v1/marketplaces/{marketplace_id}/transfers/{id}
/v1/marketplaces/{marketplace_id}/webhooks
/v1/marketplaces/{marketplace_id}/webhooks/{id}

Learn How to Get Started

Never built an app with credit card payment integration before? Don't worry. You can start integrating card-present and card-not-present payment capabilities into your apps in a snap.

We believe that examples are the best way to learn more about the Zoop API and how it works. So here, you’ll find step-by-step instructions on how to build your app.


Zoop Marketplace API

Unlike traditional ecommerce/online sites or apps, that have one seller and many buyers, marketplaces have multiple sellers and buyers. In addition, any transaction involves three parties: the seller, buyer and the marketplace. This uniqueness has always created challenges for marketplaces wanting to accept payments.

Sharing economy business models emerge from our oldest instincts as humans -– cooperation, sharing, generosity, individual choice and flexibility. Models include renting, bartering, loaning, gifting, swapping and forms of shared ownership such as cooperative structures. Most sharing economy structures are enabled by new technologies of connection and payments, such as Zoop. The most popular structures include:

  • Peer-to-peer marketplaces: In this model, individuals transact directly with other individuals on a two-sided marketplace platform maintained by a third party. In two-sided marketplaces, the development, maintenance and policies of the platform are maintained by the third party, which can be an organization, a business or a government. These are not strictly P2P systems in the technical sense as there is generally a central market platform that enables the transactions. Examples include Airbnb and Krrb.
  • Crowdfunding platforms: These models also use a two-sided marketplace to enable individuals to contribute funds to entrepreneurs, artists, civic programs and projects. Examples include Kickstarter and Indiegogo.
  • Innovation marketplaces: These marketplaces enable individuals and professionals to share their intellectual capital to solve problems. Examples include Architecture for Humanity and Innocentive.

Many of the most popular models are based on what is called a "two-sided market" which is a market where an information technology-enabled platform is developed, built and maintained by a third party but the function of the platform is to enable sharing economy activities.

To support these scenarios we created the Zoop Marketplace API. Zoop Marketplace streamlines payments for your marketplace, enabling you to automatically split your transaction or hold funds in escrow, on a per transaction basis (you can change the split from transaction to transaction). Built with mobile in mind from signup to checkout for a seamless experience for buyers and sellers.

A Single-Merchant application is an application that charges buyers directly and all money is received by the application. On the other hand, a Platform or Marketplace application facilitates transactions between two users: a buyer and a seller. This documentation is specifically meant for Marketplace apps.


Ready to Get Started?

Sign up to use Zoop API. Get your keys and start making API calls.