Overview

In this quickstart guide, you'll learn the following key concepts involved with creating and managing subscriptions.

Key terms

• Subscription - An Aeropay Subscription Object is where funds will move from a user to a merchant on a specified, reoccurring date.
• Periodicity - How often the subscription will be billed. Subscriptions can be set to be billed Daily, Weekly, Monthly, or Yearly.
• User - A user associated with the authorized merchant.

Creating a subscription

This guide will walk you through the following steps to create a subscription and enroll users.

1. Authorizing your application via a token
2. Creating a subscription
3. Creating users & connecting user bank accounts.
4. Enrolling users to a subscription.
5. Managing subscriptions, enrollments, and subscription payments.

Before you begin

We encourage you to create a sandbox account, if you haven't already. This will allow you to follow along with the steps outlined in this guide. Reach out to your account manager or [email protected] to receive sandbox credentials.

After creating a sandbox account, you'll obtain your API key and Secret, which are used to obtain an OAuth access token. An access token is required in order to authenticate with the Aeropay API.

Lastly, in this sandbox walkthrough, we recommend having an active webhook subscription. This will help notify your application of various events that occur within the Aeropay API. Check out our API Reference to learn more.

Let's get started!