Previous Day Reporting

29 minute read 1.2.0 | updated Feb. 13, 2023

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.

KeyBank has some common prerequisites and best practices. All KeyBank APIs require certifications, user credentials, and certain permissions. Make sure to satisfy all prerequisites before building your API.

Follow these steps to prepare for operations:

  1. Have valid certificates for a secure connection.

  2. Make sure you have the API keys needed for basic authentication and API access.

  3. Request a bearer token before you start.

  4. Check the health of the API.

  5. Know your MDM ID.

Certificates are a digital authentication method we use to encrypt the information exchanged between KeyBank and your app or service. To access KeyBank environments, you must exchange valid certificates with KeyBank. These certificates must be properly installed on your system before you start to send API calls.

You need API keys to get a bearer token and to grant access to the APIs and the Pre-Production or Production environments. These API keys are created only for authenticated users that have partnered with KeyBank. For more information, see API security or sign up to become a KeyBank API consumer.

Get a bearer token before you start. Only authenticated users with client credentials can request a bearer token. For more information, see API security or sign up to become a KeyBank API consumer.

Before you start building your API, perform a quick health check. A health check verifies that the API is operational and responding correctly with your system. A bearer token is required to perform a health check. For more information, see Health check.

KeyBank assigns a Master Data Management (MDM) ID to each client. The MDM ID is used for account entitlement. This ID needs to be part of the API request to authorize the account’s data retrieval.  The MDM ID can associate an ID with a single account or many accounts for verification and data retrieval. The MDM ID is shared via secure email.

Endpoint Result Description
post /ddaReports/accounts/v1/transactions/list Get a list of transactions Retrieve transaction information for queried accounts.
post /ddaReports/accounts/v1/transactions/details Get a detailed transaction report Get the transaction details associated with a specific transaction key.
post /ddaReports/accounts/v1/transactions/prevDay/summary Get an account summary Provides account level summary for the requested account transactions.

post /ddaReports/accounts/v1/transactions/list

Retrieve transaction information for queried accounts.

HEADER FIELD TYPE DESCRIPTION
X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
BODY FIELD TYPE DESCRIPTION
accountNumberrequired array The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits.
fromDaterequired string Enter the start date for the date range . The date must be prior to the current date. The date format is YYYY-MM-DD.
toDaterequired string Enter the end date for the date range. The date must be later than the start date (fromDate).The date format is YYYY-MM-DD.
creditOrDebitCodeoptional string Use C for credit or D for debit to specify the type of transactions to return. To get both credit and debit transactions, leave this parameter blank.
transactionTypeCodeoptional string The KeyBank Banking Product Processor Code for a particular set of transaction results. If this parameter is blank in the request, all transaction type codes associated with the account's transaction activity are returned.
fromAmountoptional string Transaction amount lower limit value to be searched.
toAmountoptional string Transaction amount upper limit value to be searched.
mdmIdrequired string Enter your KeyBank MDM ID. The MDM ID is used for security purposes.
startRowIndexoptional string This is a pagination field. It indicates the starting count available for the records. If the field is not provided, value will default to 1.
endRowIndexoptional string This is a pagination field. It indicates the last count available for the records. If the field is not provided, value will default to 1000. The request can't 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"
    }
}
NAME TYPE DESCRIPTION
responseHeaderrequired Object responseHeaders
DDATransactionsoptional array ddaTransactions

Response example (200)

{
    "getDDATransactionsResponse": null,
    "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",
            "glSourceCode": "5",
            "operatorID": null,
            "BAICode": "301",
            "BAICodeDesc": "COMMERCIAL DEPOSIT",
            "addendaInformation": {
                "WiresData": {
                    "creditArrangementTypeCode": null,
                    "creditArrangementBankNumber": null,
                    "creditArrangementBankBranch": null,
                    "creditArrangementCurrencyCode": null,
                    "creditInvolvedPartyIdentifier": null,
                    "creditInvolvedPartyName": null,
                    "creditArrangementCountryCode": null,
                    "creditInvolvedPartyTypeCode": null,
                    "debitArrangementTypeCode": null,
                    "debitArrangementBankNumber": null,
                    "debitArrangementBankBranch": null,
                    "debitArrangementCurrencyCode": null,
                    "debitInvolvedPartyIdentifier": null,
                    "debitInvolvedPartyName": null,
                    "transactionBusinessStatusCode": null,
                    "sendingBankReferenceNumber": null,
                    "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": null,
                    "originatingBankBICcode": null,
                    "originatingBankAddressLine1": null,
                    "originatingBankAddressLine2": null,
                    "beneficiaryBankName": "KeyBank National Association",
                    "beneficiaryBankABANumber": "21300077",
                    "beneficiaryBankBICcode": "KEYBUS33 XXX",
                    "beneficiaryBankAddressLine1": "250 Delaware Ave Ste",
                    "beneficiaryBankAddressLine2": "Buffalo,NY 14202",
                    "sourceTransactionIdentifier": null,
                    "transactionSettledDate": null,
                    "federalReferenceNumber": null,
                    "incomingReferenceNumber": null,
                    "currencyExchangeRate": null,
                    "transactionExecutedDate": null,
                    "bankToBankMemo": null,
                    "transactionIdentifier": null,
                    "originatingABA": null,
                    "originating2ABA": null,
                    "originating3ABA": null,
                    "beneficiaryBankArangeNum": null,
                    "beneficiaryABA": null,
                    "originatingBankDebitBIC": null,
                    "originatingBankCreditBIC": null
                }
            }
        }
    ]
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": "Error Message from Backend Servers"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": "Error Message from Backend Servers for unauthorized access"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occured in the service, please check with application support team before resubmitting the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Bad Gateway, please resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request"
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (503)

{
    "ErrorMessage": "Service is currently unavailable, please resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (504)

{
    "ErrorMessage": "Request could not be processed on time, please resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request."
    }
}

post /ddaReports/accounts/v1/transactions/details

Get the transaction details associated with a specific transaction key.

HEADER FIELD TYPE DESCRIPTION
X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
BODY FIELD TYPE DESCRIPTION
transactionKeyrequired array The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated.
accountNumberrequired array The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits.
mdmIdrequired string Enter your KeyBank MDM ID. The MDM ID is used for security purposes.

Request example

{
    "getDDATransactionsDetailsRequest": {
        "transactionKey": [
            "C 000000000000000001"
        ],
        "accountNumber": [
            "123456789"
        ],
        "mdmId": "ABCD12FG34"
    }
}
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": null,
                        "creditArrangementBankNumber": null,
                        "creditArrangementBankBranch": null,
                        "creditArrangementCurrencyCode": null,
                        "creditInvolvedPartyIdentifier": null,
                        "creditInvolvedPartyName": null,
                        "creditArrangementCountryCode": null,
                        "creditInvolvedPartyTypeCode": null,
                        "debitArrangementTypeCode": null,
                        "debitArrangementBankNumber": null,
                        "debitArrangementBankBranch": null,
                        "debitArrangementCurrencyCode": null,
                        "debitInvolvedPartyIdentifier": null,
                        "debitInvolvedPartyName": null,
                        "transactionBusinessStatusCode": null,
                        "sendingBankReferenceNumber": null,
                        "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": null,
                        "originatingBankBICcode": null,
                        "originatingBankAddressLine1": null,
                        "originatingBankAddressLine2": null,
                        "beneficiaryBankName": "KeyBank National Association",
                        "beneficiaryBankABANumber": "21300077",
                        "beneficiaryBankBICcode": "KEYBUS33 XXX",
                        "beneficiaryBankAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryBankAddressLine2": "Buffalo,NY 14202",
                        "sourceTransactionIdentifier": null,
                        "transactionSettledDate": null,
                        "federalReferenceNumber": null,
                        "incomingReferenceNumber": null,
                        "currencyExchangeRate": null,
                        "transactionExecutedDate": null,
                        "bankToBankMemo": null,
                        "transactionIdentifier": null,
                        "originatingABA": null,
                        "originating2ABA": null,
                        "originating3ABA": null,
                        "beneficiaryBankArangeNum": null,
                        "beneficiaryABA": null,
                        "originatingBankDebitBIC": null,
                        "originatingBankCreditBIC": null
                    }
                }
            }
        ]
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": "Error Message from Backend Servers"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": "Error Message from Backend Servers for unauthorized access"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occured in the service, please check with application support team before resubmitting the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Bad Gateway, please resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request"
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (503)

{
    "ErrorMessage": "Service is currently unavailable, please resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (504)

{
    "ErrorMessage": "Request could not be processed on time, please resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request."
    }
}

post /ddaReports/accounts/v1/transactions/prevDay/summary

Provides account level summary for the requested account transactions.

HEADER FIELD TYPE DESCRIPTION
X-CorrelationIdoptional string Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
BODY FIELD TYPE DESCRIPTION
accountNumberrequired array The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits.
daterequired string The Date of the Transaction
mdmIdrequired string Enter your KeyBank MDM ID. The MDM ID is used for security purposes.

Request example

{
    "getDDAPrevDaySummaryRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2022-07-18",
        "mdmId": "ABCD12FG34"
    }
}
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",
                "arrangementName": "TEST COMPANY 1, LLC",
                "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"
            }
        ]
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": "Error Message from Backend Servers"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": "Error Message from Backend Servers for unauthorized access"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occured in the service, please check with application support team before resubmitting the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Bad Gateway, please resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request"
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (503)

{
    "ErrorMessage": "Service is currently unavailable, please resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError

Response example (504)

{
    "ErrorMessage": "Request could not be processed on time, please resubmit the request",
    "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request."
    }
}
NAME TYPE DESCRIPTION
accountNumberrequired array The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits.
fromDaterequired string Enter the start date for the date range . The date must be prior to the current date. The date format is YYYY-MM-DD.
toDaterequired string Enter the end date for the date range. The date must be later than the start date (fromDate).The date format is YYYY-MM-DD.
creditOrDebitCodeoptional string Use C for credit or D for debit to specify the type of transactions to return. To get both credit and debit transactions, leave this parameter blank.
transactionTypeCodeoptional string The KeyBank Banking Product Processor Code for a particular set of transaction results. If this parameter is blank in the request, all transaction type codes associated with the account's transaction activity are returned.
fromAmountoptional string Transaction amount lower limit value to be searched.
toAmountoptional string Transaction amount upper limit value to be searched.
mdmIdrequired string Enter your KeyBank MDM ID. The MDM ID is used for security purposes.
startRowIndexoptional string This is a pagination field. It indicates the starting count available for the records. If the field is not provided, value will default to 1.
endRowIndexoptional string This is a pagination field. It indicates the last count available for the records. If the field is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.
NAME TYPE DESCRIPTION
statusrequired string Indicates whether the result was successfully retrieved
statusDescriptionrequired string Description of the status
dataLoadDateoptional string Indicates the date that the requested data was loaded. The date format is YYYY-MM-DD. For example, 2022-04-01.
retrivedRowsoptional string Total number of transactions retrieved.
totalRowsoptional string Total number of transactions matching the requested criteria.
summaryTotaloptional Object SummaryTotal
NAME TYPE DESCRIPTION
totalClosingLedgeroptional string Sum of All Account Level Closing Ledger
totalClosingAvailableoptional string Sum of All Account Level Closing Available
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
NAME TYPE DESCRIPTION
WiresDataoptional object wiresData
NAME TYPE DESCRIPTION
creditArrangementTypeCodeoptional string Type of the Credit Account
creditArrangementBankNumberoptional string Bank Number holding the credit account
creditArrangementBankBranchoptional string Bank Branch holding the credit account
creditArrangementCurrencyCodeoptional string Transaction currency of Credit account
creditInvolvedPartyIdentifieroptional string Customer Number associated to the Credit account
creditInvolvedPartyNameoptional string Customer Name associated to the credit account
creditArrangementCountryCodeoptional string Country code of the credit account
creditInvolvedPartyTypeCodeoptional string Customer Type associated to the credit accout
debitArrangementTypeCodeoptional string Type of the Debit Account
debitArrangementBankNumberoptional string Bank Number holding the debit account
debitArrangementBankBranchoptional string Bank Branch holding the debit account
debitArrangementCurrencyCodeoptional string Transaction currency of debit account
debitInvolvedPartyIdentifieroptional string Customer Number associated to the debit account
debitInvolvedPartyNameoptional string Customer Name associated to the debit account
transactionBusinessStatusCodeoptional string Status of the transaction in a business process
sendingBankReferenceNumberoptional string This is the reference number attached to the wire from the sending bank
originatingInvolvedPartyNameoptional string The name of the wire transaction originator
originatingArrangementNumberoptional string Account Number of the Originator
originatingInvolvedPartyAddressLine1optional string Originator Address Line1
originatingInvolvedPartyAddressLine2optional string Originator Address Line2
beneficiaryInvolvedPartyNameoptional string Beneficiary of the Wire payment
beneficiaryArrangementNumberoptional string Account Number of the Beneficiary
beneficiaryInvolvedPartyAddressLine1optional string Beneficiary Address Line1
beneficiaryInvolvedPartyAddressLine2optional string Beneficiary Address Line2
intermediaryBankNameoptional string Intermediatory Bank Name
intermediaryBankABANumberoptional string Intermediatory Bank ABA number
intermediaryBICCodeoptional string Intermediatory Bank BIC number
intermediaryBankAddressLine1optional string Intermediatory Bank Address Line1
intermediaryBankAddressLine2optional string Intermediatory Bank Address Line2
originatingBankNameoptional string Originating Bank Name
originatingBankABANumberoptional string Originating Bank ABA number
originatingBankBICcodeoptional string Originating Bank BIC number
originatingBankAddressLine1optional string Originating Bank Address Line1
originatingBankAddressLine2optional string Originating Bank Address Line2
beneficiaryBankNameoptional string Creditor/Beneficiary Bank Name
beneficiaryBankABANumberoptional string Beneficiary Bank ABA number
beneficiaryBankBICcodeoptional string Beneficiary Bank BIC number
beneficiaryBankAddressLine1optional string Beneficiary Bank Address Line 1
beneficiaryBankAddressLine2optional string Beneficiary Bank Address Line 2
sourceTransactionIdentifieroptional string End to End Id to uniquely identify a transaction in source systems
transactionSettledDateoptional string Date when the transaction is settled
federalReferenceNumberoptional string Federal Clearing Reference Number
incomingReferenceNumberoptional string Incoming Reference Number
currencyExchangeRateoptional string Exchange Rate
transactionExecutedDateoptional string Date the transaction is executed
bankToBankMemooptional string Bank To Bank Instruction
transactionIdentifieroptional string Transaction Identifier
NAME TYPE DESCRIPTION
accountNumberoptional string The account number associated with the transaction.
transactionEffectiveDateoptional string The date when the transaction became effective.
creditOrDebitCodeoptional string The field indicates the transaction type is either Credit or Debit.
transactionTypeCodeoptional string The KeyBank Banking Product Processor Code for a particular transaction.
transactionAmountoptional string The amount of a particular transaction.
transactionKeyoptional string An alphanumeric code used to keep the transaction activity secure.
transactionDescriptionoptional string A brief description of the transaction, like the check number.
transactionSequenceNumberoptional string The batch sequence number of the transaction.
currentLedgerBalancePostTransactionoptional string This field denotes the current ledger balance following the posting of this transaction.
currencyCodeoptional string Currency code of the particular transaction. Defaulted to USD.
addendaInformationoptional object addendaInformation
NAME TYPE DESCRIPTION
responseHeaderrequired Object responseHeaders
DDATransactionsoptional array ddaTransactions
NAME TYPE DESCRIPTION
statusrequired string Indicates whether the result was successfully retrieved.
statusDescriptionrequired string Description of the status.
errorResponseoptional Object errorResponse
NAME TYPE DESCRIPTION
transactionKeyrequired array The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated.
accountNumberrequired array The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits.
mdmIdrequired string Enter your KeyBank MDM ID. The MDM ID is used for security purposes.
NAME TYPE DESCRIPTION
statusrequired string Indicates whether the result was successfully.
statusDescriptionrequired string Description of the status.
errorResponseoptional Object errorResponse
NAME TYPE DESCRIPTION
WiresDataoptional object ddaTransactionsDetailsWiresData
NAME TYPE DESCRIPTION
creditArrangementTypeCodeoptional string Type of the Credit Account.
creditArrangementBankNumberoptional string Bank Number holding the credit account.
creditArrangementBankBranchoptional string Bank Branch holding the credit account.
creditArrangementCurrencyCodeoptional string Transaction currency of Credit account.
creditInvolvedPartyIdentifieroptional string Customer Number associated to the Credit account.
creditInvolvedPartyNameoptional string Customer Name associated to the credit account.
creditArrangementCountryCodeoptional string Country of the credit account.
creditInvolvedPartyTypeCodeoptional string Customer Type associated to the credit account.
debitArrangementTypeCodeoptional string Type of the Debit Account.
debitArrangementBankNumberoptional string Bank Number holding the debit account.
debitArrangementBankBranchoptional string Bank Branch holding the debit account.
debitArrangementCurrencyCodeoptional string Transaction currency of debit account.
debitInvolvedPartyIdentifieroptional string Customer Number associated to the debit account.
debitInvolvedPartyNameoptional string Customer Name associated to the credit account.
transactionBusinessStatusCodeoptional string Status of the transaction in a business process.
sendingBankReferenceNumberoptional string This is the reference number attached to the wire from the sending bank. This could be anything the sending bank wants to put in as a REF NUM.
originatingInvolvedPartyNameoptional string The name of the wire transaction originator.
originatingArrangementNumberoptional string Account Number of the Originator.
originatingInvolvedPartyAddressLine1optional string Originator Address Line1.
originatingInvolvedPartyAddressLine2optional string Originator Address Line2.
beneficiaryInvolvedPartyNameoptional string Beneficiary of the Wire payment.
beneficiaryArrangementNumberoptional string Account Number of the Beneficiary.
beneficiaryInvolvedPartyAddressLine1optional string Beneficiary Address Line1.
beneficiaryInvolvedPartyAddressLine2optional string Beneficiary Address Line2.
intermediaryBankNameoptional string Intermediatory Bank Name.
intermediaryBankABANumberoptional string Intermediatory Bank ABA number.
intermediaryBICCodeoptional string Intermediatory Bank BIC number.
intermediaryBankAddressLine1optional string Intermediatory Bank Address Line1.
intermediaryBankAddressLine2optional string Intermediatory Bank Address Line2.
Nameoptional string Originating Bank Name
originatingBankABANumberoptional string Originating Bank ABA number
originatingBankBICcodeoptional string Originating Bank BIC number
originatingBankAddressLine1optional string Originating Bank Address Line1
originatingBankAddressLine2optional string Originating Bank Address Line2
beneficiaryBankNameoptional string Creditor/Beneficiary Bank Name.
beneficiaryBankABANumberoptional string Beneficiary Bank ABA number.
beneficiaryBankBICcodeoptional string Beneficiary Bank BIC.
beneficiaryBankAddressLine1optional string Beneficiary Bank Address Line 1.
beneficiaryBankAddressLine2optional string Beneficiary Bank Address Line 2.
sourceTransactionIdentifieroptional string End to End Id to uniquely identify a transaction in source systems.
transactionSettledDateoptional string Date when the transaction is settled.
federalReferenceNumberoptional string Federal Clearing Reference Number.
incomingReferenceNumberoptional string Incoming Reference Number.
currencyExchangeRateoptional string Exchange Rate.
transactionExecutedDateoptional string Date the transaction is executed.
bankToBankMemooptional string Bank To Bank Instruction.
transactionIdentifieroptional string Transaction Identifier.
NAME TYPE DESCRIPTION
accountNumberoptional string The account number associated with the transaction.
transactionEffectiveDateoptional string Lists the date when the transaction became effective.
dataLoadDateoptional string  
creditOrDebitCodeoptional string The field indicates the transaction type is either Credit or Debit.
transactionTypeoptional string The KeyBank Banking Product Processor Code for a particular transaction.
transactionAmountoptional string The amount of a particular transaction
transactionKeyoptional string An alphanumeric code used to keep the transaction activity secure.
transactionDescriptionoptional string A brief description of the transaction, like the check number.
transactionSequenceNumberoptional string The batch sequnce number of the transaction.
currentLedgerBalancePostTransactionoptional string This field denotes the current ledger balance following the posting of this transaction.
snapshotDateoptional string This field denotes the date that the requested data was loaded.
collectedCashAmountoptional string Collected cash Amount
shortFloatAmountDay1optional string Dollar amount of short float that was in the Amount of Float for the current business day.
checkSerialNumberoptional string Check serial number
traceIDoptional string Unique trace Id used for tracking a particular transaction
glSourceCodeoptional string KeyBank assigned GL source code
operatorIDoptional string Operator ID - free form field for use by sending application.
BAICodeoptional string This determinesthe BAI2 code corresponding to a Banking Product Processor transaction code.
BAICodeDescoptional string This provides the description corresponding to a BAI2 code.
addendaInformationoptional object ddaTransactionsDetailsAddendaInformation
NAME TYPE DESCRIPTION
accountNumberoptional string The account number associated with the transaction.
closingLedgeroptional string This field denotes the ledger balance in the account at the time of closure.
closingAvailableoptional string Amount available end of day for transactions.
shortFloatAmountDay0optional string This field denotes the dollar amount of short float day 0.
shortFloatAmountDay1optional string This field denotes the dollar amount of short float day 1.
shortFloatAmountDay2optional string This field denotes the dollar amount of short float day 2.
shortFloatAmountDay3optional string This field denotes the dollar amount of short float day 3.
shortFloatAmountDay4optional string This field denotes the dollar amount of short float day 4.
shortFloatAmountDay5optional string This field denotes the dollar amount of short float day 5.
shortFloatAmountDay6optional string This field denotes the dollar amount of short float day 6.
reportDateoptional string Date for the Transaction.
totalCreditsoptional string Total Credit transaction Amount.
totalDebitsoptional string Total Debit transaction Amount.
openingAvailableoptional string Amount available next day transactions.
achCreditsoptional string ACH Credit Amount.
depositsAmountoptional string Deposit Amount.
wireTransferCreditsoptional string Wire Transfer Credit Amount.
zbaCreditsoptional string ZBA Credit Amount.
otherMiscCreditsoptional string Other Misc Credit Amount
achDebitsoptional string ACH Debit Amount.
checksAmountoptional string Check Amount.
returnedItemDebitsoptional string Returned Item Debit Amount.
wireTransferDebitsoptional string Wire Transfer Debit Amount.
zbaDebitsoptional string ZBA Debit Amount.
otherMiscDebitsoptional string Other Misc Debit Amount
totalAccountCreditsoptional string Total Account Credits
totalAccountDebitsoptional string Total Account Debits
achCreditCountoptional string ACH Credit Count
depositsCountoptional string Deposit Credit Count
wireTransferCreditsCountoptional string Wire Transfer Credit Count.
zbaCreditsCountoptional string ZBA credit count.
otherMiscCreditsCountoptional string Other Misc Credit Count
achDebitsCountoptional string ACH debits count
checksCountoptional string Check Count
returnedItemDebitsCountoptional string Returned Item Debits Count
wireTransferDebitsCountoptional string Wire Transfer Debits Count
zbaDebitsCountoptional string ZBA debits count.
otherMiscDebitsCountoptional string Other Misc Debits Count
totalCreditCountoptional string Total credit count
totalDebitCountoptional string Total debit count
NAME TYPE DESCRIPTION
responseHeaderrequired Object responseHeaders
DDATransactionsDetailsoptional array ddaTransactionsDetails
NAME TYPE DESCRIPTION
accountNumberrequired array The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits.
daterequired string The Date of the Transaction
mdmIdrequired string Enter your KeyBank MDM ID. The MDM ID is used for security purposes.
NAME TYPE DESCRIPTION
responseHeaderrequired Object responseHeaders
DDAPrevDaySummaryoptional array ddaPrevDaySummary
NAME TYPE DESCRIPTION
statusrequired string Indicates whether the result was successfully retrieved.
statusDescriptionrequired string Description of the status.
errorResponseoptional Object errorResponse
NAME TYPE DESCRIPTION
ErrorMessageoptional string Indicates the status description of the processed request.
TransactionIdoptional string Indicates the unique ID that gets assigned for processed request.
TransactionTimeoptional string Indicates the transaction processed time.
ServiceErroroptional oneOf ServiceErrorData connectError
NAME TYPE DESCRIPTION
ConnectErroroptional string Error information of the connectivity with downstream service.
NAME TYPE DESCRIPTION
businessFaultoptional array businessFault
systemFaultoptional array systemFault
NAME TYPE DESCRIPTION
errorCodeoptional string Business error code.
errorDescriptionoptional string Business error description .
NAME TYPE DESCRIPTION
idoptional string Error reference id
linksoptional Object link
statusoptional string Request status failed
codeoptional string Error code
titleoptional string Error description
detailoptional string Error data, if any
sourceoptional Object source
metaoptional string Error data, if any
NAME TYPE DESCRIPTION
aboutoptional string Error reference link.
NAME TYPE DESCRIPTION
pointeroptional string Reason of failure.
parameteroptional string Paramter that caused the error.
NAME TYPE DESCRIPTION
ServiceErrorDataoptional oneOf DDATransactionsResponseError DDATransactionsDetailsResponseError DDAPrevDaySummaryResponseError
NAME TYPE DESCRIPTION
errorCodeoptional string System error code.
errorDescriptionoptional string System description.
NAME TYPE DESCRIPTION
placeHolderoptional string This is a place holder field.

An error can indicate a problem with the request, the network, or the API itself. Use the error handling information to get a better understanding of what went wrong and possible corrective actions.

Some APIs contain status messages in the responseHeader object of the response payload. The status field returns the status code S, W, or F. Successful responses return the status code S with an HTTP 200 status code. Responses that were not processed as expected or failed to be processed at all return the status code W for warning or F for failure. Warning messages are associated with HTTP 299 status code. A warning message means the request was successfully received, but there was a minor issue that requires your attention. Failure messages are associated with the HTTP 400 or 500 status codes. Additional information is shared in the statusDescription field.

An erroneous response returns the HTTP code number with the content of the exception schema. Additional information in this schema like the transaction ID and transaction time can help you diagnose the issue.

The schema includes the X-CorrelationId field to help with traceability.

Custom messages are used for API-related functional business messages or faults. Each API can contain custom messages specific to KeyBank operations or the API. These messages can be part of the exception schema or a separate object.

For errors specific to the API, we use the ServiceError > errorResponse object in the exception schema and the errors object in the response payload.

Standard errors use the typical HTTP status codes. Messages specific to KeyBank have an asterisk (*) after the message code number. The ServiceErrorDate > errorResponsehas additional information specific to the API.

KeyBank error codes start with ECA-W with a three-digit number that follows. The number increases by one digit for each error message. For example, if you have an issue with your request that generates two error messages specific to the API, the codes will be ECA-W-001 and ECA-W-002.

HTTP STATUS CODE CUSTOM STATUS CODE DESCRIPTION
200*   Transaction not found.

Status is S for Success. The request was received, but there is no result for the requested criteria.
299*   Request processing completed with warnings.

Status is W for Warning. This message occurs when multiple request parameters are provided, and some of the data are not available as part of response.
400* ECA-W-001 Request Validation failed.

Status is F for Failure. There is missing mandatory information like accountNumber, fromDate, toDate, or mdmID. Review values for mandatory request fields.
400* ECA-W-001 Error occurred while validating account association.

Status is F for Failure. The MDM ID provided in the request is invalid or empty.
400* ECA-W-001 Requested records range is greater than the allowed limit - 1000 

Status is F for Failure. Response goes beyond 1000 transactions for the requested account. Change the request criteria to help limit returned transactions to the allowed amount.
400   Missing data in the request.

Mandatory data not provided, please verify the data and resubmit the request.
401   Received request is unauthorized.

Received request is unauthorized, please provide valid credentials.
403   Request is forbidden to access the resource.

Access to requested resource is forbidden.
404   Request resource is not found.

Requested resource is not found, please verify the resource and resubmit the request.
405   Request method is not allowed.

Requested method is not allow, please verify the method and resubmit the request.
415   Requested unsupported media type.

Requested media type is not allowed, please verify the media type and resubmit the request.
429   Too many request received.

Number requests threshold reached, please resubmit the request after sometime.
500   Internal server error.

Unknown error occurred, please resubmit the request.
502   Bad Gateway.

Bad Gateway, please resubmit the request
503   Service Unavailable.

Service is currently unavailable, please resubmit the request.
504   Gateway timeout.

Request could not be processed on time, please resubmit the request.
YAML file