The ACH Origination API initiates secure, automated ACH fund transfers from commercial KeyBank accounts across the full range of Standard Entry Class codes — CCD, CTX, PPD, TEL, and WEB — for both send (credit) and collect (debit) transactions. It supports addenda records, payment undo/cancellation, payment status and status-addenda inquiry, and a health check operation. Secured with OAuth2 bearer tokens and client certificates over the https://partner-api.key.com host, with a QV sandbox environment for testing.
KeyBank ACH Origination 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, Payments, Commercial Banking, and United States. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
10 operations
across 10 paths,
organized into 4 resource areas,
and defines 36 schemas.
It is described by OpenAPI 3.0.1, at version 1.3.4.
Requests are made against 2 base URLs: https://partner-api-qv.key.com, https://partner-api.key.com.
10 operations10 paths36 schemas1 GET9 POST
Metadata
The identity and technical contract details declared by the specification.
KeyBank ACH Origination API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 10
Across 10 paths, the API surfaces 10 operations — 1 GET, 9 POST. They span 4 resource areas: HealthCheck, ACH Payment Request Inquiry, ACH Payment Origination, Undo ACH Payment Request. Each is listed below with its method, path, parameters, and response codes.
Make or collect payments to or from a corporate account with attached records
achPaymentCTXbody→ 200400401403404405415429
POST
/ach/payments/v1/ppd
Make deposits and withdrawals to or from consumer accounts
achPaymentPPDbody→ 200400401403404405415429
POST
/ach/payments/v1/tel
Send a payment over the phone
achPaymentTELbody→ 200400401403404405415429
POST
/ach/payments/v1/web
Send an online payment
achPaymentWEBbody→ 200400401403404405415429
POST
/ach/payments/v1/addenda
Send additional addenda information
achPaymentAddendabody→ 200400401403404405415429
Undo ACH Payment Request 1
POST
/ach/payments/v1/undo
Undo a payment request
achPaymentUndobody→ 200400401403404405415429
Schemas 36
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are detailStatusResponse (42 properties), cTXDetailRequest (13 properties), webDetailRequest (12 properties), cCDDetailRequest (12 properties). Each schema is shown below with its type and property counts.
healthResponse
object
The response for a successful API health check.
5 properties
exception
object
6 properties
connectError
object
1 property
acceptedAddendaResponseEnvelope
object
Contains the response payload for the submitted request.
7 properties
acceptedBatchResponseAcceptedDetailResponse
object
Contains response details for accepted ACH transactions.
7 properties2 required
acceptedDetailResponse
object
Contains the details for an accepted response.
6 properties1 required
addendaRequest
object
Contains related payment information and the addenda record sequence number.
2 properties2 required
addendaRequestEnvelope
object
Contains the parameters to request a list of addenda records by the UUID.
2 properties2 required
addendaResponse
object
Contains status and additional information about the returned addenda records.
3 properties
addendaStatusRequestEnvelope
object
Contains the unique transaction ID and pagination controls.
3 properties1 required
addendaStatusResponseEnvelope
object
Contains the response parameters for the addenda status request.
6 properties
baseAddendaDetailResponse
object
Contains the code, sequence number, and related payment information for returned addenda records.
3 properties
baseAddendaRequest
object
Contains payment related information.
1 property1 required
baseDetailResponse
object
5 properties1 required
batchRequestCCDDetailRequest
object
Contains the request parameters.
9 properties5 required
batchRequestCTXDetailRequest
object
Contains batch request details for a CTX transaction.
9 properties5 required
batchRequestEnvelopeBatchRequestCCDDetailRequest
object
Contains the request payload for the submitted request.
2 properties1 required
batchRequestEnvelopeBatchRequestCTXDetailRequest
object
2 properties1 required
batchRequestEnvelopeBatchRequestPPDDetailRequest
object
2 properties1 required
batchRequestEnvelopeBatchRequestTELDetailRequest
object
2 properties1 required
batchRequestEnvelopeBatchRequestWEBDetailRequest
object
2 properties1 required
batchRequestPPDDetailRequest
object
Contains batch request details for a PPD transaction.
9 properties5 required
batchRequestTELDetailRequest
object
Contains batch request details for a TEL transaction.
9 properties5 required
batchRequestWEBDetailRequest
object
Contains batch request details for a WEB transaction.
9 properties5 required
batchResponseEnvelopeAccepted
object
Contains information for a successful ACH transaction.
1 property1 required
cCDDetailRequest
object
Parameters for additional details about the CCD request.
12 properties9 required
cTXDetailRequest
object
Parameters for additional details about the CTX request.
13 properties10 required
detailMessage
object
Contains the code and message with details about the response.
