KeyBank API Documentation portal

3 minutes read 1.2 | updated Feb. 13, 2023

3 minutes

Explore. Enhance. Evolve.

Welcome to the KeyBank API documentation portal. We've created this simple, user-friendly developer portal with you in mind. Enjoy thorough documentation, testing environments, and a suite of APIs designed to elevate your experience and help your software use our services easily and effectively.  

Let's dive in.

Getting started

Explore our site to learn more about KeyBank APIs.
Get a KeyBank user account to use our Mock environment.
Use your data with our APIs to test in a certified and secure environment.
Create API sequences and publish your work.

01Learn more

KeyBank has APIs for payments and account reports. To view documentation for each API, go to API documentation.

Each API topic has:

  • Identified endpoints
  • Requirements for the request payload
  • Code examples of the call and response
  • Help for possible errors
  • A downloadable YAML file

Available APIs

API Description
Account Validation Verify an account and its owner.
ACH Origination Make a payment to a clearing house.
ACH Inquiry Get the status of an ACH payment.
Wire Inquiry Get the status of a wire payment.
RTP Send Payment Create and send a real-time payment.
Previous Day Reporting Get past transaction activity.
Intraday Reporting Get transaction activity for the current day.
Check Image Retrieval Get a single check image.
Stop Payment Stop an issued payment.

02Get involved

Anyone can see essential API content like documents, code examples, error handling, and YAML files. Once you have a KeyBank API Documentation portal user account, you can also try the APIs in one of our test environments. To get your user account, join our waitlist.

Sign up to start the process!

What you can do in our portal

The KeyBank API Documentation portal is a self-service developer portal. Anyone can sign up for our waitlist and create a user account. We will reach out to you with further instructions on when and how to use our test environments. With a user account, you also see notifications and release information for future portal versions.  

API documentation
Code examples
YAML file
Error handling
Mock API keys  
Pre-Production API Keys    
Production API Keys    

03Begin testing

As a KeyBank API consumer, you have access to our non-production environment. This environment is ideal for integration testing because it simulates realistic responses and conditions using real data. You can also perform end-to-end testing to validate your build. For access to the non-production environment, speak with a KeyBank onboarding specialist to learn more.

Onboard with KeyBank

To become a KeyBank API consumer, a company representative or lead developer will need to meet with us to discuss your API needs and collect some necessary information.

When meeting with the KeyBank onboarding team, they’ll ask about the APIs you want to use, the amount of data that you normally handle, and if you need access to a test environment. They'll also collect information like certificates, IP addresses, and how you plan to use the APIs. All this helps configure and secure an API environment tailored to your needs.

04Go live

Connect your application to KeyBank! When you are ready to go live, you can deploy your APIs in a certified production environment. The production environment returns live responses with real data and real money.

Ready to work with KeyBank?

Contact KeyBank to start the process. After setup, you’ll have a user account with access to private keys and test environments. 

Up next: dig into our API Documentation

Want access to the workbench?

Sign up for the waitlist now! Get credentials you can use to access mock testing environments and more. We’ll have you building in no time.
Waitlist Sign Up