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 RTP Inquiry API

The RTP Inquiry API confirms the delivery and status of Real-Time Payments sent through KeyBank on The Clearing House RTP network. It provides operations to list RTP transactions, retrieve full detail for a single transaction by id, and a health check, supporting immediate confirmation and reconciliation of instant payment flows. Secured with OAuth2 bearer tokens and client certificates over the https://partner-api.key.com host, with a QV sandbox environment available for integration testing.

KeyBank RTP 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 Inquiry, Real-Time Payments, Reporting, and United States. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

3 operations 3 paths 21 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

KeyBank RTP 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 3

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

HealthCheck 1

Verify you can connect to the API service.

GET
/rtp/v1/healthCheck
Health check
healthCheck → 200
RTP 2

RTP functions to list and retrieve real-time payment details

POST
/rtp/v1/transactions/list
Search real time payment transactions
searchRtpTransactions 1 param body → 200400401403408500
GET
/rtp/v1/transactions/detail/{transactionId}
View the details of a RTP transaction by its ID
searchRtpTransaction 2 params → 200401404500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are RtpDetailTransaction (30 properties), RTPListTransaction (13 properties), PostalAddress (10 properties), Exception (6 properties). Each schema is shown below with its type and property counts.

RtpDetailTransaction
object
Contains the response payload with details about an RTP transaction.
30 properties
RTPListTransaction
object
Contains the response payload for RTP inquiries.
13 properties
HealthResponse
object
5 properties
Amount0To1B
Amount between 0 and 1,000,000,000 inclusive. Accepts a JSON number or a string. If a string is used, commas are allowed as thousands separators. Decimal preci…
Account
object
1 property
AccountExtended
PartySummary
object
Minimal party representation returned in list results.
1 property 1 required
PartyDetail
Party representation returned in detail results.
BeneficiaryPartyDetail
Beneficiary party representation returned in detail results.
OriginatorPartyDetail
Originator party representation returned in detail results.
PostalAddress
object
10 properties
IntermediaryBank
Bank
object
2 properties
FailureReasons
object
4 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-rtp-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 ACH Inquiry API
KeyBank Wire Inquiry API
KeyBank Check Services API
KeyBank Webhooks