Intraday is an information reporting API that retrieves transaction activity, balance summaries, and transaction counts for one or multiple checking accounts. Intraday focuses on a single day’s activity. Prerequisites and best practices KeyBank has some common prerequisites and best practices. All KeyBank APIs require certifications, user credentials, and certain permissions. Make sure to satisfy all prerequisites before building your API. Follow these steps to prepare for operations: Have valid certificates for a secure connection. Make sure you have the API keys needed for basic authentication and API access. Request a bearer token before you start. Check the health of the API. Know your MDM ID. Certificates Certificates are a digital authentication method we use to encrypt the information exchanged between KeyBank and your app or service. To access KeyBank environments, you must exchange valid certificates with KeyBank. These certificates must be properly installed on your system before you start to send API calls. API keys You need API keys to get a bearer token and to grant access to the APIs and the Pre-Production or Production environments. These API keys are created only for authenticated users that have partnered with KeyBank. For more information, see API security or sign up to become a KeyBank API consumer Bearer token Get a bearer token before you start. Only authenticated users with client credentials can request a bearer token. For more information, see API security or sign up to become a KeyBank API consumer Health check Before you start building your API, perform a quick health check. A health check verifies that the API is operational and responding correctly with your system. A bearer token is required to perform a health check. For more information, see Health check. MDM ID KeyBank assigns a Master Data Management (MDM) ID to each client. The MDM ID is used for account entitlement. This ID needs to be part of the API request to authorize the account’s data retrieval. The MDM ID can associate an ID with a single account or many accounts for verification and data retrieval. The MDM ID is shared via secure email. Endpoints Endpoint Result Description post /ddaReports/accounts/v1/transactions/intraday/list Get a list of transactions for a specific date Retrieve the transaction activity for one or multiple accounts for a specific date. post /ddaReports/accounts/v1/transactions/intraday/summary Get a summary report of transactions for a specific date Retrieve the summary of the account for all activity that occurred in a single day. post /ddaReports/accounts/v1/transactions/cda/summary Get a summary report for controlled disbursement accounts. Get a summary report of the day for specific CDAs. post /ddaReports/accounts/v1/transactions/current/balances Get the current balance for the checking account Get the current balance for one or more accounts. Get a list of transactions for a specific date post /ddaReports/accounts/v1/transactions/intraday/list Retrieve the transaction activity for one or multiple accounts for a specific date. Request HEADER FIELD TYPE DESCRIPTION X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. BODY FIELD TYPE DESCRIPTION accountNumberrequired array Enter the account number or numbers for your request. To display multiple accounts, separate the account number with a comma. The account number cannot be more than 16-digits in length. daterequired string Indicates the date for which the transactions are to be retrieved. mdmIdrequired string Enter KeyBank provided MDM ID during client onboarding. startRowIndexoptional string This is a pagination field. Set the number of records to display per page. If left blank, 1000 rows are displayed. endRowIndexoptional string This is a pagination field. Set the final number of rows of data to return. If left blank, 1000 rows are displayed. The maximum limit is 1000 transaction records per request. Request example { "getIntraDayTransactionsRequest": { "accountNumber": [ "123456789" ], "date": "2022-04-11", "mdmId": "ABCD12FG34", "startRowIndex": "1", "endRowIndex": "1" } } Responses Successful response NAME TYPE DESCRIPTION responseHeaderrequired Object responseHeaders IntraDayTransactionsoptional array IntraDayTransactions Response example (200) { "getIntraDayTransactionsResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully returned results for the requested range 1 to 10", "retrivedRows": "1", "totalRows": "1", "dataLoadDate": "2022-07-05" }, "IntraDayTransactions": [ { "accountNumber": "123456789", "transactionEffectiveDate": "04\/11\/2022", "transactionTypeId": "RTP", "addendaInformation": { "WiresData": { "creditArrangementTypeCode": "NOSTRO", "creditArrangementBankNumber": "0101", "creditArrangementBankBranch": "US", "creditArrangementCurrencyCode": "USD", "creditInvolvedPartyIdentifier": "22850641", "creditInvolvedPartyName": "TEST COMPANY 3, LLC", "creditArrangementCountryCode": "CORP", "creditInvolvedPartyTypeCode": "US", "debitArrangementTypeCode": "DDA", "debitArrangementBankNumber": "3290", "debitArrangementBankBranch": "US", "debitArrangementCurrencyCode": "USD", "debitInvolvedPartyIdentifier": "35008380", "debitInvolvedPartyName": "TEST COMPANY 1, LLC", "transactionBusinessStatusCode": "Completed", "sendingBankReferenceNumber": "KTT96632162612772R", "originatingInvolvedPartyName": "TEST COMPANY 1, LLC", "originatingArrangementNumber": "12345123", "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland", "originatingInvolvedPartyAddressLine2": "OH 44114", "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC", "beneficiaryArrangementNumber": "987654321", "beneficiaryInvolvedPartyAddressLine1": "250 Delaware Ave Ste", "beneficiaryInvolvedPartyAddressLine2": "Buffalo,NY 14202", "intermediaryBankName": "KeyBank National Association", "intermediaryBankABANumber": "21300077", "intermediaryBICCode": "KEYBUS33 XXX", "intermediaryBankAddressLine1": "250 Delaware Ave Ste", "intermediaryBankAddressLine2": "Buffalo,NY 14202", "originatingBankName": "ORIGINATING BANK USA", "originatingBankABANumber": "123001088", "originatingBankBICcode": "ORIBICODE", "originatingBankAddressLine1": "127 Public Sq", "originatingBankAddressLine2": "Cleveland, OH 44114", "beneficiaryBankName": "KeyBank National Association", "beneficiaryBankABANumber": "21300077", "beneficiaryBankBICcode": "KEYBUS33 XXX", "beneficiaryBankAddressLine1": "250 Delaware Ave Ste", "beneficiaryBankAddressLine2": "Buffalo,NY 14202", "sourceTransactionIdentifier": "NOTPROVIDED", "transactionSettledDate": "04\/11\/2022", "federalReferenceNumber": "20220411MMFMP1D002353", "incomingReferenceNumber": "2021092123304446", "transactionExecutedDate": "04\/11\/2022", "transactionIdentifier": "US22041123510763" }, "OLDSData": { "bankNumber": "0101", "transactionTypeId": "1085", "srcArrangementNumber": "123456789", "transactionEffDate": "25\/10\/2021", "transactionAmount": "375", "transactionTypeCode": "D", "transactionSrcCode": "ODS", "transactionDescription": "TRANSFER FROM CHECKING TO CHECKING" }, "LockboxData": { "lockboxNumber": "1234", "lockboxName": "Keybank Lockbox #1", "lockboxGrpNumber": "1001", "lockboxGrpName": "Keybank Group #1", "firstContactName": "John Doe", "firstContactStreetAddr": "127 Public Sq", "firstContactCity": "Cleveland", "firstContactState": "OH", "firstContactPostalCode": "44114", "firstDepositTransitNumber": "12235", "customDataField1": "XXX123" }, "LockboxTransactionData": { "DDAAccountNumber": "123456789", "processDate": "02\/01\/2022", "lockboxGrpBankNumber": "1001", "lockboxNumber": "1234", "remittanceTransactionNumber": "28", "remittancePaidAmount": "36.9", "paidAmount": "250", "payerFinInstRoutingNum": "000008002", "payerArrangementNum": "27911525005", "checkSeqNumber": "27911525005", "floatAmountDay0": "0", "floatAmountDay1": "250", "floatAmountDay2": "0" }, "CPCSData": { "sourceArrangementNumber": "1234567890", "regulationEDescription": "KEYCAP ", "transactionDescription2": "E#3830Y", "transactionEffectiveDate": "08\/09\/2021", "transactionActionCode": "D", "transactionAmount": "49985.07", "float1Amount": "49985", "creditOrDebitCode": "C", "traceID": "C 003121080937346069" }, "ACHTransactionData": { "transactionAmount": "2496.9", "transactionCode": "22" }, "RTPData": { "creditArrangementTypeCode": "NOSTRO", "creditArrangementBankNumber": "0101", "creditArrangementBankBranch": "US", "creditArrangementCurrencyCode": "USD", "creditInvolvedPartyIdentifier": "999997", "creditInvolvedPartyName": "TEST RTP Clearing Account", "creditArrangementCountryCode": "US", "debitArrangementTypeCode": "DDA", "debitArrangementBankNumber": "0618", "debitArrangementBankBranch": "US", "debitArrangementCurrencyCode": "USD", "debitInvolvedPartyIdentifier": "12359355", "debitInvolvedPartyName": "TEST COMPANY 2, LLC", "transactionBusinessStatusCode": "Completed", "originatingInvolvedPartyName": "TEST COMPANY 1, LLC", "originatingArrangementNumber": "12345123", "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland", "originatingInvolvedPartyAddressLine2": "OH 44114", "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC", "beneficiaryArrangementNumber": "987654321", "sourceTransactionIdentifier": "NOTPROVIDED", "transactionSettledDate": "09\/30\/2021", "federalReferenceNumber": "20210930041001039T1BUSRT06428125521", "transactionExecutedDate": "09\/30\/2021", "transactionIdentifier": "US21093000082075" } } } ] } } Missing data in the request NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (400) { "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": "Error Message from Backend Servers" } Received request is unauthorized NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (401) { "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": "Error Message from Backend Servers for unauthorized access" } Request is forbidden to access the resource NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (403) { "ErrorMessage": "Access to requested resource is forbidden", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested resource is not found NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (404) { "ErrorMessage": "Requested resource is not found, please verify the resource and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested method is not allowed. NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (405) { "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested unsupported media type NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (415) { "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Too many requests received NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (429) { "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Internal server error NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (500) { "ErrorMessage": "Runtime error occured in the service, please check with application support team before resubmitting the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Bad Gateway NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (502) { "ErrorMessage": "Bad Gateway, please resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } } Service Unavailable NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (503) { "ErrorMessage": "Service is currently unavailable(The service is temporarly unavailable), please check and resubmit the request.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } } Gateway timeout NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (504) { "ErrorMessage": "Request could not be processed on time, please resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request." } } Get a summary report of transactions for a specific date post /ddaReports/accounts/v1/transactions/intraday/summary Retrieve the summary of the account for all activity that occurred in a single day. Request HEADER FIELD TYPE DESCRIPTION X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. BODY FIELD TYPE DESCRIPTION accountNumberrequired array Enter the account number or numbers for your request. To display multiple accounts, separate the account number with a comma. The account number cannot be more than 16-digits in length. daterequired string Indicates the date for which the transactions are to be retrieved. mdmIdrequired string Enter KeyBank provided MDM ID during client onboarding. Request example { "getIntraDaySummaryRequest": { "accountNumber": [ "123456789" ], "date": "2021-11-15", "mdmId": "ABCD12FG34" } } Responses Successful response NAME TYPE DESCRIPTION responseHeaderrequired Object responseHeaders DDAIntraDaySummaryoptional array GetIntraDaySummaryResult Response example (200) { "getIntraDaySummaryResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully processed the request.", "dataLoadDate": "2022-07-05" }, "IntraDaySummary": [ { "accountNumber": "123456789", "earlyACHCredit": "5163394", "earlyACHCreditCount": "10", "lateACHCredit": "6137.55", "lateACHCreditCount": "1", "lockboxCredit": "0", "lockboxCreditCount": "0", "wireTransferCredit": "566308.64", "wireTransferCreditCount": "6", "depositsCredit": "0", "otherMiscCredit": "0", "otherMiscCreditCount": "0", "totalCredit": "5735840.19", "totalCreditCount": "17", "earlyACHDebit": "4602565.25", "earlyACHDebitCount": "2", "lateACHDebit": "0", "lateACHDebitCount": "0", "wireTransferDebit": "1420669.84", "wireTransferDebitCount": "2", "otherMiscDebit": "0", "otherMiscDebitCount": "0", "totalDebit": "6023235.09", "totalDebitCount": "4", "srcBankNum": "0101", "srcSysCode": "DDA" } ] } } Missing data in the request NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (400) { "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": "Error Message from Backend Servers" } Received request is unauthorized NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (401) { "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": "Error Message from Backend Servers for unauthorized access" } Request is forbidden to access the resource NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (403) { "ErrorMessage": "Access to requested resource is forbidden", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested resource is not found NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (404) { "ErrorMessage": "Requested resource is not found, please verify the resource and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested method is not allowed. NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (405) { "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested unsupported media type NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (415) { "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Too many requests received NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (429) { "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Internal server error NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (500) { "ErrorMessage": "Runtime error occured in the service, please check with application support team before resubmitting the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Bad Gateway NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (502) { "ErrorMessage": "Bad Gateway, please resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } } Service Unavailable NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (503) { "ErrorMessage": "Service is currently unavailable(The service is temporarly unavailable), please check and resubmit the request.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } } Gateway timeout NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (504) { "ErrorMessage": "Request could not be processed on time, please resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request." } } Get a control disbursement account summary report post /ddaReports/accounts/v1/transactions/cda/summary Get a summary report of the day for a specific account. Request HEADER FIELD TYPE DESCRIPTION X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. BODY FIELD TYPE DESCRIPTION accountNumberrequired array Enter the account number or numbers for your request. To display multiple accounts, separate the account number with a comma. The account number cannot be more than 16-digits in length. daterequired string Indicates the date for which the transactions are to be retrieved. mdmIdrequired string Enter KeyBank provided MDM ID during client onboarding. Request example { "getCDASummaryRequest": { "accountNumber": [ "123456789" ], "date": "2021-10-08", "mdmId": "ABCD12FG34" } } Responses Successful response NAME TYPE DESCRIPTION responseHeaderrequired Object responseHeaders CDASummaryoptional array GetCDASummaryResult Response example (200) { "getCDASummaryResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully processed the request.", "dataLoadDate": "2022-07-05" }, "CDASummary": [ { "summary": { "sourceArrangementNumber": "123456789", "snapshotDate": "10\/08\/2021", "sourceSystemOfRecordCode": "CDA", "currencyCode": "USD", "amount": "0", "amountTypeCode": "602", "FundTypeCode": "Z", "itemCount": "0", "processSequenceNumber": "1", "earlyACHCredit": "0", "earlyACHDebit": "3375.69", "earlyACHCreditCount": "0", "earlyACHDebitCount": "1" }, "CDATransactionDetails": { "transactionDate": "10\/08\/2021", "snapshotDate": "10\/08\/2021", "originatingFinancialInstitutionReferenceNumber": "1", "transactionDescription": "CHECK 0000144872", "transactionTypeCode": "475", "fundTypeCode": "Z", "amount": "3995.4", "processSequenceNumber": "1" }, "ACHMemoPost": { "sourceArrangementNumber": "123456789", "transactionProcessedDate": "10\/08\/2021", "transactionAmount": "2307.42", "transactionCreditDebitCode": "C", "derivedBAICode": "165", "transactionCode": "22", "description1": "TEST MERCHANT DEPOSIT", "description2": "896217706887", "description3": "42930550001626 8 CAR", "description4": "X IA TI", "transactionPostingWindow": "0600" } } ] } } Missing data in the request NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (400) { "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": "Error Message from Backend Servers" } Received request is unauthorized NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (401) { "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": "Error Message from Backend Servers for unauthorized access" } Request is forbidden to access the resource NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (403) { "ErrorMessage": "Access to requested resource is forbidden", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested resource is not found NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (404) { "ErrorMessage": "Requested resource is not found, please verify the resource and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested method is not allowed. NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (405) { "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested unsupported media type NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (415) { "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Too many requests received NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (429) { "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Internal server error NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (500) { "ErrorMessage": "Runtime error occured in the service, please check with application support team before resubmitting the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Bad Gateway NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (502) { "ErrorMessage": "Bad Gateway, please resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } } Service Unavailable NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (503) { "ErrorMessage": "Service is currently unavailable(The service is temporarly unavailable), please check and resubmit the request.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } } Gateway timeout NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (504) { "ErrorMessage": "Request could not be processed on time, please resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request." } } Get the current balance for the checking account post /ddaReports/accounts/v1/transactions/current/balances Get the current balance for one or more accounts. Request HEADER FIELD TYPE DESCRIPTION X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. BODY FIELD TYPE DESCRIPTION accountNumberrequired array Enter the account number or numbers for your request. To display multiple accounts, separate the account number with a comma. The account number cannot be more than 16-digits in length. daterequired string Indicates the date for which the transactions are to be retrieved. mdmIdrequired string Enter KeyBank provided MDM ID during client onboarding. Request example { "getCurrentBalancesRequest": { "accountNumber": [ "123456789" ], "date": "2021-11-15", "mdmId": "ABCD12FG34" } } Responses Successful response NAME TYPE DESCRIPTION responseHeaderoptional Object responseHeaders CurrentBalancesoptional array GetCurrentBalancesResult Response example (200) { "getCurrentBalancesResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully processed the request." }, "CurrentBalances": [ { "accountNumber": "123456789", "holds": "0.00", "uncollectedFunds": "0.00", "currentLedger": "3267948.16", "currentAvailable": "3267948.16", "openingAvailable": "3267948.16" } ] } } Missing data in the request NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (400) { "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": "Error Message from Backend Servers" } Received request is unauthorized NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (401) { "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": "Error Message from Backend Servers for unauthorized access" } Request is forbidden to access the resource NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (403) { "ErrorMessage": "Access to requested resource is forbidden", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested resource is not found NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (404) { "ErrorMessage": "Requested resource is not found, please verify the resource and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested method is not allowed. NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (405) { "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Requested unsupported media type NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (415) { "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Too many requests received NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (429) { "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Internal server error NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (500) { "ErrorMessage": "Runtime error occured in the service, please check with application support team before resubmitting the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" } Bad Gateway NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (502) { "ErrorMessage": "Bad Gateway, please resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } } Service Unavailable NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (503) { "ErrorMessage": "Service is currently unavailable(The service is temporarly unavailable), please check and resubmit the request.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } } Gateway timeout NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError Response example (504) { "ErrorMessage": "Request could not be processed on time, please resubmit the request", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request." } } Schemas exception NAME TYPE DESCRIPTION ErrorMessageoptional string Indicates the status description of the processed request. X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved. TransactionIdoptional string Indicates the unique ID that gets assigned for processed request. TransactionTimeoptional string Indicates the transaction processed time. ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError connectError NAME TYPE DESCRIPTION ConnectErroroptional string Error information of the connectivity with downstream service. ExceptionIntraDayList NAME TYPE DESCRIPTION ExceptionIntraDayList object GetIntraDayTransactionsResponseException ExceptionIntraDaySummary NAME TYPE DESCRIPTION ExceptionIntraDaySummary object GetIntraDaySummaryResponseException ExceptionCDASummary NAME TYPE DESCRIPTION ExceptionCDASummary object GetCDASummaryResponseException ExceptionCurrentBalance NAME TYPE DESCRIPTION ExceptionCurrentBalance object GetCurrentBalancesResponseException WiresData NAME TYPE DESCRIPTION creditArrangementTypeCodeoptional string Type of the Credit Account. creditArrangementBankNumberoptional string Bank Number holding the credit account. creditArrangementBankBranchoptional string Bank Branch holding the credit account. creditArrangementCurrencyCodeoptional string Transaction currency of Credit account. creditInvolvedPartyIdentifieroptional string Customer Number associated to the Credit account. creditInvolvedPartyNameoptional string Customer Name associated to the credit account. creditArrangementCountryCodeoptional string Country of the credit account. creditInvolvedPartyTypeCodeoptional string Customer Type associated to the credit account. debitArrangementTypeCodeoptional string Type of the Debit Account. debitArrangementBankNumberoptional string Bank Number holding the debit account. debitArrangementBankBranchoptional string Bank Branch holding the debit account. debitArrangementCurrencyCodeoptional string Transaction currency of debit account. debitInvolvedPartyIdentifieroptional string Customer Number associated to the debit account. debitInvolvedPartyNameoptional string Customer Name associated to the credit account. transactionBusinessStatusCodeoptional string Status of the transaction in a business process. sendingBankReferenceNumberoptional string This is the reference number attached to the wire from the sending bank. This could be anything the sending bank wants to put in as a REF NUM. originatingInvolvedPartyNameoptional string The name of the wire transaction originator. originatingArrangementNumberoptional string Account Number of the Originator. originatingInvolvedPartyAddressLine1optional string Originator Address Line1. originatingInvolvedPartyAddressLine2optional string Originator Address Line2. beneficiaryInvolvedPartyNameoptional string Beneficiary of the Wire payment. beneficiaryArrangementNumberoptional string Account Number of the Beneficiary. beneficiaryInvolvedPartyAddressLine1optional string Beneficiary Address Line1. beneficiaryInvolvedPartyAddressLine2optional string Beneficiary Address Line2. intermediaryBankNameoptional string Intermediatory Bank Name. intermediaryBankABANumberoptional string Intermediatory Bank ABA number. intermediaryBICCodeoptional string Intermediatory Bank BIC number. intermediaryBankAddressLine1optional string Intermediatory Bank Address Line1. intermediaryBankAddressLine2optional string Intermediatory Bank Address Line2. originatingBankNameoptional string Debitor Bank Name. originatingBankABANumberoptional string Originator Bank ABA number. originatingBankBICcodeoptional string Wire Originator Bank BIC. originatingBankAddressLine1optional string Wire Originator Bank Address Line 1. originatingBankAddressLine2optional string Wire Originator Bank Address Line 2. beneficiaryBankNameoptional string Creditor/Beneficiary Bank Name. beneficiaryBankABANumberoptional string Creditor Bank ABA number. beneficiaryBankBICcodeoptional string Creditor Bank BIC. beneficiaryBankAddressLine1optional string Creditor Bank Address Line 1. beneficiaryBankAddressLine2optional string Creditor Bank Address Line 2. sourceTransactionIdentifieroptional string End to End Id to uniquely identify a transaction in source systems. transactionSettledDateoptional string Date when the transaction is settled. federalReferenceNumberoptional string Federal Clearing Reference Number. incomingReferenceNumberoptional string Incoming Reference Number. currencyExchangeRateoptional string Exchange Rate. transactionExecutedDateoptional string Date the transaction is executed. bankToBankMemooptional string Bank To Bank Intrstuction. transactionIdentifieroptional string Transaction Identifier. getIntraDayTransactionsResponse NAME TYPE DESCRIPTION responseHeaderrequired Object responseHeaders IntraDayTransactionsoptional array IntraDayTransactions responseHeaders NAME TYPE DESCRIPTION statusrequired string Indicates whether the result was successfully retrieved statusDescriptionrequired string Description of the status dataLoadDateoptional string Indicates the date that the requested data was loaded. The date format is YYYY-MM-DD. For example, 2022-04-01. retrivedRowsoptional string Total number of transactions retrieved. totalRowsoptional string Total number of transactions matching the requested criteria. GetIntraDayTransactionsResponseException NAME TYPE DESCRIPTION statusrequired string Indicates whether the result was successfully retrieved statusDescriptionrequired string Description of the status dataLoadDateoptional string Indicates the date that the requested data was loaded. The date format is YYYY-MM-DD. For example, 2022-04-01. retrivedRowsoptional string Total number of transactions retrieved. totalRowsoptional string Total number of transactions matching the requested criteria. errorResponseoptional Object ErrorResponse LockboxTransactionData NAME TYPE DESCRIPTION DDAAccountNumberoptional string DDA Account Number associated with Lockbox. processDateoptional string Transaction Process Date. lockboxGrpBankNumberoptional string Not KeyBank bank number. Used by Lockbox application to group Lockboxes. lockboxNumberoptional string Lockbox Number. remittanceTransactionNumberoptional string Transaction Number. remittancePaidAmountoptional string Remittance Applied Amount. paidAmountoptional string Amount being paid by the payment record. payerFinInstRoutingNumoptional string Routing and Transit Number Field from Payment. This is the Routing number of the payer account. payerArrangementNumoptional string Account Number field from Payment. checkSeqNumberoptional string Check Number from Payment. floatAmountDay0optional string Lockbox Float - Amount available Day 0. floatAmountDay1optional string Lockbox Float - Amount available Day 1. floatAmountDay2optional string Lockbox Float - Amount available Day 2. GetCurrentBalancesRequest NAME TYPE DESCRIPTION accountNumberrequired array Enter the account number or numbers for your request. To display multiple accounts, separate the account number with a comma. The account number cannot be more than 16-digits in length. daterequired string Indicates the date for which the transactions are to be retrieved. mdmIdrequired string Enter KeyBank provided MDM ID during client onboarding. IntraDayTransactionsResult NAME TYPE DESCRIPTION accountNumberoptional string Indicates the account number for the processed summary record. transactionEffectiveDateoptional string Effective date of the transaction. transactionTypeIdoptional string 4 digit transation type identifier. addendaInformationoptional Object AddendaInformation CurrentBalances NAME TYPE DESCRIPTION holdsoptional string Indicates the amount that is on hold. uncollectedFundsoptional string Indicates the uncollected funds amount. currentLedgeroptional string Indicates the current ledger balance. currentAvailableoptional string Indicates the current available balance. openingAvailableoptional string Indicates the opening available balance. IntraDayTransactions NAME TYPE DESCRIPTION accountNumberoptional string Indicates the account number for the processed summary record. transactionEffectiveDateoptional string Effective date of the transaction. transactionTypeIdoptional string 4 digit transation type identifier. addendaInformationoptional Object AddendaInformation GetCurrentBalancesResponse NAME TYPE DESCRIPTION responseHeaderoptional Object responseHeaders CurrentBalancesoptional array GetCurrentBalancesResult GetCurrentBalancesResponseException NAME TYPE DESCRIPTION statusrequired string Indicates whether the result was successfully retrieved statusDescriptionrequired string Description of the status dataLoadDateoptional string Indicates the date that the requested data was loaded. The date format is YYYY-MM-DD. For example, 2022-04-01. retrivedRowsoptional string Total number of transactions retrieved. totalRowsoptional string Total number of transactions matching the requested criteria. errorResponseoptional Object ErrorResponse LockboxData NAME TYPE DESCRIPTION lockboxNumberoptional string Lockbox Number. lockboxNameoptional string Lockbox Name. lockboxGrpNumberoptional string Lockbox Grouping Number. lockboxGrpNameoptional string Lockbox Grouping Name. firstContactNameoptional string First Contact Name defined in Lockbox Contacts. firstContactStreetAddroptional string Street address for named Contact. firstContactCityoptional string City for named Contact. firstContactStateoptional string State for named Contact. firstContactPostalCodeoptional string Zip Code for named Contact. firstDepositTransitNumberoptional string Transit number for Contact. customDataField1optional string Custom Data Field. Detail NAME TYPE DESCRIPTION transactionEarlyACHCreditoptional string Indicates total credit amount as of 0600 posting window transactionEarlyACHDebitoptional string Indicates total debit amount as of 0600 posting window transactionEarlyACHCreditCountoptional string Indicates total number of ACH credit transactions as of 0600 posting window. transactionEarlyACHDebitCountoptional string Indicates total number of ACH debit transactions as of 0600 posting window. transactionDateoptional string The date when the transaction is posted. snapshotDateoptional string This field denotes the date that the requested data was loaded. originatingFinancialInstitutionReferenceNumberoptional string Reference number of the originating Financial Institution. currencyCodeoptional string Currency code of the particular transaction. transactionDescriptionoptional string A brief description of the transaction, like the check number transactionTypeCodeoptional string The KeyBank Hogan Code for a particular transaction. fundTypeCodeoptional string The code assiciated to the type of fund. amountoptional string The amount of a particular transaction customerReferenceNumberoptional string This is the reference number attached to the customer. processSequenceNumberoptional string The sequence number of the transaction. ErrorResponse NAME TYPE DESCRIPTION businessFaultoptional array BusinessFault systemFaultoptional array SystemFault GetIntraDaySummaryResponse NAME TYPE DESCRIPTION responseHeaderrequired Object responseHeaders DDAIntraDaySummaryoptional array GetIntraDaySummaryResult GetIntraDaySummaryResponseException NAME TYPE DESCRIPTION statusrequired string Indicates whether the result was successfully retrieved statusDescriptionrequired string Description of the status dataLoadDateoptional string Indicates the date that the requested data was loaded. The date format is YYYY-MM-DD. For example, 2022-04-01. errorResponseoptional Object ErrorResponse RTPData NAME TYPE DESCRIPTION creditArrangementTypeCodeoptional string Type of the Credit Account. creditArrangementBankNumberoptional string Bank Number holding the credit account. creditArrangementBankBranchoptional string Bank Branch holding the credit account. creditArrangementCurrencyCodeoptional string Transaction currency of Credit account. creditInvolvedPartyIdentifieroptional string Customer Number associated to the Credit account. creditInvolvedPartyNameoptional string Customer Name associated to the credit account. creditArrangementCountryCodeoptional string Country code of the credit account. creditInvolvedPartyTypeCodeoptional string Customer Type associated to the credit account. debitArrangementTypeCodeoptional string Type of the Debit Account. debitArrangementBankNumberoptional string Bank Number holding the debit account. debitArrangementBankBranchoptional string Bank Branch holding the debit account. debitArrangementCurrencyCodeoptional string Transaction currency of debit account. debitInvolvedPartyIdentifieroptional string Customer Number associated to the debit account. debitInvolvedPartyNameoptional string Customer Name associated to the credit account. transactionBusinessStatusCodeoptional string Status of the transaction in a business process. sendingBankReferenceNumberoptional string This is the reference number attached to the wire from the sending bank. This could be anything the sending bank wants to put in as a REF NUM. originatingInvolvedPartyNameoptional string The name of the wire transaction originator. originatingArrangementNumberoptional string Account Number of the Originator. originatingInvolvedPartyAddressLine1optional string Originator Address Line1. originatingInvolvedPartyAddressLine2optional string Originator Address Line2. beneficiaryInvolvedPartyNameoptional string Beneficiary of the Wire payment. beneficiaryArrangementNumberoptional string Account Number of the Beneficiary. beneficiaryInvolvedPartyAddressLine1optional string Beneficiary Address Line1. beneficiaryInvolvedPartyAddressLine2optional string Beneficiary Address Line2. intermediaryBankNameoptional string Intermediatory Bank Name. intermediaryBankABANumberoptional string Intermediatory Bank ABA number. intermediaryBICCodeoptional string Intermediatory Bank BIC number. intermediaryBankAddressLine1optional string Intermediatory Bank Address Line1. intermediaryBankAddressLine2optional string Intermediatory Bank Address Line2. originatingBankNameoptional string Originator Bank Name. originatingBankABANumberoptional string Originator Bank ABA number. originatingBankBICcodeoptional string Wire Originator Bank BIC. originatingBankAddressLine1optional string Wire Originator Bank Address Line 1. originatingBankAddressLine2optional string Wire Originator Bank Address Line 2. beneficiaryBankNameoptional string Creditor/Beneficiary Bank Name. beneficiaryBankABANumberoptional string Creditor Bank ABA number. beneficiaryBankBICcodeoptional string Creditor Bank BIC. beneficiaryBankAddressLine1optional string Creditor Bank Address Line 1. beneficiaryBankAddressLine2optional string Creditor Bank Address Line 2. sourceTransactionIdentifieroptional string End to End Id to uniquely identify a transaction in source systems. transactionSettledDateoptional string Date when the transaction is settled. federalReferenceNumberoptional string Federal Clearing Reference Number. incomingReferenceNumberoptional string Incoming Reference Number. currencyExchangeRateoptional string Exchange Rate. transactionExecutedDateoptional string Date the transaction is executed. bankToBankMemooptional string Bank To Bank Instruction. transactionIdentifieroptional string Transaction Identifier. Source NAME TYPE DESCRIPTION pointeroptional string Reason of failure. parameteroptional string Error occurred due to which attribute. GetCurrentBalancesResult NAME TYPE DESCRIPTION currentBalancesoptional Object CurrentBalances BusinessFault NAME TYPE DESCRIPTION errorCodeoptional string errorDescriptionoptional string GetCDASummaryRequest NAME TYPE DESCRIPTION accountNumberrequired array Enter the account number or numbers for your request. To display multiple accounts, separate the account number with a comma. The account number cannot be more than 16-digits in length. daterequired string Indicates the date for which the transactions are to be retrieved. mdmIdrequired string Enter KeyBank provided MDM ID during client onboarding. OLDSData NAME TYPE DESCRIPTION bankNumberoptional string This field denotes one of the KeyBank bank numbers. transactionTypeIdoptional string 4 digit transation type identifier. srcArrangementNumberoptional string Can be any account number, DDA, Loan Account, Credit Card or Savings. transactionEffDateoptional string Date when transaction is effective. transactionAmountoptional string Dollar value of the amount. transactionTypeCodeoptional string Designates credit/debit. reversalFlagoptional string Denotes if the transaction is a reversal transaction of an earlier transaction. transactionSrcCodeoptional string Identifies the source of the transaction. transactionDescriptionoptional string May contain description of the transaction. traceIdoptional string This field can be used to lookup a DDA transaction for the Memo posted transaction. transactionCodeBAI2optional string BAI2 transaction Code. getIntraDayTransactionsRequest NAME TYPE DESCRIPTION accountNumberrequired array Enter the account number or numbers for your request. To display multiple accounts, separate the account number with a comma. The account number cannot be more than 16-digits in length. daterequired string Indicates the date for which the transactions are to be retrieved. mdmIdrequired string Enter KeyBank provided MDM ID during client onboarding. startRowIndexoptional string This is a pagination field. Set the number of records to display per page. If left blank, 1000 rows are displayed. endRowIndexoptional string This is a pagination field. Set the final number of rows of data to return. If left blank, 1000 rows are displayed. The maximum limit is 1000 transaction records per request. Summary NAME TYPE DESCRIPTION sourceArrangementNumberoptional string Account Number. snapshotDateoptional string This field denotes the date that the requested data was loaded. sourceSystemOfRecordCodeoptional string This field is for internal purpose only. currencyCodeoptional string Currency code of the particular transaction. amountoptional string The amount of a particular transaction. amountTypeCodeoptional string The code associated to the amount.Possible values are 580 - Total Controlled Disbursing Debits,584 Total Disbursing Checks Paid Later Amount,602 - Total Adjustments,585 - Required Funding Amout. FundTypeCodeoptional string The code associated to the type of fund. itemCountoptional string Total number of transactions. processSequenceNumberoptional string The sequence number of the transaction. earlyACHCreditoptional string Indicates credit amount as of 0600 posting window. earlyACHDebitoptional string Indicates dedit amount as of 0600 posting window. CPCSData NAME TYPE DESCRIPTION transactionPostedDateoptional string Transation Posted Date. sourceArrangementNumberoptional string Account Number. transactionDescriptionPart1optional string Descriptions Part 1. transactionDescriptionPart2optional string Descriptions Part 2. transactionDescriptionPart3optional string Descriptions Part 3. regulationEDescriptionoptional string Reg E Descriptions. transactionDescription2optional string Description 2. transactionEffectiveDateoptional string Effective date of the transaction. transactionActionCodeoptional string Transaction Action Identifier. transactionAmountoptional string Transaction Amount. cashAmountoptional string Cash part of amount. checkIdentificationNumberoptional string Can contain serial number of item or store number for identification purposes. float0Amountoptional string Float 0 amount. float1Amountoptional string Float 1 amount. float2Amountoptional string Float 2 amount. float3Amountoptional string Float 3 amount. float4Amountoptional string Float 4 amount. float5Amountoptional string Float 5 amount. float6Amountoptional string Float 6 amount. float7Amountoptional string Float 7 amount. priorDateFlagoptional string If the transaction date is prior to current business date then this is set to a "P". creditOrDebitCodeoptional string Credit or Debit Type of transaction. traceIDoptional string The T-TRACE-ID is used to research the transaction in the interfacing application. SystemFault NAME TYPE DESCRIPTION errorCodeoptional string Indicates error code of the processed request. errorDescriptionoptional string Indicates error description of the processed request. GetCDASummaryResult NAME TYPE DESCRIPTION summaryoptional Object Summary detailoptional Object Detail GetCDASummaryResponse NAME TYPE DESCRIPTION responseHeaderrequired Object responseHeaders CDASummaryoptional array GetCDASummaryResult GetCDASummaryResponseException NAME TYPE DESCRIPTION statusrequired string Indicates whether the result was successfully retrieved statusDescriptionrequired string Description of the status dataLoadDateoptional string Indicates the date that the requested data was loaded. The date format is YYYY-MM-DD. For example, 2022-04-01. retrivedRowsoptional string Total number of transactions retrieved. totalRowsoptional string Total number of transactions matching the requested criteria. errorResponseoptional Object ErrorResponse AddendaInformation NAME TYPE DESCRIPTION WiresDataoptional Object WiresData OLDSDataoptional Object OLDSData LockboxDataoptional Object LockboxData LockboxTransactionDataoptional Object LockboxTransactionData CPCSDataoptional Object CPCSData ACHTransactionDataoptional Object ACHTransactionData RTPDataoptional Object RTPData ACHTransactionData NAME TYPE DESCRIPTION addendaPresentFlagoptional string Addenda Present Flag. transactionAmountoptional string Transaction Amount. nachaBatchNumberoptional string NACHA Batch Number. checkSerialNumberoptional string Check Serial Number. transactionDescription1optional string Transaction Description. originatingCompanyIDNumberoptional string Originating Company ID. originatingCompanyNameoptional string Originating Company Name. creditOrDebitCodeoptional string Transaction Credit or Debit Identifier. originalReceiverCodeoptional string Identifies the type Originating/Receiving and Incoming/Outgoing. sourceTransactionProcessedDateoptional string Source Transaction Processed Date. receivingArrangementNumberoptional string Receiver Account number. sourceTransactionPostedDateoptional string Source Transaction Posted Date. nachaFileReferenceNumberoptional string NACHA File Reference Number. collectionPointoptional string Collection Point. goRoutingNumberoptional string Gateway Operator Routing Number. receivingCustomerIDNumberoptional string Receiving Customer ID Number. receivingCustomerNameoptional string Receiving Customer Name. receivingCompanyNameoptional string Receiving Customer Company Name. addendaRecordNumberoptional string Number of Addenda Records. originatingCustomerNameoptional string Originating Customer Name. originatingFinancialInstitutionRoutingNumberoptional string Originating FI Routing Number. authorisedCustomerNameoptional string Authorized Customer Name. originatingArrangementNumberoptional string Originating Account Number. receivingFinancialInstitutionBankNumberoptional string Receiving FI Bank Number. receivingFinancialInstitutionRoutingNumberoptional string Receiving FI Routing Number. nachaStandardEntryClassCodeoptional string NACHA SEC Code. transactionPARNumberoptional string ACH Product Processor Transaction Identifier. transactionCodeoptional string Transaction Code. sourceTransactionSetteledDateoptional string Source Transaction Settled Date. inboundCollectionWindowoptional string Transaction Collection Window. IATFlagoptional string IAT Transaction Identifier. transactionTraceIDoptional string Transaction Trace ID. originatingFinancialInstitutionBankNumberoptional string Originating FI Bank Number. GetIntraDaySummaryRequest NAME TYPE DESCRIPTION accountNumberrequired array Enter the account number or numbers for your request. To display multiple accounts, separate the account number with a comma. The account number cannot be more than 16-digits in length. daterequired string Indicates the date for which the transactions are to be retrieved. mdmIdrequired string Enter KeyBank provided MDM ID during client onboarding. GetIntraDaySummaryResult NAME TYPE DESCRIPTION earlyACHCreditoptional string Indicates total credit amount as of 0600 posting window. earlyACHCreditCountoptional string Indicates total number of ACH credit transactions as of posting window. lateACHCreditoptional string Indicates total credit amount from other posting windows other than 0600. lateACHCreditCountoptional string Indicates total number of ACH credit transactions from other posting windows other than 0600. lockboxCreditoptional string Indicates total of lockbox transaciton amounts. lockboxCreditCountoptional string Indicates total number of lockbox credit transactions. wireTransferCreditoptional string Indicates wire transfer credit amount. wireTransferCreditCountoptional string Indicates total number of wire Transfer credit transactions. depositsCreditoptional string Indicates total credit amount through deposits. otherMiscCreditoptional string Indicates other miscellaneous credit amounts. otherMiscCreditCountoptional string Indicates total number of miscellaneous debit transactions. totalCreditoptional string Indicates total credit amount from Memo post, Lockbox,Wires,OLDS,CPCS transactions. totalCreditCountoptional string Indicates total number of credits from Memo post, Lockbox,Wires,OLDS,CPCS transactions. earlyACHDebitoptional string Indicates total debit amount as of 0600 posting window. earlyACHDebitCountoptional string Indicates total number of ACH debit transactions as of posting window. lateACHDebitoptional string Indicates total debit amount from other posting windows other than 0600. lateACHDebitCountoptional string Indicates total number of ACH debit transactions from other posting windows other than 0600. wireTransferDebitoptional string Indicates wire transfer debit amount. wireTransferDebitCountoptional string Indicates total number of wire Transfer debit transactions. otherMiscDebitoptional string Indicates total debit amount through deposits. otherMiscDebitCountoptional string Indicates other miscellaneous debit amounts. totalDebitoptional string Indicates total number of miscellaneous debit transactions. totalDebitCountoptional string Indicates total debit amount from Memo post, Lockbox,Wires,OLDS,CPCS transactions. currentBalancesoptional Object GetCurrentBalancesResult ErrorTemplate NAME TYPE DESCRIPTION idoptional string Error reference id. linksoptional Object Links statusoptional string Indicates the status of the request. codeoptional string Error code if any. titleoptional string Error description. detailoptional string Detailed error description. sourceoptional Object Source metaoptional string Additional infomration of the error. Links NAME TYPE DESCRIPTION aboutoptional string Error reference links description. Error handling An error can indicate a problem with the request, the network, or the API itself. Use the error handling information to get a better understanding of what went wrong and possible corrective actions. Status messages Some APIs contain status messages in the responseHeader object of the response payload. The status field returns the status code S, W, or F. Successful responses return the status code S with an HTTP 200 status code. Responses that were not processed as expected or failed to be processed at all return the status code W for warning or F for failure. Warning messages are associated with HTTP 299 status code. A warning message means the request was successfully received, but there was a minor issue that requires your attention. Failure messages are associated with the HTTP 400 or 500 status codes. Additional information is shared in the statusDescription field. Standard error message format An erroneous response returns the HTTP code number with the content of the exception schema. Additional information in this schema like the transaction ID and transaction time can help you diagnose the issue. The schema includes the X-CorrelationId field to help with traceability. API-specific error messages Custom messages are used for API-related functional business messages or faults. Each API can contain custom messages specific to KeyBank operations or the API. These messages can be part of the exception schema or a separate object. For errors specific to the API, we use the ServiceError > errorResponse object in the exception schema and the errors object in the response payload. Error codes and messages Standard errors use the typical HTTP status codes. Messages specific to KeyBank have an asterisk (*) after the message code number. The ServiceError > errorResponse object has additional information specific to the API. KeyBank error codes start with ECA-W with a three-digit number that follows. The number increases by one digit for each error message. For example, if you have an issue with your request that generates two error messages specific to the API, the codes will be ECA-W-001 and ECA-W-002. HTTP STATUS CODE CUSTOM STATUS CODE DESCRIPTION 200* Transaction not found. Status is S for Success. The request was received, but there is no result for the requested criteria. 299* Request processing completed with warnings. Status is W for Warning. This message occurs when multiple request parameters are provided, and some of the data are not available as part of response. 400* ECA-W-001 Request Validation failed. Status is F for Failure. There is missing mandatory information like accountNumber, fromDate, toDate, or mdmID. Review values for mandatory request fields. 400* ECA-W-001 Error occurred while validating account association. Status is F for Failure. The MDM ID provided in the request is invalid or empty. 400* ECA-W-001 Requested records range is greater than the allowed limit - 1000 Status is F for Failure. Response goes beyond 1000 transactions for the requested account. Change the request criteria to help limit returned transactions to the allowed amount. 400 Missing data in the request. Mandatory data not provided, please verify the data and resubmit the request. 401 Received request is unauthorized. Received request is unauthorized, please provide valid credentials. 403 Request is forbidden to access the resource. Access to requested resource is forbidden. 404 Request resource is not found. Requested resource is not found, please verify the resource and resubmit the request. 405 Request method is not allowed. Requested method is not allow, please verify the method and resubmit the request. 415 Requested unsupported media type. Requested media type is not allowed, please verify the media type and resubmit the request. 429 Too many request received. Number requests threshold reached, please resubmit the request after sometime. 500 Internal server error. Unknown error occurred, please resubmit the request. 502 Bad Gateway. Bad Gateway, please resubmit the request 503 Service Unavailable. Service is currently unavailable, please resubmit the request. 504 Gateway timeout. Request could not be processed on time, please resubmit the request. YAML file