Overview

what is Account API?

What is this and who is it for?

The Gravity Payments Account API allows platform partners to board new merchant accounts into our systems. It offers a REST interface for creating accounts, and webhook notifications for receiving updates on the status of an account as it moves through the creation process.

This API is suitable for you if you collect business information from merchants via your app or website and want to provide users a seamless signup experience for a Gravity Payments merchant services account. Using the API, you can submit the merchant's business information to our endpoint to initialize the account creation process. At the end of the process, you will have a live merchant services account ready for transactions to be processed.

Additional features of the API include the ability to order products, such as terminals and gateways, and the ability to specify different pricing configurations for account and processing fees.

Collecting the Data

The Account API will require that you collect some additional information from merchants than you may already collect, such as business entity type and card volumes. Hence, you'll need to build or adapt a form in your app to gather all the required information in order to submit it to the Account API. For details on the required data, see The Account Object.

How it works

A typical process flow for interacting with the Account API

The chart above illustrates a typical process flow for interacting with the Account API. Integration consists of two main components: a component that makes the account request, and a component that listens for webhook notifications and takes appropriate action. In addition to implementing these components, your app will need a mechanism for collecting the required merchant data and for directing the user to the Signing URL for them to e-sign the Account Agreement. If your product integrates with a select gateway, you'll also need to assign the received gateway credentials to the user's account in your system.

Overview


what is Account API?

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.