​

Payments API

The Payments API provides multiple funding options for deposits and withdrawals. Users can fund their accounts via bank transfers (ACH) through Aeropay or card payments through Checkout.com.

​

Payment Methods

​

APIs

​

Aeropay API

Bank account linking and ACH transfers. Orchestrated Endpoints (Recommended): Aeropay Integration Guide

​

Checkout API

Card payment processing: Checkout Integration Guide

​

Funding API

Manage funding sources and transactions: Funding Management

​

Typical Integration Flow

​

New User Onboarding

​

Deposit Flow

1. Select funding source - User chooses linked bank/card
2. Check limits - Validate amount against transaction limits
3. Enter amount - Collect deposit amount
4. Confirm - Process the deposit
5. Track status - Monitor transaction completion

​

Withdrawal Flow

1. Check requirements - Get withdrawal requirements from funding source
2. Select destination - User chooses where to send funds
3. Enter amount - Validate against available balance and requirements
4. Confirm - Process the withdrawal
5. Track status - Monitor transaction completion

​

Funding Source Types

The FundingSourceType enum identifies the payment method:

​

Transaction States

​

Transaction Types

​

Best Practices

1. Use orchestrated endpoints - For Aeropay, use /v1/aeropay/initialize instead of primitive endpoints
2. Check limits before transactions - Use the Aeropay methods or funding transaction requirements APIs
3. Check withdrawal requirements - Always check withdrawal requirements before processing
4. Handle all states - Implement UI for pending, success, and failure
5. Implement webhooks - Don’t rely solely on polling for status updates
6. Validate amounts client-side - Reduce failed API calls
7. Store payment method IDs - Cache linked payment methods for faster checkout