Getting Started
Introduction
Welcome to Aeropay’s API documentation. Aeropay facilitates smart bank transfers and direct bank connections for businesses and consumers. Aeropay's easy-to-implement payment SDKs, robust suite of APIs, and secure bank connection widgets provide solutions that cater to a variety of bank payment use cases.
Please use the following documentation to learn more about how you can integrate Aeropay into your platform.
Onboarding & Credentials
Before you begin, you will need access to the Aeropay sandbox environment. If you have not already received sandbox credentials, please fill out this form to connect with our team.
Environments
Aeropay has two environments: sandbox and production. The sandbox environment is used for integration and testing.
Ready to go live? Access to the production environment will be granted for processing live transactions after a review of your integration.
API URLs(sandbox) https://api.sandbox-pay.aero.inc/v2
(production) https://api.aeropay.com/v2
Integration Options
Aeropay supports two integration approaches. Choose the one that best fits your platform's needs and development resources.
API Integration
Build a fully custom payment experience using Aeropay's APIs. User creation and transactions are handled via API, and bank linking is powered by the Aerosync SDK.
Start with the API Quick Start.
SDK Integration
Embed Aeropay's turn-key payment widget into your platform. User creation, bank linking, and transactions are all packaged into a single SDK.
Start with the SDK Integration Guide.
Compare Integration Options
| API Integration | SDK Integration | |
|---|---|---|
| Timeline | ~2 weeks | < 1 week |
| UX | Fully embedded, white-labeled experience | Aeropay payment widget |
| User creation | API-based | Included in SDK |
| Bank linking | Aerosync SDK | Included in SDK |
| Transactions | API-based | Included in SDK |
| Transaction management | API-based | Merchant portal |
| Resources required | Full development team | Minimal development resources |
Updated about 17 hours ago
