Previous Day Reporting

clock 2-minute read calender 1.3.2 | updated Oct. 28, 2025

Run reports for posted transactions

What you can doEndpoint
Health checkget /ddaReports/accounts/v1/healthCheck
Get a list of transactions for a historical date rangepost /ddaReports/accounts/v1/transactions/list
Get a detailed transaction reportpost /ddaReports/accounts/v1/transactions/details
Get an account summary report for a single historical datepost /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.

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.


get /ddaReports/accounts/v1/healthCheck

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'
NAMETYPEDESCRIPTION
StatusoptionalstringThe status of the health check response.
SourceoptionalstringThe origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
TimestampoptionalstringThe date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIpoptionalstringThe client IP address the gateway receives from the request.
X-Forwarded-ForoptionalstringThe sequence of the IP addresses for systems between the client and the gateway.

Response example (200)

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

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.

BODY FIELDTYPEDESCRIPTION
accountNumberrequiredarrayUse 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.
fromDaterequiredstringStart 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
toDaterequiredstringThe 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
creditOrDebitCodeoptionalstringCode 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)
transactionTypeCodeoptionalstringThe 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.
fromAmountoptionalstringThe minimum amount of a transaction. If no amount is specified, all amounts greater than $0.00 are returned.
toAmountoptionalstringThe maximum amount of a transaction. If no amount is specified, all transactions are returned.
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 cannot exceed more than 1000 records from the startRowIndex.

Request example

copylink
{
    "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"
    }
}
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
DDATransactionsoptionalarrayddaTransactions

Response example (200)

copylink
{
    "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": ""
                    }
                }
            }
        ]
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (400)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (401)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (403)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (404)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (405)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (415)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (429)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (500)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (502)

copylink
{
    "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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (503)

copylink
{
    "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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (504)

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

post /ddaReports/accounts/v1/transactions/details

Retrieve the transaction details associated with a combination of the transaction key (transactionKey) and account number (accountNumber). 

You can find the transactionKey in the list response. This key is helpful for gathering additional data about the Wire and RTP detail endpoints. This key is not necessarily unique and sometimes reused from the source application.

Note: A transaction key is not needed for returned payments, ATM, Loan IQ, commercial loans, and P2P transaction types because these types do not return a response for the detail endpoint.

BODY FIELDTYPEDESCRIPTION
transactionKeyrequiredarrayAn alphanumeric code that identifies a RTP or Wire transaction for the account.
accountNumberrequiredarrayUse 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

copylink
{
    "getDDATransactionsDetailsRequest": {
        "transactionKey": [
            "C-LBS310521000000032"
        ],
        "accountNumber": [
            "123456789"
        ]
    }
}
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
DDATransactionsDetailsoptionalarrayddaTransactionsDetails

Response example (200)

copylink
{
    "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-LBS310521000000032",
                "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": ""
                    }
                }
            }
        ]
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (400)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (401)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (403)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (404)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (405)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (415)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (429)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (500)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (502)

copylink
{
    "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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (503)

copylink
{
    "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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (504)

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

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.

BODY FIELDTYPEDESCRIPTION
accountNumberrequiredarrayUse 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.
daterequiredstringDate for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

Request example

copylink
{
    "getDDAPrevDaySummaryRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2022-07-18"
    }
}
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
DDAPrevDaySummaryoptionalarrayddaPrevDaySummary

Response example (200)

copylink
{
    "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"
            }
        ]
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (400)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (401)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (403)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (404)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (405)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (415)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (429)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (500)

copylink
{
    "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"
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (502)

copylink
{
    "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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (503)

copylink
{
    "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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError

Response example (504)

copylink
{
    "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."
    }
}
NAMETYPEDESCRIPTION
accountNumberrequiredarrayUse 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.
fromDaterequiredstringStart 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
toDaterequiredstringThe 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
creditOrDebitCodestringCode 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)
transactionTypeCodestringThe 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.
fromAmountstringThe minimum amount of a transaction. If no amount is specified, all amounts greater than $0.00 are returned.
toAmountstringThe maximum amount of a transaction. If no amount is specified, all transactions are returned.
startRowIndexstringPagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexstringPagination 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.
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status.
dataLoadDatestringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrievedRowsstringTotal number of transactions retrieved.
totalRowsstringTotal number of transactions matching the requested criteria.
summaryTotalObjectSummaryTotal
NAMETYPEDESCRIPTION
totalClosingLedgerstringSum of all account-level closing ledger balances.
totalClosingAvailablestringSum of all account-level closing available balances.
totalFloatDay1stringSum of all account-level 1 day float.
totalFloatDay2stringSum of all account-level 2 day float.
sumTotalCreditsstringSum of all account-level total credits.
sumTotalDebitsstringSum of all account-level total debits.
totalOpeningAvailablestringSum of all account-level opening available balances.
NAMETYPEDESCRIPTION
WiresDataobjectwiresData
NAMETYPEDESCRIPTION
creditArrangementTypeCodestringCredit account type code
creditArrangementBankNumberstringBank number holding the credit account.
creditArrangementBankBranchstringBank branch holding the credit account.
creditArrangementCurrencyCodestringTransaction currency code of the credit account.
creditInvolvedPartyIdentifierstringCustomer number associated with the credit account.
creditInvolvedPartyNamestringCustomer name associated with the credit account.
creditArrangementCountryCodestringCountry of the credit account.
creditInvolvedPartyTypeCodestringCustomer type associated with the credit account.
debitArrangementTypeCodestringDebit account type code
debitArrangementBankNumberstringBank number holding the debit account.
debitArrangementBankBranchstringBank branch holding the debit account.
debitArrangementCurrencyCodestringTransaction currency code of the debit account.
debitInvolvedPartyIdentifierstringCustomer number associated with the debit account.
debitInvolvedPartyNamestringCustomer name associated with the debit account.
transactionBusinessStatusCodestringTransaction business status code
sendingBankReferenceNumberstringReference number attached to a wire, issued by the sending bank.
originatingInvolvedPartyNamestringName of the wire transaction originator.
originatingArrangementNumberstringAccount number of the wire transaction originator.
originatingInvolvedPartyAddressLine1stringAddress line 1 of the wire transaction originator.
originatingInvolvedPartyAddressLine2stringAddress line 2 of the wire transaction originator.
beneficiaryInvolvedPartyNamestringBeneficiary of the wire payment.
beneficiaryArrangementNumberstringAccount number of the beneficiary.
beneficiaryInvolvedPartyAddressLine1stringAddress line 1 of the beneficiary.
beneficiaryInvolvedPartyAddressLine2stringAddress line 2 of the beneficiary.
intermediaryBankNamestringName of the intermediary bank.
intermediaryBankABANumberstringABA number of the intermediary bank.
intermediaryBICCodestringBIC number of the intermediary bank.
intermediaryBankAddressLine1stringAddress line 1 of the intermediary bank.
intermediaryBankAddressLine2stringAddress line 2 of the intermediary bank.
originatingBankNamestringName of the wire originating bank.
originatingBankABANumberstringABA number of the wire originating bank.
originatingBankBICcodestringBIC number of the wire originating bank.
originatingBankAddressLine1stringAddress line 1 of the wire originating bank.
originatingBankAddressLine2stringAddress line 2 of the wire originating bank.
beneficiaryBankNamestringName of the beneficiary bank.
beneficiaryBankABANumberstringABA number of the beneficiary bank.
beneficiaryBankBICcodestringBIC number of the beneficiary bank.
beneficiaryBankAddressLine1stringAddress line 1 of the beneficiary bank.
beneficiaryBankAddressLine2stringAddress line 2 of the beneficiary bank.
sourceTransactionIdentifierstringEnd-to-end ID to uniquely identify a transaction in source systems.
transactionSettledDatestringDate the transaction is settled. Format: MM-DD-YYYY
federalReferenceNumberstringFederal reference number
incomingReferenceNumberstringThe incoming reference number, which is provided by the sending bank.
currencyExchangeRatestringExchange rate
transactionExecutedDatestringDate the transaction is executed. Format: MM-DD-YYYY
bankToBankMemostringFree-form text transmitted between the banks.
transactionIdentifierstringTransaction identifier
originatingABAstringABA number of the wire originating bank.
originating2ABAstringAlternative or second ABA number of the wire originating bank.
originating3ABAstringAlternative or third ABA number of the wire originating bank.
beneficiaryBankArangeNumstringBeneficiary bank account number
beneficiaryABAstringBeneficiary ABA
originatingBankDebitBICstringOriginating bank debit BIC
originatingBankCreditBICstringOriginating bank credit BIC
NAMETYPEDESCRIPTION
accountNumberstringAccount number associated with the transaction.
transactionEffectiveDatestringEffective date of the transaction. Format: MM-DD-YYYY
creditOrDebitCodestringCode that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
transactionTypeCodestringThe banking processor code for a particular transaction type.
transactionAmountstringTransaction amount
transactionKeystring

An alphanumeric code that identifies a RTP or Wire transaction for the account.

transactionDescriptionstringBrief description of the transaction.
transactionSequenceNumberstringBatch sequence number of the transaction.
currentLedgerBalancePostTransactionstringCurrent ledger balance following the posting of this transaction.
currencyCodestringCurrency code of the transaction. Default value: USD
addendaInformationobjectaddendaInformation
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
DDATransactionsoptionalarrayddaTransactions
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status.
errorResponseObjecterrorResponse
NAMETYPEDESCRIPTION
transactionKeyrequiredarrayAn alphanumeric code that identifies a RTP or Wire transaction for the account.
accountNumberrequiredarrayUse 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.
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status.
errorResponseObjecterrorResponse
NAMETYPEDESCRIPTION
WiresDataobjectwiresData
NAMETYPEDESCRIPTION
accountNumberstringAccount number associated with the transaction.
transactionEffectiveDatestringEffective date of the transaction. Format: MM-DD-YYYY
dataLoadDatestringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
creditOrDebitCodestringCode that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
transactionTypestringThe banking processor code for a particular transaction type.
transactionAmountstringTransaction amount
transactionKeystringAn alphanumeric code that identifies a RTP or Wire transaction for the account.
transactionDescriptionstringBrief description of the transaction.
transactionSequenceNumberstringBatch sequence number of the transaction.
currentLedgerBalancePostTransactionstringCurrent ledger balance following the posting of this transaction.
snapshotDatestringSnapshot date. Format: MM-DD-YYYY
collectedCashAmountstringCollected cash amount
shortFloatAmountDay1stringDollar amount of short float for the current business day.
checkSerialNumberstringSerial number of the check.
traceIDstringSource transaction identifier
glSourceCodestringKeyBank-assigned GL source code
operatorIDstringOperator ID - free-form text field for use by sending application.
BAICodestringThe three-digit BAI (Bank Administration Institute) code for the transaction.
BAICodeDescstringProvides the description corresponding to a BAI code.
addendaInformationobjectddaTransactionsDetailsAddendaInformation
NAMETYPEDESCRIPTION
accountNumberstringAccount number associated with the transaction.
closingLedgerstringLedger balance in the account at the time of closure.
closingAvailablestringAmount available end of day for transactions.
shortFloatAmountDay0stringDollar amount of short float day 0.
shortFloatAmountDay1stringDollar amount of short float day 1.
shortFloatAmountDay2stringDollar amount of short float day 2.
shortFloatAmountDay3stringDollar amount of short float day 3.
shortFloatAmountDay4stringDollar amount of short float day 4.
shortFloatAmountDay5stringDollar amount of short float day 5.
shortFloatAmountDay6stringDollar amount of short float day 6.
reportDatestringDate the transaction posted. Format: MM-DD-YYYY
totalCreditsstringTotal credit transaction amount
totalDebitsstringTotal debit transaction amount
openingAvailablestringOpening available balance
achCreditsstringACH credits amount
depositsAmountstringDeposits amount
wireTransferCreditsstringWire transfer credits amount
zbaCreditsstringZBA credits amount
otherMiscCreditsstringOther miscellaneous credits amount
achDebitsstringACH debits amount
checksAmountstringChecks amount
returnedItemDebitsstringReturned item debits amount
wireTransferDebitsstringWire transfer debits amount
zbaDebitsstringZBA debits amount
otherMiscDebitsstringOther miscellaneous debits amount
totalAccountCreditsstringTotal account credits
totalAccountDebitsstringTotal account debits
achCreditCountstringACH credits count
depositsCountstringDeposits count
wireTransferCreditsCountstringWire transfer credits count
zbaCreditsCountstringZBA credits count
otherMiscCreditsCountstringOther miscellaneous credits count
achDebitsCountstringACH debits count
checksCountstringChecks count
returnedItemDebitsCountstringReturned item debits count
wireTransferDebitsCountstringWire transfer debits count
zbaDebitsCountstringZBA debits count
otherMiscDebitsCountstringOther miscellaneous debits count
totalCreditCountstringTotal credits count
totalDebitCountstringTotal debits count
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
DDATransactionsDetailsoptionalarrayddaTransactionsDetails
NAMETYPEDESCRIPTION
accountNumberrequiredarrayUse 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.
daterequiredstringDate for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeaders
DDAPrevDaySummaryoptionalarrayddaPrevDaySummary
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status.
errorResponseObjecterrorResponse
NAMETYPEDESCRIPTION
ErrorMessagestringA human-readable message that describes the type or source of the error.
TransactionIdstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimestringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-UrlstringThe API URL path in the call that generated the response.
ServiceErroroneOfServiceErrorData connectError
NAMETYPEDESCRIPTION
ConnectErrorstringAPI connectivity error information, if available.
NAMETYPEDESCRIPTION
businessFaultoptionalarraybusinessFault
systemFaultoptionalarraysystemFault
NAMETYPEDESCRIPTION
errorCodestringBusiness error code
errorDescriptionstringA human-readable message that describes the type or source of the business error.
NAMETYPEDESCRIPTION
errorCodestringSystem error code
errorDescriptionstringA human-readable message that describes the type or source of the system error.

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.

 

HTTP
STATUS CODE
CUSTOM
STATUS CODE
DESCRIPTION
200S

ECA-W-001 Transaction not found.

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

299W

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.

400F

ECA-W-001 Request Validation failed.

There is missing mandatory information like accountNumber, fromDate, or toDate. Review values for mandatory request fields.

400F

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.

 

October 2025

API Version: 1.3.2 | Impact: LOW

  • The ultParty parameter is required for On Behalf Of (OBO) payments. This means if you send a RTP transaction for another person, you need to identify the payer in this field. If there is no ultimate debtor, this field is optional.

September 2025

API Version: 1.3.1 | Impact: LOW

  • Replaced the parameter term KeyClientId with EPPId to help distinguish the difference between this unique ID and your private API keys.
  • 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.

June 2025

API Version: 1.3.0 | Impact: MID

  • Deprecated the status endpoints with the recent RTP and Wire Inquiry API enhancements. We recommend you use the /list or /detail paths to get an accurate status report on your transactions. 

    The following endpoints were deprecated:
    • /rtp/v1/payment/status/debitAccount/{debitAccount}/reference/{reference}
    • /rtp/v1/payment/status/transactionId/{transactionId}

April 2025

API Version: 1.2.6 | Impact: LOW

  • Added details to the party object for accountNumber and aba parameters. This applies to all party object except for debitParty and debitPartyBank as it pertains to wire transmissions.
  • Added Duplicate checks content to describe how the API checks for duplicate entries. We also identify what parameters must be unique to help prevent duplication issues.

December 2024

API Version: 1.2.5 | Impact: LOW

  • Enhanced the requirements and responses for party addresses.
  • has been replaced by the postalAddress object.
    • Added the following fields to postalAddress nested in the party object: adrTp, dept, subDept, strtNm, bldgNb, pstCd, twnNm, ctrySubDvsn, ctry.
    • For requests, you are required to complete the postalAddress fields for both the debitParty and creditParty.
    • Address information returns in the response if available.
  • Foreign payments are possible for RTP transactions. You can use the foreignBankSystemID to specify the type (five-digit routing code) and the id (ID number).

August 2024

API Version: 1.2.4 | Impact: MID

  • Added clarification to type parameter. For RTP the type can be PAYMENT or DRAFT. For wire transfers, the type will always be DRAFT.

May 2024

API Version: 1.2.3 | Impact: MID

  • KeyClientId is required for all endpoints, including GET calls.

March 2024

API Version: 1.2.1 | Impact: HIGH

  • Added 'IN_REVIEW' as a valid value for status in the paymentStatus object.
  • Added new parameters to paymentTransactionRequestV1:
    • bankToBankInstructions
    • debitPartyInstructions
    • intermediaryBank1
    • intermediaryBank2
    • intermediaryBank3
    • externalTemplateName
  • Added the clearingSystemReference in the paymentTransactionResponse object.
  • Added the following parameter to serviceErrorData:
    • receiversReference
    • debitAccountNumber
    • creditAccountNumber
  • Changed min/max limits for the following parameters:
    • requestReference and sendersReference changed from maxLength 35 to 32 with a minLength of 1.
    • Added parameter limits for originatorReference with a minLength of 1 and a maxLength of 35.
    • Added parameter limit for transferAmount with a maximum of 18 digits (which is like quintillion).
    • Added parameter limit for accountNumber in the party to a minLength of 1.
    • Added parameter limit for aba to a maxLength of 9 digits.
    • Added parameter limit for debitAccountNumber to a maxLength 34 characters.

September 2023

API Version: 1.1.5 | Impact: LOW

  • Parameter description updates. This change is for technical content only. The code and operations of the API remain the same.
  • Clarified the transactionId for RTP payments is the clearing system reference number.

December 2022

API Version: 1.1.3 

  • 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 download