Airtm Payins API
# Payins The Payins API enables you to collect payments from users worldwide through their Airtm accounts. This is ideal for e-commerce platforms, service providers, and any business that needs to accept payments from customers across different countries and currencies. ## Overview Payins allow you to create payment requests that customers can fulfill using their Airtm account balance or connected payment methods. The system handles currency conversion, fee calculation, and provides a seamless checkout experience for your users. ## Key Features - **Global Payment Collection**: Accept payments from users in 190+ countries - **Multiple Payment Methods**: Users can pay with Airtm balance, bank transfers, or connected payment sources - **Itemized Billing**: Support for multiple items with quantities and individual pricing - **Automatic Currency Conversion**: Handle multiple currencies seamlessly - **Secure Checkout**: Hosted payment pages with built-in security - **Real-time Status Updates**: Track payment progress with webhooks and status polling - **Mobile Optimized**: Responsive design works across all devices ## How Payins Work ### Payment Flow 1. **Create Payment Request**: Generate a payin with item details and amounts 2. **Redirect Customer**: Send customer to Airtm's secure checkout page 3. **Customer Authentication**: User logs into their Airtm account 4. **Payment Processing**: Customer completes payment using available methods 5. **Confirmation**: Receive real-time notification of payment status 6. **Fulfillment**: Deliver goods or services upon successful payment ### Checkout Experience Customers are redirected to a secure Airtm-hosted checkout page where they can: - Review itemized billing and total amounts - Select their preferred payment method - Complete the transaction securely - Receive confirmation and receipts ## Checkout Integration ### Redirect URL Structure The checkout URL follows the pattern: `{baseUrl}/checkout/{id}` Where: - `baseUrl` is your environment's base URL - `id` is the payin identifier returned from creation ### Mobile Considerations For mobile applications, configure redirection links to open in the device's default browser rather than in-app web views. This ensures proper authentication flow and better user experience. ### Callback URLs Configure callback URLs to handle different payment outcomes: - **Confirmation URL**: Where customers are redirected after successful payment - **Failure URL**: Where customers go if payment fails - **Cancel URL**: Where customers are sent if they cancel the payment ## Item Management ### Itemized Billing Payins support detailed itemization with: - Individual item descriptions - Quantity and unit pricing