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

Aeropay v2 API

The Aeropay v2 REST API for pay-by-bank money movement. Issue merchant- or userForMerchant-scoped bearer tokens, create and confirm users, obtain Aerosync bank-linking credentials and attach the resulting account, then create standard, preauthorized or payout transactions, capture or reverse them, search transactions, send payment links, subscribe to webhooks, pull CSV/totals/batch reports and manage merchant reputation. 32 operations over 26 paths, described by a published OpenAPI 3.0.0 document.

Aeropay v2 API is one of 3 APIs that Aeropay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments, Pay by bank, ACH, and Payouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 32 operations across 26 paths, organized into 7 resource areas, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.sandbox-pay.aero.inc.

32 operations 26 paths 25 schemas 2 DELETE14 GET2 PATCH14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.aeropay.com/v2
Resource Areas
7

Paths & Operations 32

Across 26 paths, the API surfaces 32 operations — 2 DELETE, 14 GET, 2 PATCH, 14 POST. They span 7 resource areas: Authentication, User Management, Bank Connection, Create & Manage Transactions, Webhooks, Reports, Merchant Management. Each is listed below with its method, path, parameters, and response codes.

Authentication 1
POST
/v2/token
token
1 param body → 200400401
User Management 3
POST
/v2/user
user
2 params body → 200401
GET
/v2/user
user
2 params → 200401
POST
/v2/confirmUser
confirmUser
2 params body → 200400
Bank Connection 4
GET
/v2/aggregatorCredentials
aggregatorCredentials
3 params → 200400
POST
/v2/linkAccountFromAggregator
linkAccountFromAggregator
2 params body → 200
PATCH
/v2/userBankAccount/{bankAccountId}
userBankAccount
3 params → 200400
GET
/v2/bankAccounts
bankAccounts
2 params → 200401
Create & Manage Transactions 14
POST
/v2/transaction
transaction
3 params body → 200400
GET
/v2/transaction/{transactionUUID}/refunds
transactionRefunds
3 params → 200
GET
/v2/transaction/idempotency/{idempotencyKey}
getTransactionByIdempotencyKey
3 params → 200400
GET
/v2/transaction/{transactionId}
transaction
3 params → 200
POST
/v2/preauthTransaction
preauthTransaction
3 params body → 200400
GET
/v2/preauthTransaction/{preauthTransactionId}
preauthTransaction
3 params → 200
PATCH
/v2/preauthTransaction/{preauthTransactionId}
preauthTransaction
3 params body → 200400
DELETE
/v2/preauthTransaction/{preauthTransactionId}
preauthTransaction
3 params → 200400
GET
/v2/preauthTransactions
preauthTransactions
11 params → 200401
POST
/v2/capturePreauthTransaction
capturePreauthTransaction
2 params body → 200400
POST
/v2/reverseTransaction
reverseTransaction
3 params body → 200400
POST
/v2/payoutTransaction
payoutTransaction
3 params body → 200400
POST
/v2/transactionSearch
transactionSearch
2 params body → 200400
POST
/v2/paymentLink
paymentLink
3 params body → 200400401
Webhooks 4
POST
/v2/createWebhookSigningKey
createWebhookSigningKey
2 params body → 200401
POST
/v2/webhook
webhook
2 params body → 200400
GET
/v2/webhook
webhook
3 params → 200401
DELETE
/v2/webhook
webhook
4 params → 200400
Reports 3
GET
/v2/reports/transactions/CSV
Transactions CSV
14 params → 200
GET
/v2/reports/transactions/totals
Transactions Totals
6 params → 200
GET
/v2/reports/transactions/batches
Merchant Batch Balance
8 params → 200401
Merchant Management 3
GET
/v2/merchantReputation
merchantReputation
2 params → 200400401
POST
/v2/merchantReputation
merchantReputation
2 params body → 200400
GET
/v2/merchant/tipConfiguration
tipConfiguration
1 param → 200401

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are transactionTotals (8 properties), queuedRefundItem (4 properties), userRequest (4 properties), aggregatorCredentialsResponse (3 properties). Each schema is shown below with its type and property counts.

200failure
object
1 property
emptyResponse
object
userRequest
object
4 properties 4 required
confirmUserObject
object
1 property
userObject
object
2 properties
userGetResponse
object
1 property
aggregatorCredentialsResponse
object
3 properties
linkAccountFromAggregatorResponse
object
1 property
transactionResponse
object
1 property
transactionGetResponse
object
1 property
transactionRefundsResponse
object
2 properties
refundItem
queuedRefundItem
object
4 properties
preauthTransactionResponse
object
1 property
preauthTransactionGetResponse
object
2 properties
capturePreauthTransactionResponse
object
1 property
reverseTransactionResponse
object
2 properties
payoutTransactionResponse
object
1 property
transactionSearchResponse
object
2 properties
webhookPostResponse
object
1 property
webhookGetResponse
object
1 property
webhookDeleteResponse
object
1 property
transactionTotals
object
8 properties
merchantReputationStatusPostResponse
object
1 property
tipConfigurationResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeropay-v2-openapi.yml Raw ↑

Other APIs Aeropay publishes across the network.

Aeropay Webhooks
Aeropay API MCP Server
Where this information came from

This is an independent, third-party profile of Aeropay v2 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.