Get the memo for today's activities
Intraday Information Reporting Endpoints
What you can do | Endpoint |
---|---|
Health check | get /ddaReports/accounts/v1/healthCheck |
Get a list of transactions for the current day | post /ddaReports/accounts/v1/transactions/intraday/list |
Get an account summary report for the current day | post /ddaReports/accounts/v1/transactions/intraday/summary |
Get a CDA summary report for the current day | post /ddaReports/accounts/v1/transactions/cda/summary |
Get the current balance for one or more accounts | post /ddaReports/accounts/v1/transactions/current/balances |
Before you begin
All KeyBank APIs require certificates, user credentials, and certain permissions. Check out our Getting Started Guide to learn more.
Overview
Intraday information includes all memo transactions from the current day, such as deposit activity, CDA funding requirements, incoming CDA checks, incoming ACH debits and credits, incoming wires, and ACH and wire transactions that you originate.
What does that code mean?
We can't be expected to remember it all. Look at our Data values page to find definitions for BAI codes and transaction type codes.
Health check
get /ddaReports/accounts/v1/healthCheck
Verify you can connect to the API service. A bearer token is required.
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
Statusoptional | string | Status of the health check response. |
Sourceoptional | string | Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved. |
Timestampoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service. |
ClientIpoptional | string | Client IP address the gateway receives from the request. |
X-Forwarded-Foroptional | string | Sequence of IP addresses for systems between the client and the gateway. |
Response example (200)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "Status": "Ok", "Source": "Roundtrip", "Timestamp": "2022-09-15T04:49:03", "ClientIp": "156.77.111.28", "X-Forwarded-For": "[156.77.111.28]" }
Get a list of transactions for the current day
post /ddaReports/accounts/v1/transactions/intraday/list
Retrieve current-day transaction activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months.
Request
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters. |
daterequired | string | Date for which the list of transactions is to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD |
startRowIndexoptional | string | Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1. |
endRowIndexoptional | string | Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex. |
Request example
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "getIntraDayTransactionsRequest": { "accountNumber": [ "123456789" ], "date": "2022-04-11", "startRowIndex": "1", "endRowIndex": "1" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
IntraDayTransactionsoptional | array | IntraDayTransactions |
Response example (200)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "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": { "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" }, "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", "transactionAmount": "400" } } } ] } }
Missing mandatory information
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (400)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Unauthorized request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (401)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "getIntraDayTransactionsResponse": { "responseHeader": { "status": "F", "statusDescription": "Error Message from Backend Servers for unauthorized access" }, "errorResponse": { "businessFault": [ { "errorCode": "ECA-W-001", "errorDescription": "Error Message from Backend Servers for unauthorized access" } ] } } } }
Forbidden request access
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (403)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Resource not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (404)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Invalid request method
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (405)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Invalid request type
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (415)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (429)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Unknown error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (500)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (502)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request" } }
Unavailable service
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (503)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request." } }
Unable to process request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (504)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "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 an account summary report for the current day
post /ddaReports/accounts/v1/transactions/intraday/summary
Retrieve a summary of current-day account activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months.
Request
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters. |
daterequired | string | Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD |
Request example
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "getIntraDaySummaryRequest": { "accountNumber": [ "123456789" ], "date": "2021-11-15" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
DDAIntraDaySummaryoptional | array | GetIntraDaySummaryResult |
Response example (200)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "getIntraDaySummaryResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully processed the request.", "dataLoadDate": "2022-07-05" }, "DDAIntraDaySummary": [ { "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 mandatory information
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (400)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "getIntraDaySummaryResponse": { "responseHeader": { "status": "F", "statusDescription": "Request Validation failed." }, "errorResponse": { "businessFault": [ { "errorCode": "ECA-W-001", "errorDescription": "Missing mandatory field(s) - accountNumber." } ] } } } }
Unauthorized request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (401)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "getIntraDaySummaryResponse": { "responseHeader": { "status": "F", "statusDescription": "Error Message from Backend Servers for unauthorized access" }, "errorResponse": { "businessFault": [ { "errorCode": "ECA-W-001", "errorDescription": "Error Message from Backend Servers for unauthorized access" } ] } } } }
Forbidden request access
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (403)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Resource not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (404)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Invalid request method
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (405)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Invalid request type
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (415)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (429)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Unknown error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (500)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (502)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request" } }
Unavailable service
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (503)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request." } }
Unable to process request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (504)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "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 CDA summary report for the current day
post /ddaReports/accounts/v1/transactions/cda/summary
Retrieve a summary of current-day account activity for one or multiple Controlled Disbursement Accounts (CDA). Transaction data can be recalled from the previous 24 months.
Request
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters. |
daterequired | string | Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD |
Request example
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "getCDASummaryRequest": { "accountNumber": [ "123456789" ], "date": "2021-10-08" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
CDASummaryoptional | array | GetCDASummaryResult |
Response example (200)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "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" }, "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 mandatory information
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (400)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "getCDASummaryResponse": { "responseHeader": { "status": "F", "statusDescription": "Request Validation failed.", "dataLoadDate": "2021-03-26", "retrivedRows": "1", "totalRows": "10" }, "errorResponse": { "businessFault": [ { "errorCode": "ECA-W-001", "errorDescription": "Missing mandatory field(s) - accountNumber." } ] } } } }
Unauthorized request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (401)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "getCDASummaryResponse": { "responseHeader": { "status": "F", "statusDescription": "Error Message from Backend Servers for unauthorized access", "dataLoadDate": "2021-03-26", "retrivedRows": "1", "totalRows": "10" }, "errorResponse": { "businessFault": [ { "errorCode": "ECA-W-001", "errorDescription": "Error Message from Backend Servers for unauthorized access" } ] } } } }
Forbidden request access
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (403)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Resource not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (404)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Invalid request method
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (405)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Invalid request type
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (415)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (429)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Unknown error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (500)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (502)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request" } }
Unavailable service
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (503)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request." } }
Unable to process request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (504)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "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 one or more accounts
post /ddaReports/accounts/v1/transactions/current/balances
Retrieve the current balance information, including both ledger and available balance, for one or more accounts. Transaction data can be recalled from the previous 24 months.
Request
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters. |
daterequired | string | Date for which the current balances are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD |
Request example
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "getCurrentBalancesRequest": { "accountNumber": [ "123456789" ], "date": "2021-11-15" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderoptional | Object | responseHeaders |
CurrentBalancesoptional | array | GetCurrentBalancesResult |
Response example (200)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "getCurrentBalancesResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully processed the request." }, "CurrentBalances": [ { "currentBalances": { "holds": "0.00", "uncollectedFunds": "0.00", "currentLedger": "3267948.16", "currentAvailable": "3267948.16", "openingAvailable": "3267948.16" } } ] } }
Missing mandatory information
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (400)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "getCurrentBalancesResponse": { "responseHeader": { "status": "F", "statusDescription": "Request Validation failed.", "dataLoadDate": "2021-03-26", "retrivedRows": "1", "totalRows": "10" }, "errorResponse": { "businessFault": [ { "errorCode": "ECA-W-001", "errorDescription": "Missing mandatory field(s) - accountNumber." } ] } } } }
Unauthorized request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (401)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "getCurrentBalancesResponse": { "responseHeader": { "status": "F", "statusDescription": "Error Message from Backend Servers for unauthorized access", "dataLoadDate": "2021-03-26", "retrivedRows": "1", "totalRows": "10" }, "errorResponse": { "businessFault": [ { "errorCode": "ECA-W-001", "errorDescription": "Error Message from Backend Servers for unauthorized access" } ] } } } }
Forbidden request access
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (403)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Resource not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (404)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Invalid request method
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (405)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Invalid request type
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (415)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (429)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Unknown error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (500)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (502)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request" } }
Unavailable service
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (503)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request." } }
Unable to process request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
Response example (504)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "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
ACHMemoPost
NAME | TYPE | DESCRIPTION |
---|---|---|
sourceArrangementNumberoptional | string | Account number |
transactionProcessedDateoptional | string | Date the transaction was processed. Format: YYYY-MM-DD |
transactionAmountoptional | string | Transaction amount |
transactionCreditDebitCodeoptional | string | Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit) |
derivedBAICodeoptional | string | BAI2 transaction code |
transactionCodeoptional | string | Two-digit code identifying the account type at the receiving financial institution. |
description1optional | string | Brief description of the transaction. |
description2optional | string | Brief description of the transaction. |
description3optional | string | Brief description of the transaction. |
description4optional | string | Brief description of the transaction. |
transactionPostingWindowoptional | string | Posting window of the transaction. |
ACHTransactionData
NAME | TYPE | DESCRIPTION |
---|---|---|
sourceArrangementNumberoptional | string | Account number |
transactionProcessedDateoptional | string | Date the transaction was processed. Format: YYYY-MM-DD |
transactionAmountoptional | string | Transaction amount |
transactionCreditDebitCodeoptional | string | Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit) |
derivedBAICodeoptional | string | BAI2 transaction code |
transactionCodeoptional | string | Two-digit code identifying the account type at the receiving financial institution. |
description1optional | string | Brief description of the transaction. |
description2optional | string | Brief description of the transaction. |
description3optional | string | Brief description of the transaction. |
description4optional | string | Brief description of the transaction. |
transactionPostingWindowoptional | string | Posting window of the transaction. |
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 |
BusinessFault
NAME | TYPE | DESCRIPTION |
---|---|---|
errorCodeoptional | string | Business error code |
errorDescriptionoptional | string | A human-readable message that describes the type or source of the business error. |
CDATransactionDetails
NAME | TYPE | DESCRIPTION |
---|---|---|
transactionDateoptional | string | Date the transaction posted. Format: MM-DD-YYYY |
snapshotDateoptional | string | Date that requested data was loaded. Format: MM-DD-YYYY |
originatingFinancialInstitutionReferenceNumberoptional | string | Reference number of the originating financial institution. |
currencyCodeoptional | string | Currency code of the transaction. Default value: USD |
transactionDescriptionoptional | string | Brief description of the transaction. |
transactionTypeCodeoptional | string | The banking processor code for a particular transaction type. |
fundTypeCodeoptional | string | Code associated with the fund type. |
amountoptional | string | Transaction amount |
customerReferenceNumberoptional | string | Reference number attached to the customer. |
processSequenceNumberoptional | string | Sequence number of the transaction. |
connectError
NAME | TYPE | DESCRIPTION |
---|---|---|
ConnectErroroptional | string | API connectivity error information, if available. |
CPCSData
NAME | TYPE | DESCRIPTION |
---|---|---|
transactionPostedDateoptional | string | Date the transaction posted. Format: MM-DD-YYYY |
sourceArrangementNumberoptional | string | Account number |
transactionDescriptionPart1optional | string | Description of transaction, part 1 |
transactionDescriptionPart2optional | string | Description of transaction, part 2 |
transactionDescriptionPart3optional | string | Description of transaction, part 3 |
regulationEDescriptionoptional | string | Regulation E description |
transactionDescription2optional | string | Description of transaction |
transactionEffectiveDateoptional | string | Effective date of the transaction. Format: YYYY-MM-DD |
transactionActionCodeoptional | string | Transaction action identifier |
transactionAmountoptional | string | Transaction amount |
cashAmountoptional | string | Cash part of transaction 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 the current business date then this is set to "P". |
creditOrDebitCodeoptional | string | Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit) |
traceIDoptional | string | Source transaction identifier |
CurrentBalances
NAME | TYPE | DESCRIPTION |
---|---|---|
holdsoptional | string | Amount that is on hold |
uncollectedFundsoptional | string | Uncollected funds amount |
currentLedgeroptional | string | Current ledger balance |
currentAvailableoptional | string | Current available balance |
openingAvailableoptional | string | Opening available balance |
ErrorResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
businessFaultoptional | array | BusinessFault |
systemFaultoptional | array | SystemFault |
Exception
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
X-CorrelationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError |
ExceptionCDASummary
NAME | TYPE | DESCRIPTION |
---|---|---|
ExceptionCDASummary | object | GetCDASummaryResponseException |
ExceptionCurrentBalance
NAME | TYPE | DESCRIPTION |
---|---|---|
ExceptionCurrentBalance | object | GetCurrentBalancesResponseException |
ExceptionIntraDayList
NAME | TYPE | DESCRIPTION |
---|---|---|
ExceptionIntraDayList | object | GetIntraDayTransactionsResponseException |
ExceptionIntraDaySummary
NAME | TYPE | DESCRIPTION |
---|---|---|
ExceptionIntraDaySummary | object | GetIntraDaySummaryResponseException |
GetCDASummaryRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters. |
daterequired | string | Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD |
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. Format: YYYY-MM-DD |
retrivedRowsoptional | string | Total number of transactions retrieved. |
totalRowsoptional | string | Total number of transactions matching the requested criteria. |
errorResponseoptional | Object | ErrorResponse |
GetCDASummaryResult
NAME | TYPE | DESCRIPTION |
---|---|---|
summaryoptional | Object | Summary |
CDATransactionDetailsoptional | Object | CDATransactionDetails |
ACHMemoPostoptional | Object | ACHMemoPost |
GetCurrentBalancesRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters. |
daterequired | string | Date for which the current balances are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD |
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. Format: YYYY-MM-DD |
retrivedRowsoptional | string | Total number of transactions retrieved. |
totalRowsoptional | string | Total number of transactions matching the requested criteria. |
errorResponseoptional | Object | ErrorResponse |
GetCurrentBalancesResult
NAME | TYPE | DESCRIPTION |
---|---|---|
currentBalancesoptional | Object | CurrentBalances |
GetIntraDaySummaryRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters. |
daterequired | string | Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD |
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. Format: YYYY-MM-DD |
errorResponseoptional | Object | ErrorResponse |
GetIntraDaySummaryResult
NAME | TYPE | DESCRIPTION |
---|---|---|
earlyACHCreditoptional | string | Total credit amount as of 0600 posting window. |
earlyACHCreditCountoptional | string | Total number of ACH credit transactions as of 0600 posting window. |
lateACHCreditoptional | string | Total credit amount from posting windows other than 0600. |
lateACHCreditCountoptional | string | Total number of ACH credit transactions from posting windows other than 0600. |
lockboxCreditoptional | string | Total credit amount of lockbox transactions. |
lockboxCreditCountoptional | string | Total number of lockbox credit transactions. |
wireTransferCreditoptional | string | Total credit amount of wire transfer transactions. |
wireTransferCreditCountoptional | string | Total number of wire transfer credit transactions. |
depositsCreditoptional | string | Total credit amount through deposits. |
otherMiscCreditoptional | string | Other miscellaneous credit amounts. |
otherMiscCreditCountoptional | string | Total number of miscellaneous credit transactions. |
totalCreditoptional | string | Total credit amount from memo post, lockbox, wires, OLDS, and CPCS transactions. |
totalCreditCountoptional | string | Total number of credits from memo post, lockbox, wires, OLDS, and CPCS transactions. |
earlyACHDebitoptional | string | Total debit amount as of 0600 posting window. |
earlyACHDebitCountoptional | string | Total number of ACH debit transactions as of 0600 posting window. |
lateACHDebitoptional | string | Total debit amount from posting windows other than 0600. |
lateACHDebitCountoptional | string | Total number of ACH debit transactions from posting windows other than 0600. |
wireTransferDebitoptional | string | Total debit amount of wire transfer transactions. |
wireTransferDebitCountoptional | string | Total number of wire transfer debit transactions. |
otherMiscDebitoptional | string | Other miscellaneous debit amounts. |
otherMiscDebitCountoptional | string | Total number of miscellaneous debit transactions. |
totalDebitoptional | string | Total debit amount from memo post, lockbox, wires, OLDS, and CPCS transactions. |
totalDebitCountoptional | string | Total number of debits from memo post, lockbox, wires, OLDS, and CPCS transactions. |
srcBankNumoptional | string | Source bank number |
srcSysCodeoptional | string | Source system code |
currentBalancesoptional | Object | GetCurrentBalancesResult |
getIntraDayTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters. |
daterequired | string | Date for which the list of transactions is to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD |
startRowIndexoptional | string | Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1. |
endRowIndexoptional | string | Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex. |
getIntraDayTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
IntraDayTransactionsoptional | array | IntraDayTransactions |
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. Format: YYYY-MM-DD |
retrivedRowsoptional | string | Total number of transactions retrieved. |
totalRowsoptional | string | Total number of transactions matching the requested criteria. |
errorResponseoptional | Object | ErrorResponse |
healthResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
Statusoptional | string | Status of the health check response. |
Sourceoptional | string | Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved. |
Timestampoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service. |
ClientIpoptional | string | Client IP address the gateway receives from the request. |
X-Forwarded-Foroptional | string | Sequence of IP addresses for systems between the client and the gateway. |
IntraDayTransactions
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberoptional | string | Account number associated with the transaction. |
transactionEffectiveDateoptional | string | Effective date of the transaction. Format: YYYY-MM-DD |
transactionTypeIdoptional | string | Transaction type identifier |
addendaInformationoptional | Object | AddendaInformation |
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 named contact |
customDataField1optional | string | Custom data field |
LockboxTransactionData
NAME | TYPE | DESCRIPTION |
---|---|---|
DDAAccountNumberoptional | string | DDA account number associated with lockbox. |
processDateoptional | string | Date the transaction was processed. Format: YYYY-MM-DD |
lockboxGrpBankNumberoptional | string | Not a 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 |
OLDSData
NAME | TYPE | DESCRIPTION |
---|---|---|
bankNumberoptional | string | Bank number associated with the account number. |
transactionTypeIdoptional | string | Four-digit transaction type identifier. |
srcArrangementNumberoptional | string | Can be any account number, DDA, loan account, credit card, or savings. |
transactionEffDateoptional | string | Effective date of the transaction. Format: YYYY-MM-DD |
transactionAmountoptional | string | Transaction amount |
transactionTypeCodeoptional | string | Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (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 | Brief description of the transaction. |
traceIdoptional | string | Source transaction identifier |
transactionCodeBAI2optional | string | BAI2 transaction code |
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. Format: YYYY-MM-DD |
retrivedRowsoptional | string | Total number of transactions retrieved. |
totalRowsoptional | string | Total number of transactions matching the requested criteria. |
RTPData
NAME | TYPE | DESCRIPTION |
---|---|---|
creditArrangementTypeCodeoptional | string | Credit account type code |
creditArrangementBankNumberoptional | string | Bank number holding the credit account. |
creditArrangementBankBranchoptional | string | Bank branch holding the credit account. |
creditArrangementCurrencyCodeoptional | string | Transaction currency code of the credit account. |
creditInvolvedPartyIdentifieroptional | string | Customer number associated with the credit account. |
creditInvolvedPartyNameoptional | string | Customer name associated with the credit account. |
creditArrangementCountryCodeoptional | string | Country of the credit account. |
creditInvolvedPartyTypeCodeoptional | string | Customer type associated with the credit account. |
debitArrangementTypeCodeoptional | string | Debit account type code |
debitArrangementBankNumberoptional | string | Bank number holding the debit account. |
debitArrangementBankBranchoptional | string | Bank branch holding the debit account. |
debitArrangementCurrencyCodeoptional | string | Transaction currency code of the debit account. |
debitInvolvedPartyIdentifieroptional | string | Customer number associated with the debit account. |
debitInvolvedPartyNameoptional | string | Customer name associated with the debit account. |
transactionBusinessStatusCodeoptional | string | Transaction business status code |
sendingBankReferenceNumberoptional | string | Reference number attached to a wire, issued by the sending bank. |
originatingInvolvedPartyNameoptional | string | Name of the wire transaction originator. |
originatingArrangementNumberoptional | string | Account number of the wire transaction originator. |
originatingInvolvedPartyAddressLine1optional | string | Address line 1 of the wire transaction originator. |
originatingInvolvedPartyAddressLine2optional | string | Address line 2 of the wire transaction originator. |
beneficiaryInvolvedPartyNameoptional | string | Beneficiary of the wire payment. |
beneficiaryArrangementNumberoptional | string | Account number of the beneficiary. |
beneficiaryInvolvedPartyAddressLine1optional | string | Address line 1 of the beneficiary. |
beneficiaryInvolvedPartyAddressLine2optional | string | Address line 2 of the beneficiary. |
intermediaryBankNameoptional | string | Name of the intermediary bank. |
intermediaryBankABANumberoptional | string | ABA number of the intermediary bank. |
intermediaryBICCodeoptional | string | BIC number of the intermediary bank. |
intermediaryBankAddressLine1optional | string | Address line 1 of the intermediary bank. |
intermediaryBankAddressLine2optional | string | Address line 2 of the intermediary bank. |
originatingBankNameoptional | string | Name of the wire originating bank. |
originatingBankABANumberoptional | string | ABA number of the wire originating bank. |
originatingBankBICcodeoptional | string | BIC number of the wire originating bank. |
originatingBankAddressLine1optional | string | Address line 1 of the wire originating bank. |
originatingBankAddressLine2optional | string | Address line 2 of the wire originating bank. |
beneficiaryBankNameoptional | string | Name of the beneficiary bank. |
beneficiaryBankABANumberoptional | string | ABA number of the beneficiary bank. |
beneficiaryBankBICcodeoptional | string | BIC number of the beneficiary bank. |
beneficiaryBankAddressLine1optional | string | Address line 1 of the beneficiary bank. |
beneficiaryBankAddressLine2optional | string | Address line 2 of the beneficiary bank. |
sourceTransactionIdentifieroptional | string | End-to-end ID to uniquely identify a transaction in source systems. |
transactionSettledDateoptional | string | Date the transaction is settled. Format: MM-DD-YYYY |
federalReferenceNumberoptional | string | Federal reference number |
incomingReferenceNumberoptional | string | The incoming reference number, which is provided by the sending bank. |
currencyExchangeRateoptional | string | Exchange rate |
transactionExecutedDateoptional | string | Date the transaction is executed. Format: MM-DD-YYYY |
bankToBankMemooptional | string | Free-form text transmitted between the banks. |
transactionIdentifieroptional | string | Transaction identifier |
transactionAmountoptional | string | The amount of the RTP transaction. |
Summary
NAME | TYPE | DESCRIPTION |
---|---|---|
sourceArrangementNumberoptional | string | Account number |
snapshotDateoptional | string | Date that requested data was loaded. Format: MM-DD-YYYY |
sourceSystemOfRecordCodeoptional | string | This field is for internal purposes only. |
currencyCodeoptional | string | Currency code of the transaction. Default value: USD |
amountoptional | string | Transaction amount |
amountTypeCodeoptional | string | Code associated with the transaction amount. Valid values: 580 (Total Controlled Disbursing Debits), 584 (Total Disbursing Checks Paid Later Amount), 602 (Total Adjustments), 585 (Required Funding Amount) |
FundTypeCodeoptional | string | Code associated with the fund type. |
itemCountoptional | string | Total number of transactions |
processSequenceNumberoptional | string | Sequence number of the transaction. |
earlyACHCreditoptional | string | Total credit amount as of 0600 posting window. |
earlyACHDebitoptional | string | Total debit amount as of 0600 posting window. |
SystemFault
NAME | TYPE | DESCRIPTION |
---|---|---|
errorCodeoptional | string | System error code |
errorDescriptionoptional | string | A human-readable message that describes the type or source of the system error. |
WiresData
NAME | TYPE | DESCRIPTION |
---|---|---|
creditArrangementTypeCodeoptional | string | Credit account type code |
creditArrangementBankNumberoptional | string | Bank number holding the credit account. |
creditArrangementBankBranchoptional | string | Bank branch holding the credit account. |
creditArrangementCurrencyCodeoptional | string | Transaction currency code of the credit account. |
creditInvolvedPartyIdentifieroptional | string | Customer number associated with the credit account. |
creditInvolvedPartyNameoptional | string | Customer name associated with the credit account. |
creditArrangementCountryCodeoptional | string | Country of the credit account. |
creditInvolvedPartyTypeCodeoptional | string | Customer type associated with the credit account. |
debitArrangementTypeCodeoptional | string | Debit account type code |
debitArrangementBankNumberoptional | string | Bank number holding the debit account. |
debitArrangementBankBranchoptional | string | Bank branch holding the debit account. |
debitArrangementCurrencyCodeoptional | string | Transaction currency code of the debit account. |
debitInvolvedPartyIdentifieroptional | string | Customer number associated with the debit account. |
debitInvolvedPartyNameoptional | string | Customer name associated with the debit account. |
transactionBusinessStatusCodeoptional | string | Transaction business status code |
sendingBankReferenceNumberoptional | string | Reference number attached to a wire, issued by the sending bank. |
originatingInvolvedPartyNameoptional | string | Name of the wire transaction originator. |
originatingArrangementNumberoptional | string | Account number of the wire transaction originator. |
originatingInvolvedPartyAddressLine1optional | string | Address line 1 of the wire transaction originator. |
originatingInvolvedPartyAddressLine2optional | string | Address line 2 of the wire transaction originator. |
beneficiaryInvolvedPartyNameoptional | string | Beneficiary of the wire payment. |
beneficiaryArrangementNumberoptional | string | Account number of the beneficiary. |
beneficiaryInvolvedPartyAddressLine1optional | string | Address line 1 of the beneficiary. |
beneficiaryInvolvedPartyAddressLine2optional | string | Address line 2 of the beneficiary. |
intermediaryBankNameoptional | string | Name of the intermediary bank. |
intermediaryBankABANumberoptional | string | ABA number of the intermediary bank. |
intermediaryBICCodeoptional | string | BIC number of the intermediary bank. |
intermediaryBankAddressLine1optional | string | Address line 1 of the intermediary bank. |
intermediaryBankAddressLine2optional | string | Address line 2 of the intermediary bank. |
originatingBankNameoptional | string | Name of the wire originating bank. |
originatingBankABANumberoptional | string | ABA number of the wire originating bank. |
originatingBankBICcodeoptional | string | BIC number of the wire originating bank. |
originatingBankAddressLine1optional | string | Address line 1 of the wire originating bank. |
originatingBankAddressLine2optional | string | Address line 2 of the wire originating bank. |
beneficiaryBankNameoptional | string | Name of the beneficiary bank. |
beneficiaryBankABANumberoptional | string | ABA number of the beneficiary bank. |
beneficiaryBankBICcodeoptional | string | BIC number of the beneficiary bank. |
beneficiaryBankAddressLine1optional | string | Address line 1 of the beneficiary bank. |
beneficiaryBankAddressLine2optional | string | Address line 2 of the beneficiary bank. |
sourceTransactionIdentifieroptional | string | End-to-end ID to uniquely identify a transaction in source systems. |
transactionSettledDateoptional | string | Date the transaction is settled. Format: MM-DD-YYYY |
federalReferenceNumberoptional | string | Federal reference number |
incomingReferenceNumberoptional | string | The incoming reference number, which is provided by the sending bank. |
currencyExchangeRateoptional | string | Exchange rate |
transactionExecutedDateoptional | string | Date the transaction is executed. Format: MM-DD-YYYY |
bankToBankMemooptional | string | Free-form text transmitted between the banks. |
transactionIdentifieroptional | string | Transaction identifier |
transactionAmountoptional | string | The amount of the wire transaction. |
Errors
For more information about general errors, see Error handling.
API-specific KeyBank error codes and details are in the ServiceError
or errorResponse
object with additional information specific to the API. The 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.
API specific KeyBank codes and messages
HTTP STATUS CODE | CUSTOM STATUS CODE | DESCRIPTION |
---|---|---|
200 | S |
The request was received, but there is no result for the requested criteria. |
299 | W |
This message occurs when multiple request parameters are provided, and some of the data are not available as part of response. |
400 | F |
There is missing mandatory information like accountNumber, fromDate, or toDate. Review values for mandatory request fields. |
400 | F |
Response goes beyond 1000 transactions for the requested account. Change the request criteria to help limit returned transactions to the allowed amount. |
YAML file
![download](/themes/custom/keybank_dev_portal/images/download-icon.png)