Release notes

The developer portal release notes are organized by the month and year of the release, starting with the most current. We also identify the affected APIs and the level of impact for the changes made. This is a quick cue to know if you need to make any necessary changes immediately or if you can integrate the API enhancements at your own pace.

We categorize changes as either breaking or non-breaking.

• Breaking changes require upgrading to a new version of the API framework. These changes can cause incompatibility and possibly disrupt your connection to API services. Some examples of breaking changes are a change to the type of a parameter, removing request fields, or developing an existing object with additional parameters.
• Non-breaking changes are changes that do not require you to upgrade to a new version or disrupt your connection to current API services. Some examples of a non-breaking change are to add an optional parameter field like a custom data field or removing a deprecating parameter no longer valid or in use.

Levels of impact

Developer Portal Release 4.8.2

• We know what you have been searching for - a search function on our portal! We are proud to release a search field in our main navigation bar. Use keywords or product names to filter for specific information in our portal.
• RTP Send Payment API is now offers OBO (On Behalf Of) payments. This means the payer can send funds to the payee on behalf of a different client. If you choose to do an OBO payment, the ultParty.
• Get a better understanding of a transaction key and what it really does in the Previous Day API.

Developer Portal Release 4.8

• KeyBank client have exclusive access to our support form. If you are a partner with KeyBank, you can use this form to submit a support request or request a working session. Before escalating, we suggest using the error handling and troubleshooting details to attempt to resolve any common issues independently.
• We've expanded our support documentation to help you get started and find answers quickly:
  • FAQs help with common questions and answers about onboarding and using our APIs.
  • Troubleshooting has step-by-step solutions for frequent issues organized by the HTTP code.
• Introducing a new, visually guided way to explore our products and move seamlessly through the site. Check out our centralized access to technical documentation with Guides, API docs, and developer support resources.
• APIs using the exception schema now include the Api-Url path in their error messages. This enhancement is available for: ACH Origination, Wire Transfer, RTP Send Payment, Account Validation, ACH Inquiry, Wire Inquiry, Previous Day, Intraday, Check Image Retrieval, and Stop Payment.
• The KeyClientId parameter has been renamed to EPPID (Enterprise Payments Platform ID) for the Wire Transfer and RTP Send Payment APIs. While the functionality is the same, the new name helps distinguish it from your clientId, which is part of your API keys.

Developer Portal Release 4.7

• ACH Origination error messaging for HTTP 504 has been clarified with the following message, "Please verify your payment status UUID and send the request again. The request could not be processed on time (GatewayTimeout)."
• Getting Started Guide has gotten a makeover. Now known as Get Started, check out an concise overview of how to onboard with nested topics about how to use our APIs. This provides fundamental resources that help you get acquainted with our APIs and structure. We have new topics like Entitlements and FAQs that are worth a look!

Developer Portal Release 4.6

• Introducing a new Wire/RTP alert notification event for our Webhooks service. The Wire/RTP alert notification is a concise summary that provides basic transaction information including creditor and debtor party name and account details.
• Added a list of KeyBank recommended certificate authorities in our Getting Started Guide.
• Status endpoints in the Wire Transfer and RTP Send Payment API are no longer needed. The status for these API transactions can be tracked with our inquiry APIs. 

• Remittance and bank-to-bank instructions fields have been added to the Wire Inquiry API to help track useful information from the originated transfer. 

   

Developer Portal Release 4.5

• Announcing our Announcements page! We now have a page that describes what changes and announcements to the Developer Portal. We have also added a notification banner for important or critical changes that could require client action.
• To prepare for the upcoming ApigeeX migration, all API specification files (YAMLs) have been updated with the new environment paths.
  • For the non-production environment, changed https://partner-api-qv.keybank.com to https://partner-api-qv.key.com.
  • For the simulator and production environments, changed ttps://partner-api.keybank.com to https://partner-api.key.com.

Developer Portal Release 4.4

• Introducing new and enhanced endpoints for the Wire Inquiry API. Mimicking the format and style of RTP Inquiry calls, you can now use Wire Inquiry to retrieve information for a list of transfer or get a detailed information about a specific transaction.
• Added ACH workflow images to ACH User Guide for simple workflows and identification parameters lifecycle from origination to inquiry.
• Account Validation specifications have been updated with conditions for accounts with international addresses. International addresses should be combined on adrLine2 with province, country, and postal code.
• Wire Transfer and RTP Send Payment have been updated for accountNumber and aba fields to include new request requirement logic for the party object. For all parties except debit parties, the aba number is required, or the account number with name and address is required. We also added details about how we check for duplicate transactions.
• In RTP Inquiry, the following parameters were added to RTPListTransaction and RTPDetailTransaction objects: originator, originatorAccount, beneficiary, and beneficiaryAccount. For AccountList, added the virtualAccountNumber field to return data, if applicable.
• In the defaultChecksRequest object for Check Image Retrieval, the username and password are no longer required fields for requests.
• For Stop Payment,  added details and clarification for the BankNumber field.

Developer Portal Release 4.3

• Deprecated dateSearchType in ACH Inquiry requests. Refer to the transactionStatus in the response body to know if the payment is collected, settled, or returned.
• Modified the accountNumber field description in Previous Day and Intraday requests to mention that if looking up more than one account in a request can impact performance.
• Hid two endpoints, /transactions/intraday/list and /transactions/intraday/summary, from the Intraday API documentation. These endpoints are being refined with an upcoming release for the information reporting APIs. The endpoints are hidden on the page, but still exist in the specifications.

Developer Portal Release 4.2

• Only supporting content was modified for this release. No APIs were modified or affected by the content improvements.
• In Webhooks, the timing for the retry mechanism has changed. Originally it was set to retry and send alerts up to 12 times in a 24-hour period. The timing has been reduced to 3 alerts in a 24-hour period.
• RTP Send Payment and Wire Transfer APIs have a note about what special characters are allowed with ISO messages. 

Developer Portal Release 4.0.1

• Deprecated the amount and serialNumber parameters from Account Validation.
• Modified the party object in the Send RTP Payment and Wire Transfer APIs with a more detailed postalAddress. If using the postal address in your search, each field will be required to have at least a minimum of 1 character.
• Improved clarity about the dataLoadDate description in Previous Day. 
• On the Data Values page, reorganized the webhook alerts for Wire and RTP statuses into payment process categories - In Process, In Review, Failed, Canceled, Completed.

Developer Portal Release 4.0.0

• New API on the Developer Portal! Check out the RTP Inquiry API to search for a list or details about RTP transactions.
• Read about our simulated environment with the API Simulator User Guide. Go to this page to download our simulator specifications.
• Each API document page now has a changelog that acts as a revision history for the API specifications. 
• Webhooks onboarding and subscription process has been modified to reduce onboarding time. Look at the latest requirements and subscription tips. 

Developer Portal Release 3.1.2

• Improved Account Validation User Guide to be more direct in the steps to make a request and assess a response.
• In the Account Validation API, updated the parameters:
  • The amount in the request can only be a whole number. No cents. Make sense?
  • Updated the request field parameters to better clarify the valid and acceptable values and conditions.
• Updated the ACH APIs User Guide for the undo a transaction section. You can attempt to reverse a payment using ACH Direct.
• For ACH Origination API, the companyEntryDescription is now a required field each SEC payment call.
• For ACH Inquiry, transaction data can be recalled within 180 days of the current date.
• Added DFID  to the Glossary and enhanced parameter definitions for terms related to DFID in the ACH Origination API.

Developer Portal Release 3.1.1

• Account signup and waitlist are currently on hold. When our portal is ready for user account management and an integrated sandbox environment, we will introduce account sign up and login. If you are interested in using an Embedded Banking API product, please go to the EB Payments Advisor Contact Form.
• For ACH Origination API, changed the effective date range for ACH payments from 90 days to 31 days.
• Enhanced error message in Webhook specifications. Retry mechanism is only triggered by HTTP 500 type error messages. Individual issue resolution is required for HTTP 400 type error messages. This is a content only change.
• Added Terms of Services for the KeyBank API Developer Portal. This link is accessible on each page's footer. 

Developer Portal Release 3.1.0

• Introduction of the Account Validation API v2. Includes enhancements to the Account Validation API User Guide that includes information about version 2 of the API with greater clarity about significant parameters that can help improve your validation process.
• Webhooks ACH alerts have been simplified. Alert codes AL00902, AL00903, AL00904, AL00905 have been consolidated into a single and new code AL00906.
• To help clarify the alert codes for Wire and RTP webhook alerts, we added an extended status table to the Data Values page that includes intermittent statuses.
• Change the name of the Wire Origination API to its more common name, Wire Transfer.
• In the RTP Send Payment API, added clarification to the type field that for RTP the type can be PAYMENT or DRAFT and for wire transfers, the type will always be DRAFT. 
• Minor modifications to our Stop Payment API technical content. 

Developer Portal Release 2.5.0

• X-CorrelationId has been removed as a request header field for all endpoints in each API product. The parameter is no longer in the request body, but still remains in the code. The system assigns a unique ID when you submit a request and returns the X-CorrelationId value in the response.
• Changed the effectiveDate range for ACH payments from 90 days to 31 days.
• In the ACH Inquiry API, added two new endpoints. These endpoints will eventually replace the other status queries in the upcoming v2 of the API.
  • /accounts/transactions/v1/ach/details/{parNumber}
  • /accounts/transaction/v1/ach/list
• In the Wire Origination API and the RTP Send Payment API, the KeyClientId is required for all requests.
• Added new parameters to the Wire Inquiry API.
• KeyVAM introduction on the dev portal home page and an summary guide on KeyVAM with links to learn more.
• Date range for Previous Day calls cannot be more than 90 days.
• Minor modifications to our Check Image API technical content.
• API Simulator product is now available for ACH API products endpoints (ACH Origination and ACH Inquiry). Speak to your Payments Advisor to learn more.

Developer Portal Release 2.4.0

• Introducing the Account Validation User Guide, a helpful resource to get more familiar with our Account Validation API product.
• Release notes are now available on the portal.
• Added Wire/RTP alerts to the Data Values page.
• Remove X-Point parameter from ACH Origination request headers.
• Minor modifications to our Intraday API technical content. 
• Two updates to the Webhooks for the Wire and RTP alert notifications,:
  • Added dbTranCurrencyCode and dbAngTypeCode to the alert body.
  • Added the requestReferenceNumber to the alert body. If the requestReference field has a value, it will be included in the alert.

Developer Portal Release 2.3.0

• Added new fields the RTP Send Payment and Wire Origination APIs.  Some fields had conditions (like format or character limits) modified for requests. Go to the API document to view specific changes about the fields added, which additional fields are now marked as required, setting minimum and maximum limits, and adding value pattern information.
• Intraday addenda report for collected ACH transactions has been updated to match the ACH Memo Post.
• Removed format restrictions for the channelCode field in the Wire Inquiry API.
• Minor modifications to our Previous Day API technical content.
• Getting Started User Guide talks about the onboarding process and how to access our API products.
• Improved the layout of the API reference pages to simplify information and help you get you to stuff you really want to know.
• Expand our Resources section to talk about Custom Data, Pagination, and Error Handling.
• User feedback is now available on the dev portal!
• Glossary banner is looking cool with a search bar and navigational directory.

Developer Portal Release 2.2.0

• Launched our new landing page and have divided our documentation into three sections: Guides, API Reference, and Resources.
  • The Guides section includes our first user guide: ACH APIs User Guide.
  • The new Resources section contains descriptions and details of data values found within our APIs.
  • We now have a glossary of common terms.
• The mdmId has officially deprecated. This affects ACH Inquiry, Wire Inquiry, Previous Day, and Intraday.
• New fields added to the Wire Inquiry API
• In the ACH Inquiry API, the "POSTED" status has been removed from ACH status inquiry endpoint.
• Minor modifications to our Webhooks technical content.
• Other updates include custom data clarifications, updated API error messaging, and improved navigation. These changes affect technical content only. The code and operations of the APIs remain the same. 

Developer Portal Release 2.1.0

• We’ve added virtual account management (VAM) fields (creditVirtualAccount, debitVirtualAccount) to the Wire Inquiry API. 
• The mdmId description has been updated to communicate that this field will soon deprecate in an upcoming release. This affects ACH Inquiry, Wire Inquiry, Previous Day, and Intraday.  
• Added the customData to each endpoint in ACH Origination. 
• Minor field description updates in the ACH Origination and RTP Send Payment APIs.

Developer Portal Release 2.0.1

• New API on the Developer Portal! We introduce our Webhooks specifications for ACH, Wire, and RTP transactions.
• In ACH Inquiry, you can recall transaction activity up to 24 months in the past.
• Our API consumers can now utilize the Wire and RTP transaction amounts for reconciliation and other business purposes when making an inquiry with the Intraday Information Reporting API. Each addenda object now includes a the transactionAmount field.
• Deprecated unused objects in Previous Day API.

Developer Portal Release 2.0.0

• New API on the Developer Portal! We introduce the Wire Origination API. This API transfers and processes large payments swiftly and securely.
• We’ve set a 5 TPS throttling threshold for all our APIs. If you think you might exceed this threshold, please reach out to your KeyBank representative to talk about adjusting it.
• MDM ID (mdmId) is no longer a required parameter for ACH Inquiry, Wire Inquiry, Previous Day, and Intraday Reporting. It’s now optional.
• Added new parameters to Wire Inquiry.

Developer Portal Release 1.2.3

Hot fix for the ACH Origination API to require companyEntryDescription for each of the SEC payment endpoints. This field returns in the ACH status response payload.

Developer Portal Release 1.2.0

• New API on the Developer Portal! We introduce the Account Validation API. This API validates a payee’s account to ensure a safe and secure transaction before authorizing payment.
• Added customData to the ACH Inquiry API. With custom data, you can enter up to 500 alphanumeric characters to create a custom message or data set to associate with the item.
• Modified date parameters in Wire Inquiry.
• Deprecated unused parameters from the Previous Day and Intraday APIs.

Developer Portal Release 1.1.0

Hello world! The KeyBank API Developer Portal is live!