# Airtm Payins API

**Canonical:** https://apis.io/apis/airtm/airtm-payins-api/  
**Provider:** Airtm — https://apis.io/providers/airtm/  
**Base URL:** https://api.enterprise.airtm.com/v2  
**Documentation:** https://docs.airtm.com/

Airtm Payins API is one of 24 APIs that [Airtm](https://apis.io/providers/airtm/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Payins. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

# 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

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/airtm/refs/heads/main/openapi/airtm-payins-api-openapi.yml
- **Documentation** — https://docs.airtm.com/
- **APIReference** — https://docs.airtm.com/
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/airtm/refs/heads/main/asyncapi/airtm-webhooks.yml

## Other Airtm APIs (12)

- [Airtm Wallet Resource (Connect) API](https://apis.io/apis/airtm/airtm-wallet-resource-connect-api/)
- [Airtm Account Status API](https://apis.io/apis/airtm/airtm-account-status-api/)
- [Airtm API Keys API](https://apis.io/apis/airtm/airtm-apikeys-api/)
- [Airtm Bulk Payments API](https://apis.io/apis/airtm/airtm-bulk-payments-api/)
- [Airtm Bulk Payouts API](https://apis.io/apis/airtm/airtm-bulk-payouts-api/)
- [Airtm Deposits API](https://apis.io/apis/airtm/airtm-deposits-api/)
- [Airtm Embedded Catalog API](https://apis.io/apis/airtm/airtm-embedded-catalog-api/)
- [Airtm Embedded Quotes API](https://apis.io/apis/airtm/airtm-embedded-quotes-api/)
- [Airtm Embedded Receivers API](https://apis.io/apis/airtm/airtm-embedded-receivers-api/)
- [Airtm Embedded Senders API](https://apis.io/apis/airtm/airtm-embedded-senders-api/)
- [Airtm Embedded Transactions API](https://apis.io/apis/airtm/airtm-embedded-transactions-api/)
- [Airtm External Bank Account API](https://apis.io/apis/airtm/airtm-external-bank-account-api/)

## Tags

Payins

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/airtm/airtm-payins-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/airtm/.