Overview

In this quickstart guide, you’ll learn the following key concepts involved with creating a preauthorized transaction from your Customer’s bank account.

Key terms

• Preauthorized Transaction - A temporary transaction that stores the payment details. A preauth transaction does not move funds. Preauthorized transaction can be updated at any point before it is captured via the /capturePreauthTransaction call.
• Capture a Preauthorized Transaction - Capturing a preauthorized transaction with /capturePreauthTransaction creates an Aeropay Transaction and initiates the movement of funds.
• User - A user associated with the authorized merchant.
• Aerosync - A bank aggregator allowing your user to link a bank account.

Creating a Preauth Transaction

This guide will walk you through the following steps to create a preauthorized transaction to receive funds.

1. Authorizing your application via a token
2. Creating a User
3. Attaching a funding source (bank account) to the Customer
4. Creating the Preauthorized Transaction
5. Updating a Preauthorized transaction
6. Capturing the Preauthorized Transaction

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 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 against 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!