Intraday Reporting

37-minute read 1.2.2 | updated Sep. 26, 2023

Intraday is an information reporting API that retrieves transaction activity, balance summaries, and transaction counts for one or multiple checking accounts. Intraday focuses on a single day’s activity.

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.

Summary Endpoint
Get a list of transactions for the current day post /ddaReports/accounts/v1/transactions/intraday/list
Get an account summary report for the current day post /ddaReports/accounts/v1/transactions/intraday/summary
Get a CDA summary report for the current day post /ddaReports/accounts/v1/transactions/cda/summary
Get the current balance for one or more accounts post /ddaReports/accounts/v1/transactions/current/balances

post /ddaReports/accounts/v1/transactions/intraday/list

Retrieve current-day transaction activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months.

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 list of transactions is 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.
startRowIndexoptional string Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional string Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.

Request example

{
    "getIntraDayTransactionsRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2022-04-11",
        "mdmId": "ABCD12FG34",
        "startRowIndex": "1",
        "endRowIndex": "1"
    }
}
NAME TYPE DESCRIPTION
responseHeaderrequired Object responseHeaders
IntraDayTransactionsoptional array IntraDayTransactions

Response example (200)

{
    "getIntraDayTransactionsResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully returned results for the requested range 1 to 10",
            "retrivedRows": "1",
            "totalRows": "1",
            "dataLoadDate": "2022-07-05"
        },
        "IntraDayTransactions": [
            {
                "accountNumber": "123456789",
                "transactionEffectiveDate": "04\/11\/2022",
                "transactionTypeId": "RTP",
                "addendaInformation": {
                    "WiresData": {
                        "creditArrangementTypeCode": "NOSTRO",
                        "creditArrangementBankNumber": "0101",
                        "creditArrangementBankBranch": "US",
                        "creditArrangementCurrencyCode": "USD",
                        "creditInvolvedPartyIdentifier": "22850641",
                        "creditInvolvedPartyName": "TEST COMPANY 3, LLC",
                        "creditArrangementCountryCode": "CORP",
                        "creditInvolvedPartyTypeCode": "US",
                        "debitArrangementTypeCode": "DDA",
                        "debitArrangementBankNumber": "3290",
                        "debitArrangementBankBranch": "US",
                        "debitArrangementCurrencyCode": "USD",
                        "debitInvolvedPartyIdentifier": "35008380",
                        "debitInvolvedPartyName": "TEST COMPANY 1, LLC",
                        "transactionBusinessStatusCode": "Completed",
                        "sendingBankReferenceNumber": "KTT96632162612772R",
                        "originatingInvolvedPartyName": "TEST COMPANY 1, LLC",
                        "originatingArrangementNumber": "12345123",
                        "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland",
                        "originatingInvolvedPartyAddressLine2": "OH 44114",
                        "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC",
                        "beneficiaryArrangementNumber": "987654321",
                        "beneficiaryInvolvedPartyAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryInvolvedPartyAddressLine2": "Buffalo,NY 14202",
                        "intermediaryBankName": "KeyBank National Association",
                        "intermediaryBankABANumber": "21300077",
                        "intermediaryBICCode": "KEYBUS33 XXX",
                        "intermediaryBankAddressLine1": "250 Delaware Ave Ste",
                        "intermediaryBankAddressLine2": "Buffalo,NY 14202",
                        "originatingBankName": "ORIGINATING BANK USA",
                        "originatingBankABANumber": "123001088",
                        "originatingBankBICcode": "ORIBICODE",
                        "originatingBankAddressLine1": "127 Public Sq",
                        "originatingBankAddressLine2": "Cleveland, OH 44114",
                        "beneficiaryBankName": "KeyBank National Association",
                        "beneficiaryBankABANumber": "21300077",
                        "beneficiaryBankBICcode": "KEYBUS33 XXX",
                        "beneficiaryBankAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryBankAddressLine2": "Buffalo,NY 14202",
                        "sourceTransactionIdentifier": "NOTPROVIDED",
                        "transactionSettledDate": "04\/11\/2022",
                        "federalReferenceNumber": "20220411MMFMP1D002353",
                        "incomingReferenceNumber": "2021092123304446",
                        "transactionExecutedDate": "04\/11\/2022",
                        "transactionIdentifier": "US22041123510763"
                    },
                    "OLDSData": {
                        "bankNumber": "0101",
                        "transactionTypeId": "1085",
                        "srcArrangementNumber": "123456789",
                        "transactionEffDate": "25\/10\/2021",
                        "transactionAmount": "375",
                        "transactionTypeCode": "D",
                        "transactionSrcCode": "ODS",
                        "transactionDescription": "TRANSFER FROM CHECKING TO CHECKING"
                    },
                    "LockboxData": {
                        "lockboxNumber": "1234",
                        "lockboxName": "Keybank Lockbox #1",
                        "lockboxGrpNumber": "1001",
                        "lockboxGrpName": "Keybank Group #1",
                        "firstContactName": "John Doe",
                        "firstContactStreetAddr": "127 Public Sq",
                        "firstContactCity": "Cleveland",
                        "firstContactState": "OH",
                        "firstContactPostalCode": "44114",
                        "firstDepositTransitNumber": "12235",
                        "customDataField1": "XXX123"
                    },
                    "LockboxTransactionData": {
                        "DDAAccountNumber": "123456789",
                        "processDate": "02\/01\/2022",
                        "lockboxGrpBankNumber": "1001",
                        "lockboxNumber": "1234",
                        "remittanceTransactionNumber": "28",
                        "remittancePaidAmount": "36.9",
                        "paidAmount": "250",
                        "payerFinInstRoutingNum": "000008002",
                        "payerArrangementNum": "27911525005",
                        "checkSeqNumber": "27911525005",
                        "floatAmountDay0": "0",
                        "floatAmountDay1": "250",
                        "floatAmountDay2": "0"
                    },
                    "CPCSData": {
                        "sourceArrangementNumber": "1234567890",
                        "regulationEDescription": "KEYCAP ",
                        "transactionDescription2": "E#3830Y",
                        "transactionEffectiveDate": "08\/09\/2021",
                        "transactionActionCode": "D",
                        "transactionAmount": "49985.07",
                        "float1Amount": "49985",
                        "creditOrDebitCode": "C",
                        "traceID": "C 003121080937346069"
                    },
                    "ACHTransactionData": {
                        "transactionAmount": "2496.9",
                        "transactionCode": "22"
                    },
                    "RTPData": {
                        "creditArrangementTypeCode": "NOSTRO",
                        "creditArrangementBankNumber": "0101",
                        "creditArrangementBankBranch": "US",
                        "creditArrangementCurrencyCode": "USD",
                        "creditInvolvedPartyIdentifier": "999997",
                        "creditInvolvedPartyName": "TEST RTP Clearing Account",
                        "creditArrangementCountryCode": "US",
                        "debitArrangementTypeCode": "DDA",
                        "debitArrangementBankNumber": "0618",
                        "debitArrangementBankBranch": "US",
                        "debitArrangementCurrencyCode": "USD",
                        "debitInvolvedPartyIdentifier": "12359355",
                        "debitInvolvedPartyName": "TEST COMPANY 2, LLC",
                        "transactionBusinessStatusCode": "Completed",
                        "originatingInvolvedPartyName": "TEST COMPANY 1, LLC",
                        "originatingArrangementNumber": "12345123",
                        "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland",
                        "originatingInvolvedPartyAddressLine2": "OH 44114",
                        "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC",
                        "beneficiaryArrangementNumber": "987654321",
                        "sourceTransactionIdentifier": "NOTPROVIDED",
                        "transactionSettledDate": "09\/30\/2021",
                        "federalReferenceNumber": "20210930041001039T1BUSRT06428125521",
                        "transactionExecutedDate": "09\/30\/2021",
                        "transactionIdentifier": "US21093000082075",
                        "transactionAmount": "400"
                    }
                }
            }
        ]
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (400)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (401)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (403)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (404)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (405)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (415)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (429)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (500)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (502)

{
    "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."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (503)

{
    "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."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (504)

{
    "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."
    }
}

post /ddaReports/accounts/v1/transactions/intraday/summary

Retrieve a summary of current-day account activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months.

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

{
    "getIntraDaySummaryRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2021-11-15",
        "mdmId": "ABCD12FG34"
    }
}
NAME TYPE DESCRIPTION
responseHeaderrequired Object responseHeaders
DDAIntraDaySummaryoptional array GetIntraDaySummaryResult

Response example (200)

{
    "getIntraDaySummaryResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully processed the request.",
            "dataLoadDate": "2022-07-05"
        },
        "DDAIntraDaySummary": [
            {
                "earlyACHCredit": "5163394",
                "earlyACHCreditCount": "10",
                "lateACHCredit": "6137.55",
                "lateACHCreditCount": "1",
                "lockboxCredit": "0",
                "lockboxCreditCount": "0",
                "wireTransferCredit": "566308.64",
                "wireTransferCreditCount": "6",
                "depositsCredit": "0",
                "otherMiscCredit": "0",
                "otherMiscCreditCount": "0",
                "totalCredit": "5735840.19",
                "totalCreditCount": "17",
                "earlyACHDebit": "4602565.25",
                "earlyACHDebitCount": "2",
                "lateACHDebit": "0",
                "lateACHDebitCount": "0",
                "wireTransferDebit": "1420669.84",
                "wireTransferDebitCount": "2",
                "otherMiscDebit": "0",
                "otherMiscDebitCount": "0",
                "totalDebit": "6023235.09",
                "totalDebitCount": "4",
                "srcBankNum": "0101",
                "srcSysCode": "DDA"
            }
        ]
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (400)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (401)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (403)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (404)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (405)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (415)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (429)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (500)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (502)

{
    "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."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (503)

{
    "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."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (504)

{
    "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."
    }
}

post /ddaReports/accounts/v1/transactions/cda/summary

Retrieve a summary of current-day account activity for one or multiple Controlled Disbursement Accounts (CDA). Transaction data can be recalled from the previous 24 months.

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

{
    "getCDASummaryRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2021-10-08",
        "mdmId": "ABCD12FG34"
    }
}
NAME TYPE DESCRIPTION
responseHeaderrequired Object responseHeaders
CDASummaryoptional array GetCDASummaryResult

Response example (200)

{
    "getCDASummaryResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully processed the request.",
            "dataLoadDate": "2022-07-05"
        },
        "CDASummary": [
            {
                "summary": {
                    "sourceArrangementNumber": "123456789",
                    "snapshotDate": "10\/08\/2021",
                    "sourceSystemOfRecordCode": "CDA",
                    "currencyCode": "USD",
                    "amount": "0",
                    "amountTypeCode": "602",
                    "FundTypeCode": "Z",
                    "itemCount": "0",
                    "processSequenceNumber": "1",
                    "earlyACHCredit": "0",
                    "earlyACHDebit": "3375.69"
                },
                "CDATransactionDetails": {
                    "transactionDate": "10\/08\/2021",
                    "snapshotDate": "10\/08\/2021",
                    "originatingFinancialInstitutionReferenceNumber": "1",
                    "transactionDescription": "CHECK 0000144872",
                    "transactionTypeCode": "475",
                    "fundTypeCode": "Z",
                    "amount": "3995.4",
                    "processSequenceNumber": "1"
                },
                "ACHMemoPost": {
                    "sourceArrangementNumber": "123456789",
                    "transactionProcessedDate": "10\/08\/2021",
                    "transactionAmount": "2307.42",
                    "transactionCreditDebitCode": "C",
                    "derivedBAICode": "165",
                    "transactionCode": "22",
                    "description1": "TEST MERCHANT DEPOSIT",
                    "description2": "896217706887",
                    "description3": "42930550001626 8 CAR",
                    "description4": "X IA TI",
                    "transactionPostingWindow": "0600"
                }
            }
        ]
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (400)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (401)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (403)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (404)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (405)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (415)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (429)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (500)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (502)

{
    "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."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (503)

{
    "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."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (504)

{
    "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."
    }
}

post /ddaReports/accounts/v1/transactions/current/balances

Retrieve the current balance information, including both ledger and available balance, for one or more accounts. Transaction data can be recalled from the previous 24 months.

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 current balances 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

{
    "getCurrentBalancesRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2021-11-15",
        "mdmId": "ABCD12FG34"
    }
}
NAME TYPE DESCRIPTION
responseHeaderoptional Object responseHeaders
CurrentBalancesoptional array GetCurrentBalancesResult

Response example (200)

{
    "getCurrentBalancesResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully processed the request."
        },
        "CurrentBalances": [
            {
                "currentBalances": {
                    "holds": "0.00",
                    "uncollectedFunds": "0.00",
                    "currentLedger": "3267948.16",
                    "currentAvailable": "3267948.16",
                    "openingAvailable": "3267948.16"
                }
            }
        ]
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (400)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (401)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (403)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (404)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (405)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (415)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (429)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (500)

{
    "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"
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (502)

{
    "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."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (503)

{
    "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."
    }
}
NAME TYPE DESCRIPTION
ErrorMessageoptional string A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional string A universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptional string A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional string Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional oneOf ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (504)

{
    "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."
    }
}
NAMETYPEDESCRIPTION
sourceArrangementNumberoptionalstringAccount number
transactionProcessedDateoptionalstringDate the transaction was processed. Format: YYYY-MM-DD
transactionAmountoptionalstringTransaction amount
transactionCreditDebitCodeoptionalstringCode that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
derivedBAICodeoptionalstringBAI2 transaction code
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
description1optionalstringBrief description of the transaction.
description2optionalstringBrief description of the transaction.
description3optionalstringBrief description of the transaction.
description4optionalstringBrief description of the transaction.
transactionPostingWindowoptionalstringPosting window of the transaction.
NAMETYPEDESCRIPTION
addendaPresentFlagoptionalstringAddenda present identifier
transactionAmountoptionalstringTransaction amount
nachaBatchNumberoptionalstringNACHA sequential batch number
checkSerialNumberoptionalstringSerial number of the check.
transactionDescription1optionalstringBrief description of the transaction.
originatingCompanyIDNumberoptionalstringOriginating company ID number
originatingCompanyNameoptionalstringOriginating company name
creditOrDebitCodeoptionalstringCode that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
originalReceiverCodeoptionalstringIdentifies the type Originating/Receiving and Incoming/Outgoing.
sourceTransactionProcessedDateoptionalstringDate the transaction was processed. Format: YYYY-MM-DD
receivingArrangementNumberoptionalstringAccount number of the receiver.
sourceTransactionPostedDateoptionalstringDate the transaction was posted. Format: YYYY-MM-DD
nachaFileReferenceNumberoptionalstringNACHA transaction file reference number
collectionPointoptionalstringTransaction collection point
goRoutingNumberoptionalstringGateway operator routing number for international transactions.
receivingCustomerIDNumberoptionalstringReceiving customer ID number
receivingCustomerNameoptionalstringReceiving customer name
receivingCompanyNameoptionalstringReceiving customer company name
addendaRecordNumberoptionalstringNumber of addenda records.
originatingCustomerNameoptionalstringOriginating customer name
originatingFinancialInstitutionRoutingNumberoptionalstringOriginating financial institution routing number
authorisedCustomerNameoptionalstringAuthorized customer name
originatingArrangementNumberoptionalstringAccount number of the originator.
receivingFinancialInstitutionBankNumberoptionalstringReceiving financial institution bank number
receivingFinancialInstitutionRoutingNumberoptionalstringReceiving financial institution routing number
nachaStandardEntryClassCodeoptionalstringNACHA SEC code
transactionPARNumberoptionalstringReference number assigned by the ACH processor.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
sourceTransactionSetteledDateoptionalstringDate the transaction was settled. Format: YYYY-MM-DD
inboundCollectionWindowoptionalstringProcessing window of the transaction collection.
IATFlagoptionalstringInternational transaction identifier
transactionTraceIDoptionalstringSource application created transaction identifier
originatingFinancialInstitutionBankNumberoptionalstringOriginating financial institution bank number
NAMETYPEDESCRIPTION
WiresDataoptionalObjectWiresData
OLDSDataoptionalObjectOLDSData
LockboxDataoptionalObjectLockboxData
LockboxTransactionDataoptionalObjectLockboxTransactionData
CPCSDataoptionalObjectCPCSData
ACHTransactionDataoptionalObjectACHTransactionData
RTPDataoptionalObjectRTPData
NAMETYPEDESCRIPTION
errorCodeoptionalstringBusiness error code
errorDescriptionoptionalstringA human-readable message that describes the type or source of the business error.
NAMETYPEDESCRIPTION
transactionDateoptionalstringDate the transaction posted. Format: MM-DD-YYYY
snapshotDateoptionalstringDate that requested data was loaded. Format: MM-DD-YYYY
originatingFinancialInstitutionReferenceNumberoptionalstringReference number of the originating financial institution.
currencyCodeoptionalstringCurrency code of the transaction. Default value: USD
transactionDescriptionoptionalstringBrief description of the transaction.
transactionTypeCodeoptionalstringThe banking processor code for a particular transaction type.
fundTypeCodeoptionalstringCode associated with the fund type.
amountoptionalstringTransaction amount
customerReferenceNumberoptionalstringReference number attached to the customer.
processSequenceNumberoptionalstringSequence number of the transaction.
NAMETYPEDESCRIPTION
ConnectErroroptionalstringAPI connectivity error information, if available.
NAMETYPEDESCRIPTION
transactionPostedDateoptionalstringDate the transaction posted. Format: MM-DD-YYYY
sourceArrangementNumberoptionalstringAccount number
transactionDescriptionPart1optionalstringDescription of transaction, part 1
transactionDescriptionPart2optionalstringDescription of transaction, part 2
transactionDescriptionPart3optionalstringDescription of transaction, part 3
regulationEDescriptionoptionalstringRegulation E description
transactionDescription2optionalstringDescription of transaction
transactionEffectiveDateoptionalstringEffective date of the transaction. Format: YYYY-MM-DD
transactionActionCodeoptionalstringTransaction action identifier
transactionAmountoptionalstringTransaction amount
cashAmountoptionalstringCash part of transaction amount
checkIdentificationNumberoptionalstringCan contain serial number of item or store number for identification purposes.
float0AmountoptionalstringFloat 0 amount
float1AmountoptionalstringFloat 1 amount
float2AmountoptionalstringFloat 2 amount
float3AmountoptionalstringFloat 3 amount
float4AmountoptionalstringFloat 4 amount
float5AmountoptionalstringFloat 5 amount
float6AmountoptionalstringFloat 6 amount
float7AmountoptionalstringFloat 7 amount
priorDateFlagoptionalstringIf the transaction date is prior to the current business date then this is set to "P".
creditOrDebitCodeoptionalstringCode that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
traceIDoptionalstringSource transaction identifier
NAMETYPEDESCRIPTION
holdsoptionalstringAmount that is on hold
uncollectedFundsoptionalstringUncollected funds amount
currentLedgeroptionalstringCurrent ledger balance
currentAvailableoptionalstringCurrent available balance
openingAvailableoptionalstringOpening available balance
NAMETYPEDESCRIPTION
businessFaultoptionalarrayBusinessFault
systemFaultoptionalarraySystemFault
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringA human-readable message that describes the type or source of the error.
X-CorrelationIdoptionalstringA universal ID to trace the transaction across all the systems involved, useful for system logging and identification.
TransactionIdoptionalstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptionalstringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptionaloneOfExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError
NAMETYPEDESCRIPTION
ExceptionCDASummaryobjectGetCDASummaryResponseException
NAMETYPEDESCRIPTION
ExceptionCurrentBalanceobjectGetCurrentBalancesResponseException
NAMETYPEDESCRIPTION
ExceptionIntraDayListobjectGetIntraDayTransactionsResponseException
NAMETYPEDESCRIPTION
ExceptionIntraDaySummaryobjectGetIntraDaySummaryResponseException
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequiredstringDate for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD
mdmIdoptionalstringThe 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.
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
CDASummaryoptionalarrayGetCDASummaryResult
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status.
dataLoadDateoptionalstringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrivedRowsoptionalstringTotal number of transactions retrieved.
totalRowsoptionalstringTotal number of transactions matching the requested criteria.
errorResponseoptionalObjectErrorResponse
NAMETYPEDESCRIPTION
summaryoptionalObjectSummary
CDATransactionDetailsoptionalObjectCDATransactionDetails
ACHMemoPostoptionalObjectACHMemoPost
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequiredstringDate for which the current balances are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD
mdmIdoptionalstringThe 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.
NAMETYPEDESCRIPTION
responseHeaderoptionalObjectresponseHeaders
CurrentBalancesoptionalarrayGetCurrentBalancesResult
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status.
dataLoadDateoptionalstringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrivedRowsoptionalstringTotal number of transactions retrieved.
totalRowsoptionalstringTotal number of transactions matching the requested criteria.
errorResponseoptionalObjectErrorResponse
NAMETYPEDESCRIPTION
currentBalancesoptionalObjectCurrentBalances
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequiredstringDate for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD
mdmIdoptionalstringThe 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.
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
DDAIntraDaySummaryoptionalarrayGetIntraDaySummaryResult
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status
dataLoadDateoptionalstringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
errorResponseoptionalObjectErrorResponse
NAMETYPEDESCRIPTION
earlyACHCreditoptionalstringTotal credit amount as of 0600 posting window.
earlyACHCreditCountoptionalstringTotal number of ACH credit transactions as of 0600 posting window.
lateACHCreditoptionalstringTotal credit amount from posting windows other than 0600.
lateACHCreditCountoptionalstringTotal number of ACH credit transactions from posting windows other than 0600.
lockboxCreditoptionalstringTotal credit amount of lockbox transactions.
lockboxCreditCountoptionalstringTotal number of lockbox credit transactions.
wireTransferCreditoptionalstringTotal credit amount of wire transfer transactions.
wireTransferCreditCountoptionalstringTotal number of wire transfer credit transactions.
depositsCreditoptionalstringTotal credit amount through deposits.
otherMiscCreditoptionalstringOther miscellaneous credit amounts.
otherMiscCreditCountoptionalstringTotal number of miscellaneous credit transactions.
totalCreditoptionalstringTotal credit amount from memo post, lockbox, wires, OLDS, and CPCS transactions.
totalCreditCountoptionalstringTotal number of credits from memo post, lockbox, wires, OLDS, and CPCS transactions.
earlyACHDebitoptionalstringTotal debit amount as of 0600 posting window.
earlyACHDebitCountoptionalstringTotal number of ACH debit transactions as of 0600 posting window.
lateACHDebitoptionalstringTotal debit amount from posting windows other than 0600.
lateACHDebitCountoptionalstringTotal number of ACH debit transactions from posting windows other than 0600.
wireTransferDebitoptionalstringTotal debit amount of wire transfer transactions.
wireTransferDebitCountoptionalstringTotal number of wire transfer debit transactions.
otherMiscDebitoptionalstringOther miscellaneous debit amounts.
otherMiscDebitCountoptionalstringTotal number of miscellaneous debit transactions.
totalDebitoptionalstringTotal debit amount from memo post, lockbox, wires, OLDS, and CPCS transactions.
totalDebitCountoptionalstringTotal number of debits from memo post, lockbox, wires, OLDS, and CPCS transactions.
srcBankNumoptionalstringSource bank number
srcSysCodeoptionalstringSource system code
currentBalancesoptionalObjectGetCurrentBalancesResult
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequiredstringDate for which the list of transactions is to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD
mdmIdoptionalstringThe 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.
startRowIndexoptionalstringPagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptionalstringPagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
IntraDayTransactionsoptionalarrayIntraDayTransactions
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status.
dataLoadDateoptionalstringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrivedRowsoptionalstringTotal number of transactions retrieved.
totalRowsoptionalstringTotal number of transactions matching the requested criteria.
errorResponseoptionalObjectErrorResponse
NAMETYPEDESCRIPTION
accountNumberoptionalstringAccount number associated with the transaction.
transactionEffectiveDateoptionalstringEffective date of the transaction. Format: YYYY-MM-DD
transactionTypeIdoptionalstringTransaction type identifier
addendaInformationoptionalObjectAddendaInformation
NAMETYPEDESCRIPTION
lockboxNumberoptionalstringLockbox number
lockboxNameoptionalstringLockbox name
lockboxGrpNumberoptionalstringLockbox grouping number
lockboxGrpNameoptionalstringLockbox grouping name
firstContactNameoptionalstringFirst contact name defined in lockbox contacts
firstContactStreetAddroptionalstringStreet address for named contact
firstContactCityoptionalstringCity for named contact
firstContactStateoptionalstringState for named contact
firstContactPostalCodeoptionalstringZip code for named contact
firstDepositTransitNumberoptionalstringTransit number for named contact
customDataField1optionalstringCustom data field
NAMETYPEDESCRIPTION
DDAAccountNumberoptionalstringDDA account number associated with lockbox.
processDateoptionalstringDate the transaction was processed. Format: YYYY-MM-DD
lockboxGrpBankNumberoptionalstringNot a KeyBank bank number. Used by lockbox application to group lockboxes.
lockboxNumberoptionalstringLockbox number
remittanceTransactionNumberoptionalstringTransaction number
remittancePaidAmountoptionalstringRemittance applied amount
paidAmountoptionalstringAmount being paid by the payment record.
payerFinInstRoutingNumoptionalstringRouting and transit number field from payment. This is the routing number of the payer account.
payerArrangementNumoptionalstringAccount number field from payment
checkSeqNumberoptionalstringCheck number from payment
floatAmountDay0optionalstringLockbox float - amount available day 0
floatAmountDay1optionalstringLockbox float - amount available day 1
floatAmountDay2optionalstringLockbox float - amount available day 2
NAMETYPEDESCRIPTION
bankNumberoptionalstringBank number associated with the account number.
transactionTypeIdoptionalstringFour-digit transaction type identifier.
srcArrangementNumberoptionalstringCan be any account number, DDA, loan account, credit card, or savings.
transactionEffDateoptionalstringEffective date of the transaction. Format: YYYY-MM-DD
transactionAmountoptionalstringTransaction amount
transactionTypeCodeoptionalstringCode that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
reversalFlagoptionalstringDenotes if the transaction is a reversal transaction of an earlier transaction.
transactionSrcCodeoptionalstringIdentifies the source of the transaction.
transactionDescriptionoptionalstringBrief description of the transaction.
traceIdoptionalstringSource transaction identifier
transactionCodeBAI2optionalstringBAI2 transaction code
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status.
dataLoadDateoptionalstringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrivedRowsoptionalstringTotal number of transactions retrieved.
totalRowsoptionalstringTotal number of transactions matching the requested criteria.
NAMETYPEDESCRIPTION
creditArrangementTypeCodeoptionalstringCredit account type code
creditArrangementBankNumberoptionalstringBank number holding the credit account.
creditArrangementBankBranchoptionalstringBank branch holding the credit account.
creditArrangementCurrencyCodeoptionalstringTransaction currency code of the credit account.
creditInvolvedPartyIdentifieroptionalstringCustomer number associated with the credit account.
creditInvolvedPartyNameoptionalstringCustomer name associated with the credit account.
creditArrangementCountryCodeoptionalstringCountry of the credit account.
creditInvolvedPartyTypeCodeoptionalstringCustomer type associated with the credit account.
debitArrangementTypeCodeoptionalstringDebit account type code
debitArrangementBankNumberoptionalstringBank number holding the debit account.
debitArrangementBankBranchoptionalstringBank branch holding the debit account.
debitArrangementCurrencyCodeoptionalstringTransaction currency code of the debit account.
debitInvolvedPartyIdentifieroptionalstringCustomer number associated with the debit account.
debitInvolvedPartyNameoptionalstringCustomer name associated with the debit account.
transactionBusinessStatusCodeoptionalstringTransaction business status code
sendingBankReferenceNumberoptionalstringReference number attached to a wire, issued by the sending bank.
originatingInvolvedPartyNameoptionalstringName of the wire transaction originator.
originatingArrangementNumberoptionalstringAccount number of the wire transaction originator.
originatingInvolvedPartyAddressLine1optionalstringAddress line 1 of the wire transaction originator.
originatingInvolvedPartyAddressLine2optionalstringAddress line 2 of the wire transaction originator.
beneficiaryInvolvedPartyNameoptionalstringBeneficiary of the wire payment.
beneficiaryArrangementNumberoptionalstringAccount number of the beneficiary.
beneficiaryInvolvedPartyAddressLine1optionalstringAddress line 1 of the beneficiary.
beneficiaryInvolvedPartyAddressLine2optionalstringAddress line 2 of the beneficiary.
intermediaryBankNameoptionalstringName of the intermediary bank.
intermediaryBankABANumberoptionalstringABA number of the intermediary bank.
intermediaryBICCodeoptionalstringBIC number of the intermediary bank.
intermediaryBankAddressLine1optionalstringAddress line 1 of the intermediary bank.
intermediaryBankAddressLine2optionalstringAddress line 2 of the intermediary bank.
originatingBankNameoptionalstringName of the wire originating bank.
originatingBankABANumberoptionalstringABA number of the wire originating bank.
originatingBankBICcodeoptionalstringBIC number of the wire originating bank.
originatingBankAddressLine1optionalstringAddress line 1 of the wire originating bank.
originatingBankAddressLine2optionalstringAddress line 2 of the wire originating bank.
beneficiaryBankNameoptionalstringName of the beneficiary bank.
beneficiaryBankABANumberoptionalstringABA number of the beneficiary bank.
beneficiaryBankBICcodeoptionalstringBIC number of the beneficiary bank.
beneficiaryBankAddressLine1optionalstringAddress line 1 of the beneficiary bank.
beneficiaryBankAddressLine2optionalstringAddress line 2 of the beneficiary bank.
sourceTransactionIdentifieroptionalstringEnd-to-end ID to uniquely identify a transaction in source systems.
transactionSettledDateoptionalstringDate the transaction is settled. Format: MM-DD-YYYY
federalReferenceNumberoptionalstringFederal reference number
incomingReferenceNumberoptionalstringThe incoming reference number, which is provided by the sending bank.
currencyExchangeRateoptionalstringExchange rate
transactionExecutedDateoptionalstringDate the transaction is executed. Format: MM-DD-YYYY
bankToBankMemooptionalstringFree-form text transmitted between the banks.
transactionIdentifieroptionalstringTransaction identifier
transactionAmountoptionalstringThe amount of the RTP transaction.
NAMETYPEDESCRIPTION
sourceArrangementNumberoptionalstringAccount number
snapshotDateoptionalstringDate that requested data was loaded. Format: MM-DD-YYYY
sourceSystemOfRecordCodeoptionalstringThis field is for internal purposes only.
currencyCodeoptionalstringCurrency code of the transaction. Default value: USD
amountoptionalstringTransaction amount
amountTypeCodeoptionalstringCode associated with the transaction amount. Valid values: 580 (Total Controlled Disbursing Debits), 584 (Total Disbursing Checks Paid Later Amount), 602 (Total Adjustments), 585 (Required Funding Amount)
FundTypeCodeoptionalstringCode associated with the fund type.
itemCountoptionalstringTotal number of transactions
processSequenceNumberoptionalstringSequence number of the transaction.
earlyACHCreditoptionalstringTotal credit amount as of 0600 posting window.
earlyACHDebitoptionalstringTotal debit amount as of 0600 posting window.
NAMETYPEDESCRIPTION
errorCodeoptionalstringSystem error code
errorDescriptionoptionalstringA human-readable message that describes the type or source of the system error.
NAMETYPEDESCRIPTION
creditArrangementTypeCodeoptionalstringCredit account type code
creditArrangementBankNumberoptionalstringBank number holding the credit account.
creditArrangementBankBranchoptionalstringBank branch holding the credit account.
creditArrangementCurrencyCodeoptionalstringTransaction currency code of the credit account.
creditInvolvedPartyIdentifieroptionalstringCustomer number associated with the credit account.
creditInvolvedPartyNameoptionalstringCustomer name associated with the credit account.
creditArrangementCountryCodeoptionalstringCountry of the credit account.
creditInvolvedPartyTypeCodeoptionalstringCustomer type associated with the credit account.
debitArrangementTypeCodeoptionalstringDebit account type code
debitArrangementBankNumberoptionalstringBank number holding the debit account.
debitArrangementBankBranchoptionalstringBank branch holding the debit account.
debitArrangementCurrencyCodeoptionalstringTransaction currency code of the debit account.
debitInvolvedPartyIdentifieroptionalstringCustomer number associated with the debit account.
debitInvolvedPartyNameoptionalstringCustomer name associated with the debit account.
transactionBusinessStatusCodeoptionalstringTransaction business status code
sendingBankReferenceNumberoptionalstringReference number attached to a wire, issued by the sending bank.
originatingInvolvedPartyNameoptionalstringName of the wire transaction originator.
originatingArrangementNumberoptionalstringAccount number of the wire transaction originator.
originatingInvolvedPartyAddressLine1optionalstringAddress line 1 of the wire transaction originator.
originatingInvolvedPartyAddressLine2optionalstringAddress line 2 of the wire transaction originator.
beneficiaryInvolvedPartyNameoptionalstringBeneficiary of the wire payment.
beneficiaryArrangementNumberoptionalstringAccount number of the beneficiary.
beneficiaryInvolvedPartyAddressLine1optionalstringAddress line 1 of the beneficiary.
beneficiaryInvolvedPartyAddressLine2optionalstringAddress line 2 of the beneficiary.
intermediaryBankNameoptionalstringName of the intermediary bank.
intermediaryBankABANumberoptionalstringABA number of the intermediary bank.
intermediaryBICCodeoptionalstringBIC number of the intermediary bank.
intermediaryBankAddressLine1optionalstringAddress line 1 of the intermediary bank.
intermediaryBankAddressLine2optionalstringAddress line 2 of the intermediary bank.
originatingBankNameoptionalstringName of the wire originating bank.
originatingBankABANumberoptionalstringABA number of the wire originating bank.
originatingBankBICcodeoptionalstringBIC number of the wire originating bank.
originatingBankAddressLine1optionalstringAddress line 1 of the wire originating bank.
originatingBankAddressLine2optionalstringAddress line 2 of the wire originating bank.
beneficiaryBankNameoptionalstringName of the beneficiary bank.
beneficiaryBankABANumberoptionalstringABA number of the beneficiary bank.
beneficiaryBankBICcodeoptionalstringBIC number of the beneficiary bank.
beneficiaryBankAddressLine1optionalstringAddress line 1 of the beneficiary bank.
beneficiaryBankAddressLine2optionalstringAddress line 2 of the beneficiary bank.
sourceTransactionIdentifieroptionalstringEnd-to-end ID to uniquely identify a transaction in source systems.
transactionSettledDateoptionalstringDate the transaction is settled. Format: MM-DD-YYYY
federalReferenceNumberoptionalstringFederal reference number
incomingReferenceNumberoptionalstringThe incoming reference number, which is provided by the sending bank.
currencyExchangeRateoptionalstringExchange rate
transactionExecutedDateoptionalstringDate the transaction is executed. Format: MM-DD-YYYY
bankToBankMemooptionalstringFree-form text transmitted between the banks.
transactionIdentifieroptionalstringTransaction identifier
transactionAmountoptionalstringThe amount of the wire transaction.

For more information about errors, see Error handling.

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

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

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

Status is S for Success. The request was received, but there is no result for the requested criteria.

299*   Request processing completed with warnings.

Status is W for Warning. This message occurs when multiple request parameters are provided, and some of the data are not available as part of response.

400* ECA-W-001 Request Validation failed.

Status is F for Failure. There is missing mandatory information like accountNumber, fromDate, 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