Introduction

Welcome to PayMongo

Hey there! We'd like to welcome you to our platform. PayMongo provides businesses an easy, user-friendly way to accept payments from their customers. This site contains all the resources you'll need to integrate your website or app with PayMongo APIs.

There are two sections to our documentation: Guides and API Reference.

Guides are here for both developers and non-developers to give a better idea of the underlying concepts behind payments and to also give a general workflow for integration.

The API References, on the other hand, will go into detail about each individual endpoint. If you are an experienced developer or have integrated payments before, feel free to go directly into detail about each of the APIs.

A little about the PayMongo API

We built the PayMongo API for those who want to directly integrate their site or app with PayMongo. Using the API allows you to take full control of the user's experience and integrate the payments directly with your systems and databases. The PayMongo API is RESTful and follows the JSON:API specifications for request bodies and responses. All response codes, authentication and verbs use standard HTTP. Our API is always available at https://api.paymongo.com.

Setting up your account

You can register for a free PayMongo account, with no set-up or integration fees. We've made a test mode available so you can play with the API without transferring any real money. During test mode, your interactions do not affect any live data or send real transactions through our network. This gives you the opportunity to thoroughly test your integration before going live.

Test mode is available upon sign up. To start accepting real payments, you'll need to activate your account and enable live mode. You may find the required steps for activation in the "Activate your account" section of the dashboard. These steps only show up when you have not activated your account yet. The keys you use to authenticate determine whether your request is in live mode or test mode.

Feedback and support

If you have any feedback about this documentation or the APIs, please feel free to reach out to us directly or click "suggest edits" at the top right of each article or section. Our APIs are constantly evolving; your inputs help us build the tools that fit your needs.

Lastly, if you have any questions that aren't answered here, you can always reach us with the site's support chat. You can find that on the bottom right of this site, the dashboard or the main homepage.