Previous Day is an information reporting API that returns posted transactions like deposit activity, paid checks, ACH debits and credits, wires, and ACH and wire transactions together in one report.
Before you begin
All KeyBank APIs require certificates, user credentials, and certain permissions. Before you begin, see Key concepts to learn more about these fundamental elements as well as other recommended best practices.
Previous Day Reporting Endpoints
Summary | Endpoint |
---|---|
Get a list of transactions for a historical date range | post /ddaReports/accounts/v1/transactions/list |
Get a detailed transaction report | post /ddaReports/accounts/v1/transactions/details |
Get an account summary report for a single historical date | post /ddaReports/accounts/v1/transactions/prevDay/summary |
Get a list of transactions for a historical date range
post /ddaReports/accounts/v1/transactions/list
Retrieve historical transaction activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months. When setting the date range (fromDate and toDate), the date range specified cannot exceed more than one year.
Request
header FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | A universal ID to trace the transaction across all the systems involved, useful for system logging and identification. |
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. |
fromDaterequired | string | Start date for the date range. The date must be prior to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD |
toDaterequired | string | The end date of a date range for the submitted transactions. Transaction data can be recalled from the previous 24 months. The date must be later than the start date (fromDate). Date range cannot exceed more than one year. Format: YYYY-MM-DD |
creditOrDebitCodeoptional | string | Code that indicates if the transaction is a credit or a debit. To retrieve both credit and debit transactions, leave this field blank. Valid values: C (credit), D (debit) |
transactionTypeCodeoptional | string | The banking processor code for a particular transaction type. If the type is not specified in the request, all transaction types associated with the account activity are returned. |
fromAmountoptional | string | The minimum amount of a transaction. If no amount is specified, all amounts greater than $0.00 are returned. |
toAmountoptional | string | The maximum amount of a transaction. If no amount is specified, all transactions are returned. |
mdmIdoptional | string | The MDM ID supports associating an ID with a single account or many accounts for verification and data retrieval. |
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 cannot exceed more than 1000 records from the startRowIndex. |
Request example

{ "getDDATransactionsRequest": { "accountNumber": [ "123456789" ], "fromDate": "2021-06-12", "toDate": "2021-07-12", "creditOrDebitCode": "C", "transactionTypeCode": "1003", "fromAmount": "1.00", "toAmount": "1000.00", "mdmId": "ABCD12FG34", "startRowIndex": "1", "endRowIndex": "1" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
DDATransactionsoptional | array | ddaTransactions |
Response example (200)

{ "getDDATransactionsResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully returned results for the requested range 1 to 1", "retrivedRows": "1", "totalRows": "66", "dataLoadDate": "2022-07-05" }, "DDATransactions": [ { "accountNumber": "123456789", "transactionEffectiveDate": "06\/16\/2021", "creditOrDebitCode": "C", "transactionTypeCode": "1003", "transactionAmount": "524.78", "transactionKey": "C 000000000000000001", "transactionDescription": "DEPOSIT BRANCH 0505 PENNSYLVANIA", "transactionSequenceNumber": "140", "currentLedgerBalancePostTransaction": "300596.77", "currencyCode": "USD", "addendaInformation": { "WiresData": { "creditArrangementTypeCode": "", "creditArrangementBankNumber": "", "creditArrangementBankBranch": "", "creditArrangementCurrencyCode": "", "creditInvolvedPartyIdentifier": "", "creditInvolvedPartyName": "", "creditArrangementCountryCode": "", "creditInvolvedPartyTypeCode": "", "debitArrangementTypeCode": "", "debitArrangementBankNumber": "", "debitArrangementBankBranch": "", "debitArrangementCurrencyCode": "", "debitInvolvedPartyIdentifier": "", "debitInvolvedPartyName": "", "transactionBusinessStatusCode": "", "sendingBankReferenceNumber": "", "originatingInvolvedPartyName": "TEST COMPANY 1, LLC", "originatingArrangementNumber": "12345123", "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland", "originatingInvolvedPartyAddressLine2": "OH 44114", "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC", "beneficiaryArrangementNumber": "3435656765", "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": "KeyBank National Association", "originatingBankABANumber": "", "originatingBankBICcode": "", "originatingBankAddressLine1": "", "originatingBankAddressLine2": "", "beneficiaryBankName": "KeyBank National Association", "beneficiaryBankABANumber": "21300077", "beneficiaryBankBICcode": "KEYBUS33 XXX", "beneficiaryBankAddressLine1": "250 Delaware Ave Ste", "beneficiaryBankAddressLine2": "Buffalo,NY 14202", "sourceTransactionIdentifier": "", "transactionSettledDate": "", "federalReferenceNumber": "", "incomingReferenceNumber": "", "currencyExchangeRate": "", "transactionExecutedDate": "", "bankToBankMemo": "", "transactionIdentifier": "", "originatingABA": "", "originating2ABA": "", "originating3ABA": "", "beneficiaryBankArangeNum": "", "beneficiaryABA": "", "originatingBankDebitBIC": "", "originatingBankCreditBIC": "" } } } ] } }
Missing data
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (400)

{ "ErrorMessage": "Please make sure your request is correct and try again.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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. |
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 | ServiceErrorData connectError |
Response example (401)

{ "ErrorMessage": "Please make sure you're using the correct credentials. Then log in again.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access denied
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (403)

{ "ErrorMessage": "You don't have access to this resource. Contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (404)

{ "ErrorMessage": "We can't seem to find what you're looking for. Please verify the resource and try again.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request method denied
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (405)

{ "ErrorMessage": "Looks like something went wrong. Please check your request method and try again.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Media type not supported
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (415)

{ "ErrorMessage": "We currently don't support that format. Please check the format type defined in your request and try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (429)

{ "ErrorMessage": "Looks like you've sent too many requests. Please wait a moment and try again later.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (500)

{ "ErrorMessage": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (502)

{ "ErrorMessage": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "A connectivity error occurred with the downstream service(unexpected end of file at the target). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Service unavailable
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (503)

{ "ErrorMessage": "Looks like something went wrong. Please try again later. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "This service is currently unavailable (there are no active targets). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Gateway timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (504)

{ "ErrorMessage": "Your request took too long to process. Please try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "The request could not be processed on time (gateway timeout). Please wait a moment and try again later." } }
Get a detailed transaction report
post /ddaReports/accounts/v1/transactions/details
Retrieve the transaction details associated with a specific transaction key and account number combination.
Request
header FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | A universal ID to trace the transaction across all the systems involved, useful for system logging and identification. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
transactionKeyrequired | array | The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated. |
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. |
mdmIdoptional | string | The MDM ID supports associating an ID with a single account or many accounts for verification and data retrieval. |
Request example

{ "getDDATransactionsDetailsRequest": { "transactionKey": [ "C 000000000000000001" ], "accountNumber": [ "123456789" ], "mdmId": "ABCD12FG34" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
DDATransactionsDetailsoptional | array | ddaTransactionsDetails |
Response example (200)

{ "getDDATransactionsDetailsResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully returned 1 results from sourcing layer.", "dataLoadDate": "2022-07-05" }, "DDATransactionsDetails": [ { "accountNumber": "123456789", "transactionEffectiveDate": "07\/09\/2021", "creditOrDebitCode": "C", "transactionType": "1003", "transactionAmount": "90.82", "transactionKey": "C 000000000000000001", "transactionDescription": "DEPOSIT BRANCH 0505 PENNSYLVANIA", "transactionSequenceNumber": "140", "currentLedgerBalancePostTransaction": "376145.36", "snapshotDate": "07\/09\/2021", "collectedCashAmount": "90.82", "shortFloatAmountDay1": "0", "checkSerialNumber": "100014399", "traceID": "C 000000000000000001", "glSourceCode": "5", "operatorID": null, "BAICode": "301", "BAICodeDesc": "COMMERCIAL DEPOSIT", "addendaInformation": { "WiresData": { "creditArrangementTypeCode": "", "creditArrangementBankNumber": "", "creditArrangementBankBranch": "", "creditArrangementCurrencyCode": "", "creditInvolvedPartyIdentifier": "", "creditInvolvedPartyName": "", "creditArrangementCountryCode": "", "creditInvolvedPartyTypeCode": "", "debitArrangementTypeCode": "", "debitArrangementBankNumber": "", "debitArrangementBankBranch": "", "debitArrangementCurrencyCode": "", "debitInvolvedPartyIdentifier": "", "debitInvolvedPartyName": "", "transactionBusinessStatusCode": "", "sendingBankReferenceNumber": "", "originatingInvolvedPartyName": "TEST COMPANY 1, LLC", "originatingArrangementNumber": "12345123", "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland", "originatingInvolvedPartyAddressLine2": "OH 44114", "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC", "beneficiaryArrangementNumber": "3435656765", "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": "KeyBank National Association", "originatingBankABANumber": "", "originatingBankBICcode": "", "originatingBankAddressLine1": "", "originatingBankAddressLine2": "", "beneficiaryBankName": "KeyBank National Association", "beneficiaryBankABANumber": "21300077", "beneficiaryBankBICcode": "KEYBUS33 XXX", "beneficiaryBankAddressLine1": "250 Delaware Ave Ste", "beneficiaryBankAddressLine2": "Buffalo,NY 14202", "sourceTransactionIdentifier": "", "transactionSettledDate": "", "federalReferenceNumber": "", "incomingReferenceNumber": "", "currencyExchangeRate": "", "transactionExecutedDate": "", "bankToBankMemo": "", "transactionIdentifier": "", "originatingABA": "", "originating2ABA": "", "originating3ABA": "", "beneficiaryBankArangeNum": "", "beneficiaryABA": "", "originatingBankDebitBIC": "", "originatingBankCreditBIC": "" } } } ] } }
Missing data
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (400)

{ "ErrorMessage": "Please make sure your request is correct and try again.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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. |
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 | ServiceErrorData connectError |
Response example (401)

{ "ErrorMessage": "Please make sure you're using the correct credentials. Then log in again.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access denied
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (403)

{ "ErrorMessage": "You don't have access to this resource. Contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (404)

{ "ErrorMessage": "We can't seem to find what you're looking for. Please verify the resource and try again.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request method denied
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (405)

{ "ErrorMessage": "Looks like something went wrong. Please check your request method and try again.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Media type not supported
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (415)

{ "ErrorMessage": "We currently don't support that format. Please check the format type defined in your request and try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (429)

{ "ErrorMessage": "Looks like you've sent too many requests. Please wait a moment and try again later.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (500)

{ "ErrorMessage": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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. |
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 | ServiceErrorData connectError |
Response example (502)

{ "ErrorMessage": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "A connectivity error occurred with the downstream service (unexpected end of file at the target). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Service unavailable
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (503)

{ "ErrorMessage": "Looks like something went wrong. Please try again later. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "This service is currently unavailable(there are no active targets). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Gateway timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (504)

{ "ErrorMessage": "Your request took too long to process. Please try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "The request could not be processed on time (gateway timeout). Please wait a moment and try again later." } }
Get an account summary report for a single historical date
post /ddaReports/accounts/v1/transactions/prevDay/summary
Retrieve a summary of historical, single-day account activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months.
Request
header FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | A universal ID to trace the transaction across all the systems involved, useful for system logging and identification. |
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 |
mdmIdoptional | string | The MDM ID supports associating an ID with a single account or many accounts for verification and data retrieval. |
Request example

{ "getDDAPrevDaySummaryRequest": { "accountNumber": [ "123456789" ], "date": "2022-07-18", "mdmId": "ABCD12FG34" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
DDAPrevDaySummaryoptional | array | ddaPrevDaySummary |
Response example (200)

{ "getDDAPrevDaySummaryResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully processed the request.", "dataLoadDate": "2022-05-10", "summaryTotal": { "totalClosingLedger": "42.21", "totalClosingAvailable": "42.21", "totalFloatDay1": "0.0", "totalFloatDay2": "0.0", "sumTotalCredits": "2.22", "sumTotalDebits": "0.02", "totalOpeningAvailable": "42.21" } }, "DDAPrevDaySummary": [ { "accountNumber": "123456789", "closingLedger": "42.21", "closingAvailable": "42.21", "shortFloatAmountDay0": "0", "shortFloatAmountDay1": "0", "shortFloatAmountDay2": "0", "shortFloatAmountDay3": "0", "shortFloatAmountDay4": "0", "shortFloatAmountDay5": "0", "shortFloatAmountDay6": "0", "reportDate": "07\/18\/2022", "totalCredits": "2.22", "totalDebits": "0.02", "openingAvailable": "42.21", "achCredits": "0", "depositsAmount": "0", "wireTransferCredits": "0.21", "zbaCredits": "0", "otherMiscCredits": "2.01", "achDebits": "0", "checksAmount": "0", "returnedItemDebits": "0", "wireTransferDebits": "0.01", "zbaDebits": "0", "otherMiscDebits": "0.01", "totalAccountCredits": "2.22", "totalAccountDebits": "0.02", "achCreditCount": "0", "depositsCount": "0", "wireTransferCreditsCount": "4", "zbaCreditsCount": "0", "otherMiscCreditsCount": "3", "achDebitsCount": "0", "checksCount": "0", "returnedItemDebitsCount": "0", "wireTransferDebitsCount": "1", "zbaDebitsCount": "0", "otherMiscDebitsCount": "1", "totalCreditCount": "7", "totalDebitCount": "2" } ] } }
Missing data
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (400)

{ "ErrorMessage": "Please make sure your request is correct and try again.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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. |
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 | ServiceErrorData connectError |
Response example (401)

{ "ErrorMessage": "Please make sure you're using the correct credentials. Then log in again.", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access denied
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (403)

{ "ErrorMessage": "You don't have access to this resource. Contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (404)

{ "ErrorMessage": "We can't seem to find what you're looking for. Please verify the resource and try again.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request method denied
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (405)

{ "ErrorMessage": "Looks like something went wrong. Please check your request method and try again.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Media type not supported
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (415)

{ "ErrorMessage": "We currently don't support that format. Please check the format type defined in your request and try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (429)

{ "ErrorMessage": "Looks like you've sent too many requests. Please wait a moment and try again later.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (500)

{ "ErrorMessage": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (502)

{ "ErrorMessage": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "A connectivity error occurred with the downstream service(unexpected end of file at the target). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Service unavailable
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (503)

{ "ErrorMessage": "Looks like something went wrong. Please try again later. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "This service is currently unavailable (there are no active targets). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Gateway timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
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 | ServiceErrorData connectError |
Response example (504)

{ "ErrorMessage": "Your request took too long to process. Please try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "X-CorrelationId": "tr2344", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "The request could not be processed on time (gateway timeout). Please wait a moment and try again later." } }
Schemas
addendaInformation
NAME | TYPE | DESCRIPTION |
---|---|---|
WiresDataoptional | object | wiresData |
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. |
connectError
NAME | TYPE | DESCRIPTION |
---|---|---|
ConnectErroroptional | string | API connectivity error information, if available. |
ddaPrevDaySummary
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberoptional | string | Account number associated with the transaction. |
closingLedgeroptional | string | Ledger balance in the account at the time of closure. |
closingAvailableoptional | string | Amount available end of day for transactions. |
shortFloatAmountDay0optional | string | Dollar amount of short float day 0. |
shortFloatAmountDay1optional | string | Dollar amount of short float day 1. |
shortFloatAmountDay2optional | string | Dollar amount of short float day 2. |
shortFloatAmountDay3optional | string | Dollar amount of short float day 3. |
shortFloatAmountDay4optional | string | Dollar amount of short float day 4. |
shortFloatAmountDay5optional | string | Dollar amount of short float day 5. |
shortFloatAmountDay6optional | string | Dollar amount of short float day 6. |
reportDateoptional | string | Date the transaction posted. Format: MM-DD-YYYY |
totalCreditsoptional | string | Total credit transaction amount |
totalDebitsoptional | string | Total debit transaction amount |
openingAvailableoptional | string | Opening available balance |
achCreditsoptional | string | ACH credits amount |
depositsAmountoptional | string | Deposits amount |
wireTransferCreditsoptional | string | Wire transfer credits amount |
zbaCreditsoptional | string | ZBA credits amount |
otherMiscCreditsoptional | string | Other miscellaneous credits amount |
achDebitsoptional | string | ACH debits amount |
checksAmountoptional | string | Checks amount |
returnedItemDebitsoptional | string | Returned item debits amount |
wireTransferDebitsoptional | string | Wire transfer debits amount |
zbaDebitsoptional | string | ZBA debits amount |
otherMiscDebitsoptional | string | Other miscellaneous debits amount |
totalAccountCreditsoptional | string | Total account credits |
totalAccountDebitsoptional | string | Total account debits |
achCreditCountoptional | string | ACH credits count |
depositsCountoptional | string | Deposits count |
wireTransferCreditsCountoptional | string | Wire transfer credits count |
zbaCreditsCountoptional | string | ZBA credits count |
otherMiscCreditsCountoptional | string | Other miscellaneous credits count |
achDebitsCountoptional | string | ACH debits count |
checksCountoptional | string | Checks count |
returnedItemDebitsCountoptional | string | Returned item debits count |
wireTransferDebitsCountoptional | string | Wire transfer debits count |
zbaDebitsCountoptional | string | ZBA debits count |
otherMiscDebitsCountoptional | string | Other miscellaneous debits count |
totalCreditCountoptional | string | Total credits count |
totalDebitCountoptional | string | Total debits count |
DDAPrevDaySummaryRequest
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 |
mdmIdoptional | string | The MDM ID will soon deprecate. This is an ID number that can associate with a single account or many accounts for verification and data retrieval. |
DDAPrevDaySummaryResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
DDAPrevDaySummaryoptional | array | ddaPrevDaySummary |
DDAPrevDaySummaryResponseError
NAME | TYPE | DESCRIPTION |
---|---|---|
statusrequired | string | Indicates whether the result was successfully retrieved. |
statusDescriptionrequired | string | Description of the status. |
errorResponseoptional | Object | errorResponse |
ddaTransactions
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberoptional | string | Account number associated with the transaction. |
transactionEffectiveDateoptional | string | Effective date of the transaction. Format: MM-DD-YYYY |
creditOrDebitCodeoptional | string | Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit) |
transactionTypeCodeoptional | string | The banking processor code for a particular transaction type. |
transactionAmountoptional | string | Transaction amount |
transactionKeyoptional | string | An alphanumeric code used to keep the transaction activity secure. |
transactionDescriptionoptional | string | Brief description of the transaction. |
transactionSequenceNumberoptional | string | Batch sequence number of the transaction. |
currentLedgerBalancePostTransactionoptional | string | Current ledger balance following the posting of this transaction. |
currencyCodeoptional | string | Currency code of the transaction. Default value: USD |
addendaInformationoptional | object | addendaInformation |
ddaTransactionsDetails
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberoptional | string | Account number associated with the transaction. |
transactionEffectiveDateoptional | string | Effective date of the transaction. Format: MM-DD-YYYY |
dataLoadDateoptional | string | Indicates the date that the requested data was loaded. Format: YYYY-MM-DD |
creditOrDebitCodeoptional | string | Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit) |
transactionTypeoptional | string | The banking processor code for a particular transaction type. |
transactionAmountoptional | string | Transaction amount |
transactionKeyoptional | string | An alphanumeric code used to keep the transaction activity secure. |
transactionDescriptionoptional | string | Brief description of the transaction. |
transactionSequenceNumberoptional | string | Batch sequence number of the transaction. |
currentLedgerBalancePostTransactionoptional | string | Current ledger balance following the posting of this transaction. |
snapshotDateoptional | string | Snapshot date. Format: MM-DD-YYYY |
collectedCashAmountoptional | string | Collected cash amount |
shortFloatAmountDay1optional | string | Dollar amount of short float for the current business day. |
checkSerialNumberoptional | string | Serial number of the check. |
traceIDoptional | string | Source transaction identifier |
glSourceCodeoptional | string | KeyBank-assigned GL source code |
operatorIDoptional | string | Operator ID - free-form text field for use by sending application. |
BAICodeoptional | string | The three-digit BAI (Bank Administration Institute) code for the transaction. |
BAICodeDescoptional | string | Provides the description corresponding to a BAI code. |
addendaInformationoptional | object | ddaTransactionsDetailsAddendaInformation |
ddaTransactionsDetailsAddendaInformation
NAME | TYPE | DESCRIPTION |
---|---|---|
WiresDataoptional | object | wiresData |
DDATransactionsDetailsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
transactionKeyrequired | array | The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated. |
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. |
mdmIdoptional | string | The MDM ID will soon deprecate. This is an ID number that can associate with a single account or many accounts for verification and data retrieval. |
DDATransactionsDetailsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
DDATransactionsDetailsoptional | array | ddaTransactionsDetails |
DDATransactionsDetailsResponseError
NAME | TYPE | DESCRIPTION |
---|---|---|
statusrequired | string | Indicates whether the result was successfully retrieved. |
statusDescriptionrequired | string | Description of the status. |
errorResponseoptional | Object | errorResponse |
DDATransactionsRequest
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. |
fromDaterequired | string | Start date for the date range. The date must be prior to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD |
toDaterequired | string | The end date of a date range for the submitted transactions. Transaction data can be recalled from the previous 24 months. The date must be later than the start date (fromDate). Date range cannot exceed more than one year. Format: YYYY-MM-DD |
creditOrDebitCodeoptional | string | Code that indicates if the transaction is a credit or a debit. To retrieve both credit and debit transactions, leave this field blank. Valid values: C (credit), D (debit) |
transactionTypeCodeoptional | string | The banking processor code for a particular transaction type. If the type is not specified in the request, all transaction types associated with the account activity are returned. |
fromAmountoptional | string | The minimum amount of a transaction. If no amount is specified, all amounts greater than $0.00 are returned. |
toAmountoptional | string | The maximum amount of a transaction. If no amount is specified, all transactions are returned. |
mdmIdoptional | string | The MDM ID will soon deprecate. This is an ID number that can associate with a single account or many accounts for verification and data retrieval. |
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 cannot exceed more than 1000 records from the startRowIndex. |
DDATransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeaders |
DDATransactionsoptional | array | ddaTransactions |
DDATransactionsResponseError
NAME | TYPE | DESCRIPTION |
---|---|---|
statusrequired | string | Indicates whether the result was successfully retrieved. |
statusDescriptionrequired | string | Description of the status. |
errorResponseoptional | Object | errorResponse |
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. |
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 | ServiceErrorData connectError |
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. |
summaryTotaloptional | Object | SummaryTotal |
ServiceErrorData
NAME | TYPE | DESCRIPTION |
---|---|---|
ServiceErrorDataoptional | oneOf | DDATransactionsResponseError DDATransactionsDetailsResponseError DDAPrevDaySummaryResponseError |
SummaryTotal
NAME | TYPE | DESCRIPTION |
---|---|---|
totalClosingLedgeroptional | string | Sum of all account-level closing ledger balances. |
totalClosingAvailableoptional | string | Sum of all account-level closing available balances. |
totalFloatDay1optional | string | Sum of all account-level 1 day float. |
totalFloatDay2optional | string | Sum of all account-level 2 day float. |
sumTotalCreditsoptional | string | Sum of all account-level total credits. |
sumTotalDebitsoptional | string | Sum of all account-level total debits. |
totalOpeningAvailableoptional | string | Sum of all account-level opening available balances. |
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 |
originatingABAoptional | string | Originating ABA |
originating2ABAoptional | string | Originating 2 ABA |
originating3ABAoptional | string | Originating 3 ABA |
beneficiaryBankArangeNumoptional | string | Beneficiary bank account number |
beneficiaryABAoptional | string | Beneficiary ABA |
originatingBankDebitBICoptional | string | Originating bank debit BIC |
originatingBankCreditBICoptional | string | Originating bank credit BIC |
Errors
For more information about errors, see Error handling.
Error codes and messages
Standard errors use the typical HTTP status codes. Messages specific to KeyBank have an asterisk (*) after the message code number. The ServiceErrorDate > errorResponse
has additional information specific to the API.
KeyBank error codes start with ECA-W with a three-digit number that follows. The number increases by one digit for each error message. For example, if you have an issue with your request that generates two error messages specific to the API, the codes will be ECA-W-001 and ECA-W-002.
HTTP STATUS CODE | CUSTOM STATUS CODE | DESCRIPTION |
---|---|---|
200* | Transaction not found.
Status is S for Success. The request was received, but there is no result for the requested criteria. |
|
299* | Request processing completed with warnings.
Status is W for Warning. This message occurs when multiple request parameters are provided, and some of the data are not available as part of response. |
|
400* | ECA-W-001 | Request Validation failed.
Status is F for Failure. There is missing mandatory information like accountNumber, fromDate, or toDate. Review values for mandatory request fields. |
400* | ECA-W-001 | Requested records range is greater than the allowed limit - 1000
Status is F for Failure. Response goes beyond 1000 transactions for the requested account. Change the request criteria to help limit returned transactions to the allowed amount. |
YAML file
