How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Airtm Payins API

# PayinsThe 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.## OverviewPayins 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 Flow1. **Create Payment Request**: Generate a payin with item details and amounts2. **Redirect Customer**: Send customer to Airtm's secure checkout page3. **Customer Authentication**: User logs into their Airtm account4. **Payment Processing**: Customer completes payment using available methods5. **Confirmation**: Receive real-time notification of payment status6. **Fulfillment**: Deliver goods or services upon successful payment### Checkout ExperienceCustomers 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 StructureThe 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 ConsiderationsFor 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 URLsConfigure 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 BillingPayins support detailed itemization with:- Individual item descriptions- Quantity and unit pricing

Airtm Payins API is one of 24 APIs that Airtm publishes on the 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.

This API exposes 5 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.155.0.

Requests are made against 2 base URLs: https://api.enterprise.airtm.com/v2, https://api.stg.enterprise.airtm.com/v2.

5 operations 3 paths 9 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.155.0
Base URL
https://api.enterprise.airtm.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Airtm Payins API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payins 5

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 busines…

POST
/payins
Create a Payin
CreatePayin body → 200default
GET
/payins
List payins
ListPayins 5 params → 200default
GET
/payins/{id}
Get payin details
GetPayinById 1 param → 200default
DELETE
/payins/{id}
Cancel a payin
CancelPayin 1 param → 200default
GET
/payins/by-code/{code}
Get payin by code
GetPayinByCode 1 param → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are PayinResponse (16 properties), CreatePayinRequest (6 properties), PayinItem (5 properties), CreatePayinItem (3 properties). Each schema is shown below with its type and property counts.

Paginated_PayinResponse_
object
Represents a paginated collection of items.
3 properties 1 required
CreatePayinItem
object
3 properties 3 required
CreatePayinRequest
object
6 properties 6 required
Email
string
PayinStatus
string
The current status of the payin - CREATED: The payin has been created but not yet confirmed. - CONFIRMED: The payin has been confirmed and is ready for process…
Record_string.unknown_
object
Construct a type with a set of properties K of type T
PayinItem
object
An item within a payin transaction
5 properties 5 required
Uuid
string
PayinResponse
object
A payin is a transaction that transfers funds from a user's Airtm account to an enterprise's account. Normally, the payin represents a purchase made by a user.
16 properties 12 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

airtm-payins-api-openapi.yml Raw ↑

Other APIs Airtm publishes across the network.

Airtm Wallet Resource (Connect) API
Airtm Account Status API
Airtm API Keys API
Airtm Bulk Payments API
Airtm Bulk Payouts API
Airtm Deposits API
Airtm Embedded Catalog API
Airtm Embedded Quotes API
Airtm Embedded Receivers API
Airtm Embedded Senders API
Airtm Embedded Transactions API
Airtm External Bank Account API
Where this information came from

This is an independent, third-party profile of Airtm Payins API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.