Previous Day Reporting | Developer Portal

Run reports for posted transactions

What you can do	Endpoint
Health check	get /ddaReports/accounts/v1/healthCheck
Get a list of transactions for a historical date range	post /ddaReports/accounts/v1/transactions/list
Get a detailed transaction report	post /ddaReports/accounts/v1/transactions/details
Get an account summary report for a single historical date	post /ddaReports/accounts/v1/transactions/prevDay/summary

Before you begin

All KeyBank APIs require certificates, user credentials, and certain permissions. Check out our Getting Started Guide to learn more.

Overview

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.

What does that code mean?

Look up the baiCode that identifies the balance or transaction codes for your report. Go to our Data values page.

Health check

get /ddaReports/accounts/v1/healthCheck

Request

Check the health of an API service and verify you can successfully connect. A bearer token is required.

Request example

curl "https://partner-api-qv.key.com/ddaReports/accounts/v1/healthCheck"
--header 'Bearer testZcKJDWnwDWmmf9qah6PJvPy8'

Successful response

NAME	TYPE	DESCRIPTION
Statusoptional	string	The status of the health check response.
Sourceoptional	string	The origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
Timestampoptional	string	The date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIpoptional	string	The client IP address the gateway receives from the request.
X-Forwarded-Foroptional	string	The sequence of the IP addresses for systems between the client and the gateway.

Response example (200)

{
   "Status": "Ok",
   "Source": "Roundtrip",
   "Timestamp": "2022-09-15T04:49:03",
   "ClientIp": "156.77.111.28",
   "X-Forwarded-For": "[156.77.111.28]"
}

Get a list of transactions for a historical date range

post /ddaReports/accounts/v1/transactions/list

Retrieve historical transaction activity for one or multiple accounts. Transaction data can be recalled from the previous 24 months. When setting the date range (fromDate and toDate), the date range specified cannot exceed more than 90 days.

Request

BODY FIELD	TYPE	DESCRIPTION
accountNumberrequired	array	Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.
fromDaterequired	string	Start date for the date range. The date must be prior to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than 90 days. Format: YYYY-MM-DD
toDaterequired	string	The end date of a date range for the submitted transactions. Transaction data can be recalled from the previous 24 months. The date cannot be today's date and it must be later than the start date (fromDate). Date range cannot exceed more than 90 days. Format: YYYY-MM-DD
creditOrDebitCodeoptional	string	Code that indicates if the transaction is a credit or a debit. To retrieve both credit and debit transactions, leave this field blank. Valid values: C (credit), D (debit)
transactionTypeCodeoptional	string	The banking processor code for a particular transaction type. If the type is not specified in the request, all transaction types associated with the account activity are returned.
fromAmountoptional	string	The minimum amount of a transaction. If no amount is specified, all amounts greater than $0.00 are returned.
toAmountoptional	string	The maximum amount of a transaction. If no amount is specified, all transactions are returned.
startRowIndexoptional	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional	string	Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request cannot exceed more than 1000 records from the startRowIndex.

Request example

{
    "getDDATransactionsRequest": {
        "accountNumber": [
            "123456789"
        ],
        "fromDate": "2021-06-12",
        "toDate": "2021-07-12",
        "creditOrDebitCode": "C",
        "transactionTypeCode": "1003",
        "fromAmount": "1.00",
        "toAmount": "1000.00",
        "startRowIndex": "1",
        "endRowIndex": "1"
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDATransactionsoptional	array	ddaTransactions

Response example (200)

{
    "getDDATransactionsResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully returned results for the requested range 1 to 1",
            "retrievedRows": "1",
            "totalRows": "66",
            "dataLoadDate": "2022-07-05"
        },
        "DDATransactions": [
            {
                "accountNumber": "123456789",
                "transactionEffectiveDate": "06\/16\/2021",
                "creditOrDebitCode": "C",
                "transactionTypeCode": "1003",
                "transactionAmount": "524.78",
                "transactionKey": "C 000000000000000001",
                "transactionDescription": "DEPOSIT    BRANCH 0505 PENNSYLVANIA",
                "transactionSequenceNumber": "140",
                "currentLedgerBalancePostTransaction": "300596.77",
                "currencyCode": "USD",
                "addendaInformation": {
                    "WiresData": {
                        "creditArrangementTypeCode": "",
                        "creditArrangementBankNumber": "",
                        "creditArrangementBankBranch": "",
                        "creditArrangementCurrencyCode": "",
                        "creditInvolvedPartyIdentifier": "",
                        "creditInvolvedPartyName": "",
                        "creditArrangementCountryCode": "",
                        "creditInvolvedPartyTypeCode": "",
                        "debitArrangementTypeCode": "",
                        "debitArrangementBankNumber": "",
                        "debitArrangementBankBranch": "",
                        "debitArrangementCurrencyCode": "",
                        "debitInvolvedPartyIdentifier": "",
                        "debitInvolvedPartyName": "",
                        "transactionBusinessStatusCode": "",
                        "sendingBankReferenceNumber": "",
                        "originatingInvolvedPartyName": "TEST COMPANY 1, LLC",
                        "originatingArrangementNumber": "12345123",
                        "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland",
                        "originatingInvolvedPartyAddressLine2": "OH 44114",
                        "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC",
                        "beneficiaryArrangementNumber": "3435656765",
                        "beneficiaryInvolvedPartyAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryInvolvedPartyAddressLine2": "Buffalo,NY 14202",
                        "intermediaryBankName": "KeyBank National Association",
                        "intermediaryBankABANumber": "21300077",
                        "intermediaryBICCode": "KEYBUS33 XXX",
                        "intermediaryBankAddressLine1": "250 Delaware Ave Ste",
                        "intermediaryBankAddressLine2": "Buffalo,NY 14202",
                        "originatingBankName": "KeyBank National Association",
                        "originatingBankABANumber": "",
                        "originatingBankBICcode": "",
                        "originatingBankAddressLine1": "",
                        "originatingBankAddressLine2": "",
                        "beneficiaryBankName": "KeyBank National Association",
                        "beneficiaryBankABANumber": "21300077",
                        "beneficiaryBankBICcode": "KEYBUS33 XXX",
                        "beneficiaryBankAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryBankAddressLine2": "Buffalo,NY 14202",
                        "sourceTransactionIdentifier": "",
                        "transactionSettledDate": "",
                        "federalReferenceNumber": "",
                        "incomingReferenceNumber": "",
                        "currencyExchangeRate": "",
                        "transactionExecutedDate": "",
                        "bankToBankMemo": "",
                        "transactionIdentifier": "",
                        "originatingABA": "",
                        "originating2ABA": "",
                        "originating3ABA": "",
                        "beneficiaryBankArangeNum": "",
                        "beneficiaryABA": "",
                        "originatingBankDebitBIC": "",
                        "originatingBankCreditBIC": ""
                    }
                }
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	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",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/list",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Get a detailed transaction report

post /ddaReports/accounts/v1/transactions/details

Retrieve the transaction details associated with a specific transaction key and account number combination.

Request

BODY FIELD	TYPE	DESCRIPTION
transactionKeyrequired	array	The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated.
accountNumberrequired	array	Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.

Request example

{
    "getDDATransactionsDetailsRequest": {
        "transactionKey": [
            "C 000000000000000001"
        ],
        "accountNumber": [
            "123456789"
        ]
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDATransactionsDetailsoptional	array	ddaTransactionsDetails

Response example (200)

{
    "getDDATransactionsDetailsResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully returned  1 results from sourcing layer.",
            "dataLoadDate": "2022-07-05"
        },
        "DDATransactionsDetails": [
            {
                "accountNumber": "123456789",
                "transactionEffectiveDate": "07\/09\/2021",
                "creditOrDebitCode": "C",
                "transactionType": "1003",
                "transactionAmount": "90.82",
                "transactionKey": "C 000000000000000001",
                "transactionDescription": "DEPOSIT    BRANCH 0505 PENNSYLVANIA",
                "transactionSequenceNumber": "140",
                "currentLedgerBalancePostTransaction": "376145.36",
                "snapshotDate": "07\/09\/2021",
                "collectedCashAmount": "90.82",
                "shortFloatAmountDay1": "0",
                "checkSerialNumber": "100014399",
                "traceID": "C 000000000000000001",
                "glSourceCode": "5",
                "operatorID": "",
                "BAICode": "301",
                "BAICodeDesc": "COMMERCIAL DEPOSIT",
                "addendaInformation": {
                    "WiresData": {
                        "creditArrangementTypeCode": "",
                        "creditArrangementBankNumber": "",
                        "creditArrangementBankBranch": "",
                        "creditArrangementCurrencyCode": "",
                        "creditInvolvedPartyIdentifier": "",
                        "creditInvolvedPartyName": "",
                        "creditArrangementCountryCode": "",
                        "creditInvolvedPartyTypeCode": "",
                        "debitArrangementTypeCode": "",
                        "debitArrangementBankNumber": "",
                        "debitArrangementBankBranch": "",
                        "debitArrangementCurrencyCode": "",
                        "debitInvolvedPartyIdentifier": "",
                        "debitInvolvedPartyName": "",
                        "transactionBusinessStatusCode": "",
                        "sendingBankReferenceNumber": "",
                        "originatingInvolvedPartyName": "TEST COMPANY 1, LLC",
                        "originatingArrangementNumber": "12345123",
                        "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland",
                        "originatingInvolvedPartyAddressLine2": "OH 44114",
                        "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC",
                        "beneficiaryArrangementNumber": "3435656765",
                        "beneficiaryInvolvedPartyAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryInvolvedPartyAddressLine2": "Buffalo,NY 14202",
                        "intermediaryBankName": "KeyBank National Association",
                        "intermediaryBankABANumber": "21300077",
                        "intermediaryBICCode": "KEYBUS33 XXX",
                        "intermediaryBankAddressLine1": "250 Delaware Ave Ste",
                        "intermediaryBankAddressLine2": "Buffalo,NY 14202",
                        "originatingBankName": "KeyBank National Association",
                        "originatingBankABANumber": "",
                        "originatingBankBICcode": "",
                        "originatingBankAddressLine1": "",
                        "originatingBankAddressLine2": "",
                        "beneficiaryBankName": "KeyBank National Association",
                        "beneficiaryBankABANumber": "21300077",
                        "beneficiaryBankBICcode": "KEYBUS33 XXX",
                        "beneficiaryBankAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryBankAddressLine2": "Buffalo,NY 14202",
                        "sourceTransactionIdentifier": "",
                        "transactionSettledDate": "",
                        "federalReferenceNumber": "",
                        "incomingReferenceNumber": "",
                        "currencyExchangeRate": "",
                        "transactionExecutedDate": "",
                        "bankToBankMemo": "",
                        "transactionIdentifier": "",
                        "originatingABA": "",
                        "originating2ABA": "",
                        "originating3ABA": "",
                        "beneficiaryBankArangeNum": "",
                        "beneficiaryABA": "",
                        "originatingBankDebitBIC": "",
                        "originatingBankCreditBIC": ""
                    }
                }
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	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",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/details",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Get an account summary report for a single historical date

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

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

Request

BODY FIELD	TYPE	DESCRIPTION
accountNumberrequired	array	Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.
daterequired	string	Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

Request example

{
    "getDDAPrevDaySummaryRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2022-07-18"
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDAPrevDaySummaryoptional	array	ddaPrevDaySummary

Response example (200)

{
    "getDDAPrevDaySummaryResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully processed the request.",
            "dataLoadDate": "2022-05-10",
            "summaryTotal": {
                "totalClosingLedger": "42.21",
                "totalClosingAvailable": "42.21",
                "totalFloatDay1": "0.0",
                "totalFloatDay2": "0.0",
                "sumTotalCredits": "2.22",
                "sumTotalDebits": "0.02",
                "totalOpeningAvailable": "42.21"
            }
        },
        "DDAPrevDaySummary": [
            {
                "accountNumber": "123456789",
                "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"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	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",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "Api-Url": "\/ddaReports\/accounts\/v1\/transactions\/prevDay\/summary",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Schemas

DDATransactionsRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.
fromDaterequired	string	Start date for the date range. The date must be prior to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than 90 days. Format: YYYY-MM-DD
toDaterequired	string	The end date of a date range for the submitted transactions. Transaction data can be recalled from the previous 24 months. The date cannot be today's date and it must be later than the start date (fromDate). Date range cannot exceed more than 90 days. Format: YYYY-MM-DD
creditOrDebitCode	string	Code that indicates if the transaction is a credit or a debit. To retrieve both credit and debit transactions, leave this field blank. Valid values: C (credit), D (debit)
transactionTypeCode	string	The banking processor code for a particular transaction type. If the type is not specified in the request, all transaction types associated with the account activity are returned.
fromAmount	string	The minimum amount of a transaction. If no amount is specified, all amounts greater than $0.00 are returned.
toAmount	string	The maximum amount of a transaction. If no amount is specified, all transactions are returned.
startRowIndex	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndex	string	Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request cannot exceed more than 1000 records from the startRowIndex.

responseHeaders

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successfully retrieved.
statusDescriptionrequired	string	Description of the status.
dataLoadDate	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrievedRows	string	Total number of transactions retrieved.
totalRows	string	Total number of transactions matching the requested criteria.
summaryTotal	Object	SummaryTotal

SummaryTotal

NAME	TYPE	DESCRIPTION
totalClosingLedger	string	Sum of all account-level closing ledger balances.
totalClosingAvailable	string	Sum of all account-level closing available balances.
totalFloatDay1	string	Sum of all account-level 1 day float.
totalFloatDay2	string	Sum of all account-level 2 day float.
sumTotalCredits	string	Sum of all account-level total credits.
sumTotalDebits	string	Sum of all account-level total debits.
totalOpeningAvailable	string	Sum of all account-level opening available balances.

addendaInformation

NAME	TYPE	DESCRIPTION
WiresData	object	wiresData

wiresData

NAME	TYPE	DESCRIPTION
creditArrangementTypeCode	string	Credit account type code
creditArrangementBankNumber	string	Bank number holding the credit account.
creditArrangementBankBranch	string	Bank branch holding the credit account.
creditArrangementCurrencyCode	string	Transaction currency code of the credit account.
creditInvolvedPartyIdentifier	string	Customer number associated with the credit account.
creditInvolvedPartyName	string	Customer name associated with the credit account.
creditArrangementCountryCode	string	Country of the credit account.
creditInvolvedPartyTypeCode	string	Customer type associated with the credit account.
debitArrangementTypeCode	string	Debit account type code
debitArrangementBankNumber	string	Bank number holding the debit account.
debitArrangementBankBranch	string	Bank branch holding the debit account.
debitArrangementCurrencyCode	string	Transaction currency code of the debit account.
debitInvolvedPartyIdentifier	string	Customer number associated with the debit account.
debitInvolvedPartyName	string	Customer name associated with the debit account.
transactionBusinessStatusCode	string	Transaction business status code
sendingBankReferenceNumber	string	Reference number attached to a wire, issued by the sending bank.
originatingInvolvedPartyName	string	Name of the wire transaction originator.
originatingArrangementNumber	string	Account number of the wire transaction originator.
originatingInvolvedPartyAddressLine1	string	Address line 1 of the wire transaction originator.
originatingInvolvedPartyAddressLine2	string	Address line 2 of the wire transaction originator.
beneficiaryInvolvedPartyName	string	Beneficiary of the wire payment.
beneficiaryArrangementNumber	string	Account number of the beneficiary.
beneficiaryInvolvedPartyAddressLine1	string	Address line 1 of the beneficiary.
beneficiaryInvolvedPartyAddressLine2	string	Address line 2 of the beneficiary.
intermediaryBankName	string	Name of the intermediary bank.
intermediaryBankABANumber	string	ABA number of the intermediary bank.
intermediaryBICCode	string	BIC number of the intermediary bank.
intermediaryBankAddressLine1	string	Address line 1 of the intermediary bank.
intermediaryBankAddressLine2	string	Address line 2 of the intermediary bank.
originatingBankName	string	Name of the wire originating bank.
originatingBankABANumber	string	ABA number of the wire originating bank.
originatingBankBICcode	string	BIC number of the wire originating bank.
originatingBankAddressLine1	string	Address line 1 of the wire originating bank.
originatingBankAddressLine2	string	Address line 2 of the wire originating bank.
beneficiaryBankName	string	Name of the beneficiary bank.
beneficiaryBankABANumber	string	ABA number of the beneficiary bank.
beneficiaryBankBICcode	string	BIC number of the beneficiary bank.
beneficiaryBankAddressLine1	string	Address line 1 of the beneficiary bank.
beneficiaryBankAddressLine2	string	Address line 2 of the beneficiary bank.
sourceTransactionIdentifier	string	End-to-end ID to uniquely identify a transaction in source systems.
transactionSettledDate	string	Date the transaction is settled. Format: MM-DD-YYYY
federalReferenceNumber	string	Federal reference number
incomingReferenceNumber	string	The incoming reference number, which is provided by the sending bank.
currencyExchangeRate	string	Exchange rate
transactionExecutedDate	string	Date the transaction is executed. Format: MM-DD-YYYY
bankToBankMemo	string	Free-form text transmitted between the banks.
transactionIdentifier	string	Transaction identifier
originatingABA	string	ABA number of the wire originating bank.
originating2ABA	string	Alternative or second ABA number of the wire originating bank.
originating3ABA	string	Alternative or third ABA number of the wire originating bank.
beneficiaryBankArangeNum	string	Beneficiary bank account number
beneficiaryABA	string	Beneficiary ABA
originatingBankDebitBIC	string	Originating bank debit BIC
originatingBankCreditBIC	string	Originating bank credit BIC

ddaTransactions

NAME	TYPE	DESCRIPTION
accountNumber	string	Account number associated with the transaction.
transactionEffectiveDate	string	Effective date of the transaction. Format: MM-DD-YYYY
creditOrDebitCode	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
transactionTypeCode	string	The banking processor code for a particular transaction type.
transactionAmount	string	Transaction amount
transactionKey	string	An alphanumeric code used to keep the transaction activity secure.
transactionDescription	string	Brief description of the transaction.
transactionSequenceNumber	string	Batch sequence number of the transaction.
currentLedgerBalancePostTransaction	string	Current ledger balance following the posting of this transaction.
currencyCode	string	Currency code of the transaction. Default value: USD
addendaInformation	object	addendaInformation

DDATransactionsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDATransactionsoptional	array	ddaTransactions

DDATransactionsResponseError

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successfully retrieved.
statusDescriptionrequired	string	Description of the status.
errorResponse	Object	errorResponse

DDATransactionsDetailsRequest

NAME	TYPE	DESCRIPTION
transactionKeyrequired	array	The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated.
accountNumberrequired	array	Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.

DDATransactionsDetailsResponseError

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successfully retrieved.
statusDescriptionrequired	string	Description of the status.
errorResponse	Object	errorResponse

ddaTransactionsDetailsAddendaInformation

NAME	TYPE	DESCRIPTION
WiresData	object	wiresData

ddaTransactionsDetails

NAME	TYPE	DESCRIPTION
accountNumber	string	Account number associated with the transaction.
transactionEffectiveDate	string	Effective date of the transaction. Format: MM-DD-YYYY
dataLoadDate	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD
creditOrDebitCode	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
transactionType	string	The banking processor code for a particular transaction type.
transactionAmount	string	Transaction amount
transactionKey	string	An alphanumeric code used to keep the transaction activity secure.
transactionDescription	string	Brief description of the transaction.
transactionSequenceNumber	string	Batch sequence number of the transaction.
currentLedgerBalancePostTransaction	string	Current ledger balance following the posting of this transaction.
snapshotDate	string	Snapshot date. Format: MM-DD-YYYY
collectedCashAmount	string	Collected cash amount
shortFloatAmountDay1	string	Dollar amount of short float for the current business day.
checkSerialNumber	string	Serial number of the check.
traceID	string	Source transaction identifier
glSourceCode	string	KeyBank-assigned GL source code
operatorID	string	Operator ID - free-form text field for use by sending application.
BAICode	string	The three-digit BAI (Bank Administration Institute) code for the transaction.
BAICodeDesc	string	Provides the description corresponding to a BAI code.
addendaInformation	object	ddaTransactionsDetailsAddendaInformation

ddaPrevDaySummary

NAME	TYPE	DESCRIPTION
accountNumber	string	Account number associated with the transaction.
closingLedger	string	Ledger balance in the account at the time of closure.
closingAvailable	string	Amount available end of day for transactions.
shortFloatAmountDay0	string	Dollar amount of short float day 0.
shortFloatAmountDay1	string	Dollar amount of short float day 1.
shortFloatAmountDay2	string	Dollar amount of short float day 2.
shortFloatAmountDay3	string	Dollar amount of short float day 3.
shortFloatAmountDay4	string	Dollar amount of short float day 4.
shortFloatAmountDay5	string	Dollar amount of short float day 5.
shortFloatAmountDay6	string	Dollar amount of short float day 6.
reportDate	string	Date the transaction posted. Format: MM-DD-YYYY
totalCredits	string	Total credit transaction amount
totalDebits	string	Total debit transaction amount
openingAvailable	string	Opening available balance
achCredits	string	ACH credits amount
depositsAmount	string	Deposits amount
wireTransferCredits	string	Wire transfer credits amount
zbaCredits	string	ZBA credits amount
otherMiscCredits	string	Other miscellaneous credits amount
achDebits	string	ACH debits amount
checksAmount	string	Checks amount
returnedItemDebits	string	Returned item debits amount
wireTransferDebits	string	Wire transfer debits amount
zbaDebits	string	ZBA debits amount
otherMiscDebits	string	Other miscellaneous debits amount
totalAccountCredits	string	Total account credits
totalAccountDebits	string	Total account debits
achCreditCount	string	ACH credits count
depositsCount	string	Deposits count
wireTransferCreditsCount	string	Wire transfer credits count
zbaCreditsCount	string	ZBA credits count
otherMiscCreditsCount	string	Other miscellaneous credits count
achDebitsCount	string	ACH debits count
checksCount	string	Checks count
returnedItemDebitsCount	string	Returned item debits count
wireTransferDebitsCount	string	Wire transfer debits count
zbaDebitsCount	string	ZBA debits count
otherMiscDebitsCount	string	Other miscellaneous debits count
totalCreditCount	string	Total credits count
totalDebitCount	string	Total debits count

DDATransactionsDetailsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDATransactionsDetailsoptional	array	ddaTransactionsDetails

DDAPrevDaySummaryRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	Use a bank account number to get its historical transaction activity. Retrieving multiple accounts with a single request may impact performance, depending on the volume of transaction activity.
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

DDAPrevDaySummaryResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDAPrevDaySummaryoptional	array	ddaPrevDaySummary

DDAPrevDaySummaryResponseError

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successfully retrieved.
statusDescriptionrequired	string	Description of the status.
errorResponse	Object	errorResponse

Exception

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path in the call that generated the response.
ServiceError	oneOf	ServiceErrorData connectError

connectError

NAME	TYPE	DESCRIPTION
ConnectError	string	API connectivity error information, if available.

errorResponse

NAME	TYPE	DESCRIPTION
businessFaultoptional	array	businessFault
systemFaultoptional	array	systemFault

businessFault

NAME	TYPE	DESCRIPTION
errorCode	string	Business error code
errorDescription	string	A human-readable message that describes the type or source of the business error.

ServiceErrorData

NAME	TYPE	DESCRIPTION
ServiceErrorData	oneOf	DDATransactionsResponseError DDATransactionsDetailsResponseError DDAPrevDaySummaryResponseError

systemFault

NAME	TYPE	DESCRIPTION
errorCode	string	System error code
errorDescription	string	A human-readable message that describes the type or source of the system error.

Errors

For more information about general errors, see Error handling.

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

Status codes and messages

HTTP STATUS CODE	CUSTOM STATUS CODE	DESCRIPTION
200	S	`ECA-W-001 Transaction not found.` The request was received, but there is no result for the requested criteria.
299	W	`ECA-W-001 Request processing completed with warnings.` This message occurs when multiple request parameters are provided, and some of the data are not available as part of response.
400	F	`ECA-W-001 Request Validation failed.` There is missing mandatory information like accountNumber, fromDate, or toDate. Review values for mandatory request fields.
400	F	`ECA-W-002 Requested records range is greater than the allowed limit - 1000` Response goes beyond 1000 transactions for the requested account. Change the request criteria to help limit returned transactions to the allowed amount.

Changelog

Release	API version	Change description	Impact
September 2025	1.2.8	Added `Api-Url` parameter to all instances of the `exception` schema. This parameter is now a standard part of all error messages to help you identify which call triggered an unsuccessful response. Improved the description for `toDate` parameter to specify that you cannot enter the current date as the end of the date range search.	LOW
March 2025	1.2.7	Updated the `accountNumber` description with recommendation to use one account number per call.	LOW
December 2024	1.2.6	Updated `dataLoadDate` description. This indicates if previous day's data load has completed and is helpful for early morning inquiries.	LOW
May 2024	1.2.5	Changed the `fromDate` and `toDate` to state that the date range cannot be more than 90 days.	LOW
March 2024	1.2.4	`X-CorrelationId` has been removed as a request header field for all endpoints. The parameter is no longer in the request body, but still remains in the code. The system assigns a unique ID when you submit a request and returns the value in the response. Updated `originatingABA` parameter descriptions.	LOW
December 2023	1.2.3	Deprecated the `mdmId` parameter. Backend services and processes have been enhanced to authenticate client API calls without the need for an MDM ID.	MID
September 2023	1.2.3	The `mdmId` description has been updated to communicate that this parameter will soon deprecate in an upcoming release. Modified the format of date parameters to match with KeyBank API standard date format of YYYY-MM-DD.	LOW
August 2023	1.2.2	Deprecated these unused objects: `ErrorTemplate` `link` `source` MDM ID (`mdmId`) is no longer a required parameter, it is now optional.	LOW
May 2023	1.2.1	Deprecated the following parameters from response payloads: `validRequest` `noResult` `warningFlag` `Errors` `Output` `Services` `systemFault` parameter added to the `errorResponse>/code> schema.`	MID
December 2022	1.1.0	Released on the Developer Portal.

Impact levels

LOW: This is a minor change or enhancement that does not alter the operations of the API. Upgrading to the latest specifications is preferable but not required.
MID: The previous API version is valid and operates, but does not contain latest enhancements. You need to update your specifications to get these enhancements.
HIGH: The previous API version is no longer operable. You must upgrade to the latest specifications to access and use this API product.

YAML file