Airtm

aid: airtm
name: Airtm
description: 'Airtm is a US-registered (Airtm Inc., Delaware; FinCEN MSB #31000329787639) digital dollar wallet and cross-border
  payments network operating since 2015, built for freelancers, remote workers, contractors and businesses in emerging markets.
  Balances are held as USDC on Stellar and can be moved in and out through 500+ local payment methods, a US virtual account
  with ACH details, a USD virtual card, and peer-to-peer transfer. For businesses, Airtm publishes the Enterprise Payments
  API — a REST API for programmatic payouts to recipients in 190+ countries, hosted-checkout payins, bulk payouts, external
  bank and crypto accounts, withdrawals and reporting — plus an OAuth 2.0 / OIDC authorization server and a Wallet Resource
  (Connect) API that lets a partner application move value in and out of an individual user''s Airtm wallet on that user''s
  behalf.'
url: https://raw.githubusercontent.com/api-evangelist/airtm/refs/heads/main/apis.yml
image: https://app.airtm.com/favicon.ico
x-type: company
x-source: harvest:secondary-market
specificationVersion: '0.21'
created: '2026-08-06'
modified: '2026-08-06'
tags:
- payments
- payouts
- cross-border-payments
- fintech
- digital-wallet
- stablecoin
- usdc
- stellar
- mass-payouts
- remittances
- latin-america
- emerging-markets
- money-services-business
- oauth2
- openid-connect
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
apis:
- name: Airtm Wallet Resource (Connect) API
  description: The OAuth 2.0 resource server that lets a partner application move USDC in and out of an individual Airtm user's
    wallet on that user's behalf, read the wallet balance, and check KYC status. Authorized with bearer access tokens issued
    by the Airtm OIDC authorization server and gated per endpoint by the wallet:read, wallet:receive, wallet:send and kyc:status
    scopes. Quotes and transactions require an Idempotency-Key header; every wallet:send transaction is confirmed by the user
    with a one-time code. Documented in the Enterprise API reference; no standalone machine-readable spec is published for
    it.
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/api/connect/v1
  tags:
  - wallet
  - oauth2
  - openid-connect
  - stablecoin
  - usdc
  - stellar
  properties:
  - type: Documentation
    url: https://docs.airtm.com/
  - type: OAuthScopes
    url: scopes/airtm-scopes.yml
  - type: OpenIDConnect
    url: well-known/airtm-openid-configuration.json
- aid: airtm:airtm-account-status-api
  name: Airtm Account Status API
  description: '## Overview


    The Account Status endpoint enables your organization to verify recipient account information before initiating payments.
    This powerful verification tool helps prevent payment failures, reduces transaction costs, and ensures smooth payment
    processing by validating recipient details and account capabilities in advance.


    ## What is Account Status Verification?


    Account Status Verification allows you to check the current status and capabilities of any Airtm user account by providing
    their email address. This pre-payment verification process helps identify potential issues before processing transactions,
    improving success rates and reducing operational overhead.'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Account Status
  properties:
  - type: OpenAPI
    url: openapi/airtm-account-status-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-apikeys-api
  name: Airtm API Keys API
  description: The ApiKeys API from Airtm — 3 operation(s) for apikeys.
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - ApiKeys
  properties:
  - type: OpenAPI
    url: openapi/airtm-apikeys-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-bulk-payments-api
  name: Airtm Bulk Payments API
  description: '## Overview


    Bulk Payments enable your organization to process multiple payouts simultaneously through a single API operation. This
    powerful feature is designed for businesses that need to send payments to large numbers of recipients efficiently, such
    as payroll processing, affiliate commissions, contractor payments, or distribution of rewards and bonuses.


    ## What are Bulk Payments?


    Bulk Payments allow you to upload a batch of payout instructions and process them all at once, rather than making individual
    API calls for each payment. This approach offers significant advantages in terms of efficiency, cost-effectiveness, and
    operational simplicity.


    ### Key Features


    - **High-Volume Processing** - Handle thousands of payments in a single operation

    - **Asynchronous Processing** - Non-blocking operations that scale with your needs

    - **Real-Time Progress Tracking** - Monitor batch processing status in real-time

    - **Detailed Reporting** - Comprehensive success and failure reporting

    - **Cost Efficiency** - Reduced API calls and processing overhead


    ### Use Cases


    - **Payroll Processing** - Monthly/weekly employee salary payments

    - **Contractor Payments** - Freelancer and contractor compensation

    - **Affiliate Commissions** - Partner and affiliate reward distribution

    - **Prize Distribution** - Contest and promotion prize payments

    - **Supplier Payments** - Vendor and supplier payment processing

    - **Refund Processing** - Bulk customer refund operations


    ## Bulk Payment Workflow


    ### 1. Preparation Phase


    - Validate recipient information

    - Calculate total amounts and fees

    - Ensure sufficient account balance


    ### 2. Upload Phase


    - Submit bulk payment request

    - Receive batch ID for tracking

    - System validates all entries

    - Initial status: `pending`


    ### 3. Processing Phase


    - Individual payments are processed asynchronously

    - Real-time status updates available

    - Status changes to `running`

    - Progress tracking via API


    ### 4. Completion Phase


    - All payments processed (success or failure)

    - Final status: `done`

    - Detailed reports available

    - Success and failure breakdowns provided


    ## Status Management


    ### Bulk Payment Status Values


    | Status    | Description                                                | Actions Available                         |

    | --------- | ---------------------------------------------------------- | ----------------------------------------- |

    | `pending` | The bulk payment was received but it has yet to be started | Cancel entire batch                       |

    | `running` | Individual payments being processed                        | Monitor progress, cancel pending payments |

    | `done`    | All payments processed (success or failure)                | View reports, download results            |

    | `failed`  | An error occurred during processing                        | check the errors endpoint                 |'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Bulk Payments
  properties:
  - type: OpenAPI
    url: openapi/airtm-bulk-payments-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-bulk-payouts-api
  name: Airtm Bulk Payouts API
  description: '# Bulk Payouts


    Process multiple payouts efficiently in a single batch operation. Ideal for payroll, affiliate payments, or mass distributions.


    ## Overview


    Bulk payouts allow you to submit hundreds or thousands of payout instructions and process them as a coordinated batch,
    providing better performance and easier management than individual payouts.


    ## How It Works


    1. **Prepare** your payout data with recipient emails and amounts

    2. **Submit** the bulk payout request

    3. **Validation** - System validates all payouts and checks balance

    4. **Processing** - Individual payouts are processed in parallel

    5. **Track** progress and handle any failures


    ## Validation Rules


    ### Amount Validation


    - Minimum amount: $0.01. If the recipient is a US resident, the minimum amount may be larger.

    - Maximum 2 decimal places allowed

    - Enterprise fee cannot equal or exceed payout amount (unless negative for bonuses)

    - Airtm fee cannot equal or exceed net amount (amount - enterprise fee)


    ### Data Validation


    - Email addresses must be valid format and correspond to active Airtm accounts

    - Notes field is required and cannot exceed 255 characters

    - No malicious patterns allowed in text fields (SQL injection protection)

    - URLs must be valid format when provided


    ### Batch Validation


    - No duplicate payouts within batch (based on email + amount + notes)

    - Total batch amount cannot exceed available account balance'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Bulk Payouts
  properties:
  - type: OpenAPI
    url: openapi/airtm-bulk-payouts-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-deposits-api
  name: Airtm Deposits API
  description: '# Deposits


    The Deposits API provides comprehensive tracking and management of funding transactions for your Airtm Enterprise account.
    This endpoint enables you to monitor incoming funds, track deposit history, and manage your account''s funding sources
    for seamless payment operations.


    ## Overview


    Deposits represent incoming funds to your enterprise account from various sources including bank transfers, wire transfers,
    and other funding methods. The API provides detailed tracking of these transactions, enabling better cash flow management
    and financial reconciliation.


    ## Key Features


    - **Transaction Tracking**: Monitor all incoming fund deposits with detailed status information

    - **Multi-Source Support**: Track deposits from various funding sources and payment methods

    - **Real-time Status**: Get current deposit status and processing information

    - **Historical Data**: Access complete deposit history with filtering and pagination

    - **Metadata Access**: Retrieve detailed transaction information and processing details

    - **Balance Integration**: Understand how deposits affect your account balance


    ## How Deposits Work


    ### Funding Process


    1. **Initiate Funding**: Start a deposit through your preferred funding method

    2. **Processing**: External payment systems process the incoming transfer

    3. **Tracking**: Monitor deposit status through the API

    4. **Completion**: Funds become available in your enterprise account

    5. **Notification**: Receive confirmation of successful deposit

    6. **Balance Update**: Account balance reflects the new funds


    ### Deposit Sources


    Deposits can originate from various sources:


    - Bank wire transfers

    - ACH transfers

    - International bank transfers

    - Partner funding arrangements'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Deposits
  properties:
  - type: OpenAPI
    url: openapi/airtm-deposits-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-embedded-catalog-api
  name: Airtm Embedded Catalog API
  description: The Embedded Catalog API from Airtm — 1 operation(s) for embedded catalog.
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Embedded Catalog
  properties:
  - type: OpenAPI
    url: openapi/airtm-embedded-catalog-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-embedded-quotes-api
  name: Airtm Embedded Quotes API
  description: The Embedded Quotes API from Airtm — 1 operation(s) for embedded quotes.
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Embedded Quotes
  properties:
  - type: OpenAPI
    url: openapi/airtm-embedded-quotes-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-embedded-receivers-api
  name: Airtm Embedded Receivers API
  description: The Embedded Receivers API from Airtm — 4 operation(s) for embedded receivers.
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Embedded Receivers
  properties:
  - type: OpenAPI
    url: openapi/airtm-embedded-receivers-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-embedded-senders-api
  name: Airtm Embedded Senders API
  description: The Embedded Senders API from Airtm — 2 operation(s) for embedded senders.
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Embedded Senders
  properties:
  - type: OpenAPI
    url: openapi/airtm-embedded-senders-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-embedded-transactions-api
  name: Airtm Embedded Transactions API
  description: The Embedded Transactions API from Airtm — 2 operation(s) for embedded transactions.
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Embedded Transactions
  properties:
  - type: OpenAPI
    url: openapi/airtm-embedded-transactions-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-external-bank-account-api
  name: Airtm External Bank Account API
  description: '# External Bank Account


    The external bank account API provides the capability to register an external bank account where you can withdraw your
    funds to.'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - External Bank Account
  properties:
  - type: OpenAPI
    url: openapi/airtm-external-bank-account-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-external-crypto-account-api
  name: Airtm External Crypto Account API
  description: '# External Crypto Account


    The external crypto account API provides the capability to register an external crypto account where you can withdraw
    your funds to.'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - External Crypto Account
  properties:
  - type: OpenAPI
    url: openapi/airtm-external-crypto-account-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-me-api
  name: Airtm Me API
  description: '# Account Management


    The Account Management API provides essential information about your Airtm Enterprise account, including account details,
    balance information, and configuration settings. This endpoint serves as your primary source for account status and financial
    data.


    ## Overview


    Account management functionality enables you to monitor your enterprise account status, check available balances, and
    access important configuration details needed for payment processing. This information is crucial for managing cash flow,
    monitoring transaction capacity, and ensuring smooth payment operations.


    ## Key Features


    - **Account Information**: Access enterprise account details and settings

    - **Balance Monitoring**: Real-time balance information

    - **Configuration Access**: Retrieve account settings and limits

    - **Administrative Data**: Access enterprise-specific configuration details'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Me
  properties:
  - type: OpenAPI
    url: openapi/airtm-me-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-operations-api
  name: Airtm Operations API
  description: '## Overview


    The Operations endpoint serves as the central hub for tracking all transaction-related activities within the Airtm Enterprise
    ecosystem. This comprehensive endpoint consolidates information about **Purchases**, **Pay-ins**, **Payouts**, and **Payments**,
    providing a unified view of all financial movements between Airtm accounts.


    ## What are Operations?


    Operations represent any transaction that involves the movement of funds within the Airtm platform. Every financial activity
    generates an operation record that can be tracked and monitored through this endpoint.


    ### Operation Types


    | Type                   | Description                                    | Use Case                                    |

    | ---------------------- | ---------------------------------------------- | -------------------------------------------
    |

    | **Purchases / Payins** | Payments made by users for products/services   | E-commerce transactions, service payments   |

    | **Payments / Payouts** | Outgoing payments from your enterprise account | Employee payments, contractor fees, refunds
    |'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Operations
  properties:
  - type: OpenAPI
    url: openapi/airtm-operations-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-partner-api
  name: Airtm Partner API
  description: '## Overview


    The Partner endpoint provides essential information about your Airtm Enterprise account, including account details, configuration
    settings, balance information, and operational status. This endpoint serves as the central hub for managing your partner
    account and accessing critical business information.


    ## What is a Partner Account?


    A Partner account is your organization''s primary interface with the Airtm Enterprise ecosystem. It represents your business
    entity within the platform and contains all the necessary information for API operations, financial transactions, and
    account management.'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Partner
  properties:
  - type: OpenAPI
    url: openapi/airtm-partner-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-payins-api
  name: Airtm Payins API
  description: '# 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'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Payins
  properties:
  - type: OpenAPI
    url: openapi/airtm-payins-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-payments-payouts-api
  name: Airtm Payments / Payouts API
  description: "## Overview\n\nThe Payouts endpoint enables your organization to send payments to recipients worldwide through\
    \ the Airtm platform. This powerful endpoint supports both individual and bulk payment processing, making it ideal for\
    \ paying employees, contractors, freelancers, vendors, or any other recipients who have Airtm accounts.\n\n## What are\
    \ Payouts?\n\nPayouts represent outgoing payments from your enterprise account to recipient users. The payout process\
    \ is designed to be flexible, secure, and reliable, with multiple options for creating and managing payments based on\
    \ your specific needs.\n\n### Key Features\n\n- **Two-Step or One-Step Processing** - Choose your preferred workflow\n\
    - **Real-Time Status Tracking** - Monitor payment progress instantly\n- **Comprehensive Recipient Management** - Support\
    \ for new and existing users\n- **Webhook Integration** - Receive instant status notifications\n\n## Payment Processing\
    \ Options\n\n### 1. Two-Step Process (Create + Commit)\n\n**Best for:** Careful review and approval workflows\n\n1. **Create\
    \ Payout** - Generate payout instruction\n2. **Review Details** - Verify recipient and amount information\n3. **Commit\
    \ Payout** - Execute the payment\n\n### 2. One-Step Process (Direct)\n\n**Best for:** Automated systems and immediate\
    \ processing\n\n- **Create and Execute** - Single API call processes payment immediately\n- **Streamlined Workflow** -\
    \ Reduces API calls and complexity\n- **Instant Processing** - Payment begins processing immediately\n\n## Status Management\n\
    \n### Payout Status Values\n\n| Status      | Final? | Description                                                   \
    \   | Next Actions                |\n| ----------- | ------ | ----------------------------------------------------------------\
    \ | --------------------------- |\n| `created`   | No     | Payout instruction created, awaiting commit              \
    \        | Call commit endpoint        |\n| `committed` | No     | Payout committed and queued for processing        \
    \               | Monitor status updates      |\n| `pending`   | No     | Awaiting recipient action (account creation,\
    \ verification, etc.) | Wait for recipient action   |\n| `completed` | Yes    | Payment successfully delivered to recipient\
    \                      | None - payment complete     |\n| `canceled`  | Yes    | Payout canceled, funds returned to sender\
    \                        | None - transaction reversed |\n| `failed`    | Yes    | Payment failed due to processing error\
    \                           | Contact support if needed   |\n\n### Detailed Status Descriptions\n\n#### Created Status\n\
    \n- Payout instruction has been successfully created\n- Funds are not yet committed from your account\n- You can still\
    \ modify or cancel the payout\n- Must call commit endpoint to proceed\n\n#### Committed Status\n\n- Payout has been committed\
    \ for processing\n- Funds are placed in escrow\n- Processing has begun but not yet completed\n- Cannot be canceled once\
    \ committed\n\n#### Pending Status\n\nThe payout is waiting for recipient action:\n\n- **New User:** Recipient needs to\
    \ create an Airtm account\n- **Verification Required:** Recipient exceeds $1,000 threshold and needs ID verification\n\
    - **US Recipients:** Must complete ID verification and configure payment method\n- **Account Issues:** Recipient account\
    \ may have restrictions\n\nA pending payout can still be canceled before it is processed.\n\n#### Completed Status\n\n\
    - Payment has been successfully processed\n- Funds have been credited to recipient's account\n- Final status - no further\
    \ action needed\n- Success webhook sent (if configured)\n\n#### Canceled Status\n\n- Payout was canceled before or during\
    \ processing\n- Funds have been returned to your account\n- Can occur due to:\n  - Manual cancellation\n  - Recipient\
    \ unable to receive funds\n  - Account restrictions\n  - Compliance issues\n\n#### Failed Status\n\n- Rare occurrence\
    \ of processing failure\n- Contact [enterprise@airtm.com](mailto:enterprise@airtm.com) for assistance\n- May require manual\
    \ intervention to resolve\n\n## Recipient Management\n\n### New Recipients\n\nWhen sending to users who don't have Airtm\
    \ accounts:\n\n1. **Payout Created** - Payment is created with recipient email\n2. **Email Notification** - Recipient\
    \ receives invitation to join Airtm\n3. **Account Creation** - Recipient creates Airtm account\n4. **Payment Completion**\
    \ - Funds are automatically credited\n\n### Existing Recipients\n\nFor users with existing Airtm accounts:\n\n- Payments\
    \ are typically processed faster\n- Fewer verification requirements\n- Direct credit to their account balance\n\n### Recipient\
    \ Verification Requirements\n\n#### $1,000+ Threshold\n\nRecipients receiving amounts that bring their total inflow over\
    \ $1,000 must:\n\n- Complete ID verification\n- Provide government-issued identification\n- Verify personal information\n\
    \n#### US Recipients\n\nAll US-based recipients must:\n\n- Complete ID verification regardless of amount\n- Configure\
    \ a valid payment method\n- Meet additional compliance requirements"
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Payments / Payouts
  properties:
  - type: OpenAPI
    url: openapi/airtm-payments-payouts-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-payouts-api
  name: Airtm Payouts API
  description: '# Payouts


    Send money to recipients worldwide through their Airtm accounts. Payouts use a secure two-step process to prevent accidental
    payments.


    ## How Payouts Work


    ### Two-Step Process


    1. **Create** - Validates recipient and reserves funds

    2. **Commit** - Actually sends the money


    This prevents accidental payments and allows for approval workflows.


    ### One-Step Option


    Set `commit: true` when creating to skip the manual commit step for automated workflows.


    ## Integration Workflows


    ### Standard Two-Step


    Create payout → Review details → Commit when approved


    ### Automated Processing


    Create with `commit: true` for immediate processing'
  humanURL: https://docs.airtm.com/
  baseURL: https://api.enterprise.airtm.com/v2
  tags:
  - Payouts
  properties:
  - type: OpenAPI
    url: openapi/airtm-payouts-api-openapi.yml
  - type: Documentation
    url: https://docs.airtm.com/
  - type: APIReference
    url: https://docs.airtm.com/
  - type: Webhooks
    url: asyncapi/airtm-webhooks.yml
- aid: airtm:airtm-purchases-payins-api
  name: Airtm Purchases / Payins API
  description: '## Overview


    The Payins endpoint (also known as Purchases) enables your organization to accept payments from users for products, services,
    or any other transactions. This endpoint is essential for e-commerce platforms, service providers, and any business that
    needs to collect payments from customers through the Airtm platform.


    ## What are Payins?


    Payins represent incoming payments to your enterprise account. When a user makes a purchase or payment to your organization,
    it creates a payin operation that can be tracked and managed through this endpoint.


    ### Key Features


    - **Flexible Payment Processing** - Accept payments for various products and services

    - **Multi-Currency Support** - Process payments in different currencies

    - **Real-Time Status Updates** - Track payment progress in real-time

    - **Secure Checkout Process** - Redirect users to secure Airtm payment pages

    - **Webhook Integration** - Receive instant notifications on payment status changes

    - **Reference Code Tracking** - Link payments to your internal order systems


    ## Payment Flow


    1. **Create Purchase** - Your system creates a purchase request with payment details

    2. **User Checkout** - User is redirected to Airtm''s secure checkout page

    3. **Authentication** - User logs into their Airtm account to complete payment

    4. **Processing** - Payment is processed and status updates are provided

    5. **Completion** - Payment is completed and funds are transferred to your account


    ## Status Management


    ### Purchase Status Values


    | Status      | Final? | Description                                       |

    | ----------- | ------ | ------------------------------------------------- |

    | `created`   | No     | Purchase created, awaiting user payment           |

    | `confirmed` | Yes    | Payment completed successfully, funds transferred |

    | `canceled`  | Yes    | User canceled the purchase, no funds transferred  |

    | `failed`    | Yes    | Payment processing failed                         |


    > [!TIP]

    > Implement case-insensitive status comparisons in your code to handle potential variations.'
  humanURL: https://docs.airtm.com/
  b

# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/airtm/refs/heads/main/apis.yml