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 Embedded Receivers API

The Embedded Receivers API from Airtm — 4 operation(s) for embedded receivers.

Airtm Embedded Receivers API is one of 24 APIs that Airtm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Embedded Receivers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 21 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.

6 operations 4 paths 21 schemas 1 DELETE2 GET2 POST1 PUT

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 Embedded Receivers API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth).

Paths & Operations 6

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

Embedded Receivers 6
POST
/embedded/receivers
Create receiver
CreateReceiver body → 201default
GET
/embedded/receivers
Get receiver by external id
GetReceiverByExternalId 1 param → 200default
GET
/embedded/receivers/{receiverId}
Get receiver by id
GetReceiverById 1 param → 200default
PUT
/embedded/receivers/{receiverId}
Update receiver
UpdateReceiver 1 param body → 200default
POST
/embedded/receivers/{receiverId}/payment-rail-instance
Add payment rail instance
AddPaymentRailInstance 1 param body → 201default
DELETE
/embedded/receivers/{receiverId}/payment-rail-instance/{paymentRailInstanceId}
Remove payment rail instance
RemovePaymentRailInstance 2 params → 204default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ReceiverApiResponse (11 properties), CreateReceiverRequest (8 properties), CreateReceiverKycReliance (7 properties), UpdateReceiverRequest (6 properties). Each schema is shown below with its type and property counts.

CreateReceiverIndividual
object
Individual party details. Required when partyType is 'individual'.
4 properties 4 required
CreateReceiverContact
object
Contact information for the receiver.
2 properties
Partial_CreateReceiverCompliance_
object
Make all properties in T optional
1 property
Uuid
string
AddPaymentRailInstanceRequest
object
Request body for adding a payment rail instance to a receiver.
3 properties 3 required
ProviderResult
string
Partial_CreateReceiverContact_
object
Make all properties in T optional
2 properties
Partial_CreateReceiverAddress_
object
Make all properties in T optional
5 properties
Record_string.unknown_
object
Construct a type with a set of properties K of type T
UpdateReceiverRequest
object
6 properties
ReceiverApiResponse
object
11 properties 10 required
CreateReceiverPayoutDestination
object
Payout destination: a payment rail plus rail-specific destination data.
3 properties 3 required
KycStatus
string
KycLevel
string
CreateReceiverCompliance
object
1 property 1 required
PaymentRailInstanceApiResponse
object
6 properties 6 required
Partial_CreateReceiverIndividual_
object
Make all properties in T optional
4 properties
CreateReceiverAddress
object
Address information for the receiver.
5 properties
DocumentType
string
CreateReceiverRequest
object
8 properties 4 required
CreateReceiverKycReliance
object
KYC reliance information from the partner's KYC provider.
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

airtm-embedded-receivers-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 Senders API
Airtm Embedded Transactions API
Airtm External Bank Account API
Airtm External Crypto Account API
Where this information came from

This is an independent, third-party profile of Airtm Embedded Receivers 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.