Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

KeyBank ACH Inquiry API

The ACH Inquiry API lets commercial clients check the current status and detail of ACH transactions posted to their KeyBank accounts. It provides operations to list ACH transactions, retrieve full detail by PAR number, look up settled items by settlement transaction id, and a health check, supporting reconciliation and exception handling workflows. Secured with OAuth2 bearer tokens and client certificates over https://partner-api.key.com with a QV sandbox environment for testing.

KeyBank ACH Inquiry API is one of 10 APIs that KeyCorp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ACH, Inquiry, Reporting, and United States. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, organized into 2 resource areas, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 2.1.2.

Requests are made against 2 base URLs: https://partner-api-qv.key.com, https://partner-api.key.com.

4 operations 4 paths 17 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.1.2
Base URL
https://partner-api.key.com/accounts/transactions/v1
Authentication
HTTP Bearer
Resource Areas
2

Authentication & Security 1

KeyBank ACH Inquiry API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Access token supplied in the Authorization header using the Bearer scheme (e.g. Authorization: Bearer {token}).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. They span 2 resource areas: HealthCheck, ACH Transactions. Each is listed below with its method, path, parameters, and response codes.

HealthCheck 1

Verify you can connect to the API service.

GET
/accounts/transactions/v1/healthCheck
Health check
healthCheck → 200
ACH Transactions 3

ACH Inquiry functions to list and retrieve ACH transaction details

GET
/accounts/transactions/v1/ach/detail/{parNumber}
Get details about an ACH transaction with a parNumber.
searchAchTransaction 2 params → 200404500
POST
/accounts/transactions/v1/ach/list
Advanced search for ACH transactions
searchAchTransactions 1 param body → 200400403500
GET
/accounts/transactions/v1/ach/settled/{settlementTransactionId}
Advanced search for settled ACH transactions
searchAchSettledTransactions 4 params → 200400404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are AchDetailTransaction (29 properties), AchListTransaction (22 properties), AchSettledTransaction (19 properties), Exception (6 properties). Each schema is shown below with its type and property counts.

AccountList
object
Contains details about the account like account number.
1 property
AccountDetail
object
Contains details about the account like number, bank number, and routing number.
3 properties
AchDetailTransaction
object
Contains transaction details associated with the queried parNumber.
29 properties
AchListTransaction
object
Results from ACH transaction account search.
22 properties
AchSettledTransaction
object
Results from ACH transaction where the status is "SETTLED" or "RETURNED".
19 properties
Addendum
object
Contains addenda record information.
3 properties
PartyList
object
Contains the customer identification number and company name.
2 properties
PartyDetail
object
Contains details about the party like ID number, company name, and the customer name.
3 properties
NotificationOfChange
object
Contains change details and corrected data.
3 properties
HealthResponse
object
5 properties
Message
object
Informational code and message from the server.
2 properties
Page
object
Page information returned from the server.
5 properties
PageMetadata
object
Data information returned as a message or page information retrieved from the server.
1 property
Exception
object
Contains information about errors related to the request.
6 properties
ServiceErrorData
object
Detailed service-level error information, if available.
1 property
ConnectError
object
1 property
ErrorMetadata
object
Error metadata including validation or service messages.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keycorp-ach-inquiry-openapi.yml Raw ↑

Other APIs KeyCorp publishes across the network.

KeyBank Account Information API
KeyBank ACH Origination API
KeyBank Wire Transfer API
KeyBank RTP Send Payment API
KeyBank Account Validation API
KeyBank Wire Inquiry API
KeyBank RTP Inquiry API
KeyBank Check Services API
KeyBank Webhooks