Airtm

Airtm Me API

# 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

Documentation GitHub OpenAPI

Operations 2

GET /me Get enterprise details #

GET /me/balance Get balance #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/airtm-me-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Airtm Enterprise API V2 Me API
  version: 1.155.0
  description: '# Introduction


    The Airtm Enterprise API enables organizations to send and receive payments globally through a simple REST API.'
  contact:
    name: Airtm Enterprise
    email: enterprise@airtm.com
    url: https://www.airtm.com
servers:
- url: https://api.enterprise.airtm.com/v2
- url: https://api.stg.enterprise.airtm.com/v2
tags:
- name: Me
  description: '# Account Management


    The Account Management API provides essential information about your Airtm Enterprise account, including account details, balance information, and configuration settings.'
paths:
  /me:
    get:
      operationId: GetMe
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        default:
          description: Error
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: string
                    description: 'Machine-friendly error code


                      See the API error code catalog in the documentation for the endpoint surface you are using.'
                    example: '415096'
                  message:
                    type: string
                    description: Human-readable error message
                    example: Invalid email address
                  data:
                    $ref: '#/components/schemas/Record_string.unknown_'
                    description: Additional data related to the error
                    example:
                      email: invalid@address
                required:
                - code
                - message
                type: object
      summary: Get enterprise details
      tags:
      - Me
      security:
      - basicAuth: []
      parameters: []
  /me/balance:
    get:
      operationId: GeBalance
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
        default:
          description: Error
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: string
                    description: 'Machine-friendly error code


                      See the API error code catalog in the documentation for the endpoint surface you are using.'
                    example: '415096'
                  message:
                    type: string
                    description: Human-readable error message
                    example: Invalid email address
                  data:
                    $ref: '#/components/schemas/Record_string.unknown_'
                    description: Additional data related to the error
                    example:
                      email: invalid@address
                required:
                - code
                - message
                type: object
      description: 'Retrieves the current balance of the enterprise.

        It will include both available and pending amounts.


        > [!tip]

        > The pending amount is the sum of all committed pending payouts.'
      summary: Get balance
      tags:
      - Me
      security:
      - basicAuth: []
      parameters: []
components:
  schemas:
    Balance:
      description: Information related to your account.
      properties:
        available:
          type: number
          format: double
          description: Amount available in the account.
          example: 1234.56
        pending:
          type: number
          format: double
          description: Amount committed to pending payouts in the account.
          example: 123.45
      required:
      - available
      - pending
      type: object
      additionalProperties: false
    Record_string.unknown_:
      properties: {}
      additionalProperties: {}
      type: object
      description: Construct a type with a set of properties K of type T
    Uuid:
      type: string
      format: uuid
      pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
    Me:
      description: Information related to your account.
      properties:
        id:
          $ref: '#/components/schemas/Uuid'
          description: Unique identifier of your account.
        cancelPendingPayoutsAfterDays:
          type: number
          format: double
          description: Number of days after which pending payouts will be automatically canceled.
          example: 90
          default: 90
          minimum: 7
          maximum: 180
        payoutRequireIdVerification:
          type: boolean
          description: 'Indicates whether the enterprise can require ID verification for payouts.


            To enable it, reach out to your account manager.'
          default: false
      required:
      - id
      type: object
      additionalProperties: false
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-tagGroups:
- name: Payout Operations
  tags:
  - Payouts
  - Bulk Payouts
  - Users
- name: Payin Operations
  tags:
  - Payins
- name: Account
  tags:
  - Me
  - Deposits
  - Reports
- name: Direct Withdrawal
  tags:
  - External Bank Account
  - External Crypto Account
  - Withdrawals
- name: Webhooks
  tags:
  - Webhooks