Intraday Information Reporting

Intraday Information Reporting Endpoints

Summary	Endpoint
Health check	get /ddaReports/accounts/v1/healthCheck
Get a CDA summary report for the current day	post /ddaReports/accounts/v1/transactions/cda/summary
Get the current balance for one or more accounts	post /ddaReports/accounts/v1/transactions/current/balances

Overview

Intraday is an information reporting API that focuses on a single day's activity. Intraday information includes all memo transactions from the current day, such as deposit activity, CDA funding requirements, and incoming CDA checks.

What does that code mean?

We can't be expected to remember it all. Look at our Data values page to find definitions for BAI codes and transaction type codes.

Health check

get /ddaReports/accounts/v1/healthCheck

Verify you can connect to the API service. A bearer token is required.

Request

Responses

Successful response

NAME	TYPE	DESCRIPTION
Status	string	Status of the health check response.
Source	string	Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
Timestamp	string	Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIp	string	Client IP address the gateway receives from the request.
X-Forwarded-For	string	Sequence of 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 CDA summary report for the current day

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

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

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

{
    "getCDASummaryRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2021-10-08"
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
CDASummaryoptional	array	GetCDASummaryResult

Response example (200)

{
    "getCDASummaryResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully processed the request.",
            "dataLoadDate": "2022-07-05"
        },
        "CDASummary": [
            {
                "summary": {
                    "sourceArrangementNumber": "123456789",
                    "snapshotDate": "10\/08\/2021",
                    "sourceSystemOfRecordCode": "CDA",
                    "currencyCode": "USD",
                    "amount": "0",
                    "amountTypeCode": "602",
                    "FundTypeCode": "Z",
                    "itemCount": "0",
                    "processSequenceNumber": "1",
                    "earlyACHCredit": "0",
                    "earlyACHDebit": "3375.69"
                },
                "CDATransactionDetails": {
                    "transactionDate": "10\/08\/2021",
                    "snapshotDate": "10\/08\/2021",
                    "originatingFinancialInstitutionReferenceNumber": "1",
                    "transactionDescription": "CHECK 0000144872",
                    "transactionTypeCode": "475",
                    "fundTypeCode": "Z",
                    "amount": "3995.4",
                    "processSequenceNumber": "1"
                },
                "ACHMemoPost": {
                    "sourceArrangementNumber": "123456789",
                    "transactionProcessedDate": "10\/08\/2021",
                    "transactionAmount": "2307.42",
                    "transactionCreditDebitCode": "C",
                    "derivedBAICode": "165",
                    "transactionCode": "22",
                    "description1": "TEST MERCHANT DEPOSIT",
                    "description2": "896217706887",
                    "description3": "42930550001626 8 CAR",
                    "description4": "X IA TI",
                    "transactionPostingWindow": "0600"
                }
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "ServiceError": {
        "getCDASummaryResponse": {
            "responseHeader": {
                "status": "F",
                "statusDescription": "Request Validation failed.",
                "dataLoadDate": "2021-03-26",
                "retrivedRows": "1",
                "totalRows": "10"
            },
            "errorResponse": {
                "businessFault": [
                    {
                        "errorCode": "ECA-W-001",
                        "errorDescription": "Missing mandatory field(s) - accountNumber."
                    }
                ]
            }
        }
    }
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "ServiceError": {
        "getCDASummaryResponse": {
            "responseHeader": {
                "status": "F",
                "statusDescription": "Error Message from Backend Servers for unauthorized access",
                "dataLoadDate": "2021-03-26",
                "retrivedRows": "1",
                "totalRows": "10"
            },
            "errorResponse": {
                "businessFault": [
                    {
                        "errorCode": "ECA-W-001",
                        "errorDescription": "Error Message from Backend Servers for unauthorized access"
                    }
                ]
            }
        }
    }
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "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.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "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.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Get the current balance for one or more accounts

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

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

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 current balances are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

Request example

{
    "getCurrentBalancesRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2021-11-15"
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeader	Object	responseHeaders
CurrentBalancesoptional	array	GetCurrentBalancesResult

Response example (200)

{
    "getCurrentBalancesResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully processed the request."
        },
        "CurrentBalances": [
            {
                "currentBalances": {
                    "holds": "0.00",
                    "uncollectedFunds": "0.00",
                    "currentLedger": "3267948.16",
                    "currentAvailable": "3267948.16",
                    "openingAvailable": "3267948.16"
                }
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "ServiceError": {
        "getCurrentBalancesResponse": {
            "responseHeader": {
                "status": "F",
                "statusDescription": "Request Validation failed.",
                "dataLoadDate": "2021-03-26",
                "retrivedRows": "1",
                "totalRows": "10"
            },
            "errorResponse": {
                "businessFault": [
                    {
                        "errorCode": "ECA-W-001",
                        "errorDescription": "Missing mandatory field(s) - accountNumber."
                    }
                ]
            }
        }
    }
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "ServiceError": {
        "getCurrentBalancesResponse": {
            "responseHeader": {
                "status": "F",
                "statusDescription": "Error Message from Backend Servers for unauthorized access",
                "dataLoadDate": "2021-03-26",
                "retrivedRows": "1",
                "totalRows": "10"
            },
            "errorResponse": {
                "businessFault": [
                    {
                        "errorCode": "ECA-W-001",
                        "errorDescription": "Error Message from Backend Servers for unauthorized access"
                    }
                ]
            }
        }
    }
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "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.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "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.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance 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",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Schemas

healthResponse

NAME	TYPE	DESCRIPTION
Status	string	Status of the health check response.
Source	string	Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
Timestamp	string	Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIp	string	Client IP address the gateway receives from the request.
X-Forwarded-For	string	Sequence of IP addresses for systems between the client and the gateway.

Exception

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
X-CorrelationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
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.
ServiceError	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

connectError

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

ExceptionCDASummary

NAME	TYPE	DESCRIPTION
ExceptionCDASummary	object	GetCDASummaryResponseException

ExceptionCurrentBalance

NAME	TYPE	DESCRIPTION
ExceptionCurrentBalance	object	GetCurrentBalancesResponseException

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
transactionAmount	string	The amount of the wire transaction.

getIntraDayTransactionsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
IntraDayTransactionsoptional	array	IntraDayTransactions

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
retrivedRows	string	Total number of transactions retrieved.
totalRows	string	Total number of transactions matching the requested criteria.

GetIntraDayTransactionsResponseException

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
retrivedRows	string	Total number of transactions retrieved.
totalRows	string	Total number of transactions matching the requested criteria.
errorResponse	Object	ErrorResponse

LockboxTransactionData

NAME	TYPE	DESCRIPTION
DDAAccountNumber	string	DDA account number associated with lockbox.
processDate	string	Date the transaction was processed. Format: YYYY-MM-DD
lockboxGrpBankNumber	string	Not a KeyBank bank number. Used by lockbox application to group lockboxes.
lockboxNumber	string	Lockbox number
remittanceTransactionNumber	string	Transaction number
remittancePaidAmount	string	Remittance applied amount
paidAmount	string	Amount being paid by the payment record.
payerFinInstRoutingNum	string	Routing and transit number field from payment. This is the routing number of the payer account.
payerArrangementNum	string	Account number field from payment
checkSeqNumber	string	Check number from payment
floatAmountDay0	string	Lockbox float - amount available day 0
floatAmountDay1	string	Lockbox float - amount available day 1
floatAmountDay2	string	Lockbox float - amount available day 2

GetCurrentBalancesRequest

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 current balances are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

CurrentBalances

NAME	TYPE	DESCRIPTION
holds	string	Amount that is on hold
uncollectedFunds	string	Uncollected funds amount
currentLedger	string	Current ledger balance
currentAvailable	string	Current available balance
openingAvailable	string	Opening available balance

IntraDayTransactions

NAME	TYPE	DESCRIPTION
accountNumber	string	Account number associated with the transaction.
transactionEffectiveDate	string	Effective date of the transaction. Format: YYYY-MM-DD
transactionTypeId	string	Transaction type identifier
addendaInformation	Object	AddendaInformation

GetCurrentBalancesResponse

NAME	TYPE	DESCRIPTION
responseHeader	Object	responseHeaders
CurrentBalancesoptional	array	GetCurrentBalancesResult

GetCurrentBalancesResponseException

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
retrivedRows	string	Total number of transactions retrieved.
totalRows	string	Total number of transactions matching the requested criteria.
errorResponse	Object	ErrorResponse

LockboxData

NAME	TYPE	DESCRIPTION
lockboxNumber	string	Lockbox number
lockboxName	string	Lockbox name
lockboxGrpNumber	string	Lockbox grouping number
lockboxGrpName	string	Lockbox grouping name
firstContactName	string	First contact name defined in lockbox contacts
firstContactStreetAddr	string	Street address for named contact
firstContactCity	string	City for named contact
firstContactState	string	State for named contact
firstContactPostalCode	string	Zip code for named contact
firstDepositTransitNumber	string	Transit number for named contact
customDataField1	string	Custom data field

ErrorResponse

NAME	TYPE	DESCRIPTION
businessFaultoptional	array	BusinessFault
systemFaultoptional	array	SystemFault

GetIntraDaySummaryResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDAIntraDaySummaryoptional	array	GetIntraDaySummaryResult

GetIntraDaySummaryResponseException

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
errorResponse	Object	ErrorResponse

RTPData

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
transactionAmount	string	The amount of the RTP transaction.

GetCurrentBalancesResult

NAME	TYPE	DESCRIPTION
currentBalances	Object	CurrentBalances

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.

GetCDASummaryRequest

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

OLDSData

NAME	TYPE	DESCRIPTION
bankNumber	string	Bank number associated with the account number.
transactionTypeId	string	Four-digit transaction type identifier.
srcArrangementNumber	string	Can be any account number, DDA, loan account, credit card, or savings.
transactionEffDate	string	Effective date of the transaction. Format: YYYY-MM-DD
transactionAmount	string	Transaction amount
transactionTypeCode	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
reversalFlag	string	Denotes if the transaction is a reversal transaction of an earlier transaction.
transactionSrcCode	string	Identifies the source of the transaction.
transactionDescription	string	Brief description of the transaction.
traceId	string	Source transaction identifier
transactionCodeBAI2	string	BAI2 transaction code

getIntraDayTransactionsRequest

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 list of transactions is to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD
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 can't exceed more than 1000 records from the startRowIndex.

Summary

NAME	TYPE	DESCRIPTION
sourceArrangementNumber	string	Account number
snapshotDate	string	Date that requested data was loaded. Format: MM-DD-YYYY
sourceSystemOfRecordCode	string	This field is for internal purposes only.
currencyCode	string	Currency code of the transaction. Default value: USD
amount	string	Transaction amount
amountTypeCode	string	Code associated with the transaction amount. Valid values: 580 (Total Controlled Disbursing Debits), 584 (Total Disbursing Checks Paid Later Amount), 602 (Total Adjustments), 585 (Required Funding Amount)
FundTypeCode	string	Code associated with the fund type.
itemCount	string	Total number of transactions
processSequenceNumber	string	Sequence number of the transaction.
earlyACHCredit	string	Total credit amount as of the 6:00 a.m. EST posting window.
earlyACHDebit	string	Total debit amount as of 0600 posting window.

CPCSData

NAME	TYPE	DESCRIPTION
transactionPostedDate	string	Date the transaction posted. Format: MM-DD-YYYY
sourceArrangementNumber	string	Account number
transactionDescriptionPart1	string	Description of transaction, part 1
transactionDescriptionPart2	string	Description of transaction, part 2
transactionDescriptionPart3	string	Description of transaction, part 3
regulationEDescription	string	Regulation E description
transactionDescription2	string	Description of transaction
transactionEffectiveDate	string	Effective date of the transaction. Format: YYYY-MM-DD
transactionActionCode	string	Transaction action identifier
transactionAmount	string	Transaction amount
cashAmount	string	Cash part of transaction amount
checkIdentificationNumber	string	Can contain serial number of item or store number for identification purposes.
float0Amount	string	Float 0 amount
float1Amount	string	Float 1 amount
float2Amount	string	Float 2 amount
float3Amount	string	Float 3 amount
float4Amount	string	Float 4 amount
float5Amount	string	Float 5 amount
float6Amount	string	Float 6 amount
float7Amount	string	Float 7 amount
priorDateFlag	string	If the transaction date is prior to the current business date then this is set to "P".
creditOrDebitCode	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
traceID	string	Source transaction identifier

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.

GetCDASummaryResult

NAME	TYPE	DESCRIPTION
summary	Object	Summary
CDATransactionDetails	Object	CDATransactionDetails
ACHMemoPost	Object	ACHMemoPost

GetCDASummaryResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
CDASummaryoptional	array	GetCDASummaryResult

GetCDASummaryResponseException

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
retrivedRows	string	Total number of transactions retrieved.
totalRows	string	Total number of transactions matching the requested criteria.
errorResponse	Object	ErrorResponse

AddendaInformation

NAME	TYPE	DESCRIPTION
WiresData	Object	WiresData
OLDSData	Object	OLDSData
LockboxData	Object	LockboxData
LockboxTransactionData	Object	LockboxTransactionData
CPCSData	Object	CPCSData
ACHTransactionData	Object	ACHTransactionData
RTPData	Object	RTPData

ACHTransactionData

NAME	TYPE	DESCRIPTION
sourceArrangementNumber	string	Account number
transactionProcessedDate	string	Date the transaction was processed. Format: YYYY-MM-DD
transactionAmount	string	Transaction amount
transactionCreditDebitCode	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
derivedBAICode	string	BAI2 transaction code
transactionCode	string	Two-digit code identifying the account type at the receiving financial institution.
description1	string	Brief description of the transaction.
description2	string	Brief description of the transaction.
description3	string	Brief description of the transaction.
description4	string	Brief description of the transaction.
transactionPostingWindow	string	Posting window of the transaction.

GetIntraDaySummaryRequest

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

GetIntraDaySummaryResult

NAME	TYPE	DESCRIPTION
earlyACHCredit	string	Total credit amount as of 0600 posting window.
earlyACHCreditCount	string	Total number of ACH credit transactions as of 0600 posting window.
lateACHCredit	string	Total credit amount from posting windows other than 0600.
lateACHCreditCount	string	Total number of ACH credit transactions from posting windows other than 0600.
lockboxCredit	string	Total credit amount of lockbox transactions.
lockboxCreditCount	string	Total number of lockbox credit transactions.
wireTransferCredit	string	Total credit amount of wire transfer transactions.
wireTransferCreditCount	string	Total number of wire transfer credit transactions.
depositsCredit	string	Total credit amount through deposits.
otherMiscCredit	string	Other miscellaneous credit amounts.
otherMiscCreditCount	string	Total number of miscellaneous credit transactions.
totalCredit	string	Total credit amount from memo post, lockbox, wires, OLDS, and CPCS transactions.
totalCreditCount	string	Total number of credits from memo post, lockbox, wires, OLDS, and CPCS transactions.
earlyACHDebit	string	Total debit amount as of 0600 posting window.
earlyACHDebitCount	string	Total number of ACH debit transactions as of 0600 posting window.
lateACHDebit	string	Total debit amount from posting windows other than 0600.
lateACHDebitCount	string	Total number of ACH debit transactions from posting windows other than 0600.
wireTransferDebit	string	Total debit amount of wire transfer transactions.
wireTransferDebitCount	string	Total number of wire transfer debit transactions.
otherMiscDebit	string	Other miscellaneous debit amounts.
otherMiscDebitCount	string	Total number of miscellaneous debit transactions.
totalDebit	string	Total debit amount from memo post, lockbox, wires, OLDS, and CPCS transactions.
totalDebitCount	string	Total number of debits from memo post, lockbox, wires, OLDS, and CPCS transactions.
srcBankNum	string	Source bank number
srcSysCode	string	Source system code
currentBalances	Object	GetCurrentBalancesResult

CDATransactionDetails

NAME	TYPE	DESCRIPTION
transactionDate	string	Date the transaction posted. Format: MM-DD-YYYY
snapshotDate	string	Date that requested data was loaded. Format: MM-DD-YYYY
originatingFinancialInstitutionReferenceNumber	string	Reference number of the originating financial institution.
currencyCode	string	Currency code of the transaction. Default value: USD
transactionDescription	string	Brief description of the transaction.
transactionTypeCode	string	The banking processor code for a particular transaction type.
fundTypeCode	string	Code associated with the fund type.
amount	string	Transaction amount
customerReferenceNumber	string	Reference number attached to the customer.
processSequenceNumber	string	Sequence number of the transaction.

ACHMemoPost

NAME	TYPE	DESCRIPTION
sourceArrangementNumber	string	Account number
transactionProcessedDate	string	Date the transaction was processed. Format: YYYY-MM-DD
transactionAmount	string	Transaction amount
transactionCreditDebitCode	string	Code that indicates if the transaction is a credit (C) or a debit (D). Valid values: C, D
derivedBAICode	string	The three-digit BAI2 code identifies the activity or balance being reported.
transactionCode	string	Two-digit code identifying the account type at the receiving financial institution.
description1	string	Brief description of the transaction.
description2	string	Brief description of the transaction.
description3	string	Brief description of the transaction.
description4	string	Brief description of the transaction.
transactionPostingWindow	string	Posting window of the transaction.

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.

API specific KeyBank 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
March 2025	1.2.7	Updated the `accountNumber` description with recommendation to use one account number per call. Endpoints `/transactions/intraday/list` and `/transactions/intraday/summary` will be deprecated. These endpoints are removed from the Developer Portal page. The specifications still have these endpoints.	LOW
May 2024	1.2.6	`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.	LOW
April 2024	1.2.5	Parameter description updates. This change is for technical content only. The code and operations of the API remain the same.	LOW
February 2024	1.2.4	Added `transactionAmount` to the `WiresData` object.	LOW
March 2024	1.2.3	In the `AddendaInformation`, the `ACHTransactionData` object now matches the ACH Memo posted fields. Many parameters were removed and some were added. Added the following parameters: `sourceArrangementNumber` `transactionProcessedDate` `transactionAmount` `transactionCreditDebitCode` `derivedBAICode` `transactionCode (remained)` `description1` `description2` `description3` `description4` `transactionPostingWindow` Removed the following parameters: `addendaPresentFlag` `nachaBatchNumber` `checkSerialNumber` `transactionDescription1` `originatingCompanyIDNumber` `originatingCompanyName` `creditOrDebitCode` `originatingReceiverCode` `SourceTransactionProcessedDate` `receivingArrangementNumber` `sourceTransactionPostedDate` `nachaFileReferenceNumber` `collectionPoint` `goRoutingNumber` `receivingCustomerIDNumber` `receivingCustomerName` `receivingCompanyName` `addendaRecordNumber` `originatingCustomerName` `originatingFinancialInstitutionRoutingNumber` `authorisedCustomerName` `originatingArrangementNumber` `receivingFinancialInstitutionBankNumber` `receivingFinancialInstitutionRoutingNumber` `nachaStandardEntryClassCode` `transactionPARNumber` `sourceTransactionSettledDate` `inboundCollectionWindow` `IATFlag` `transactionTraceID` `originatingFinancialInstitutionBankNumber`	MID
December 2023	1.2.2	Deprecated the `mdmID` parameter. Backend services and processes have been enhanced to authenticate client API calls without the need for an MDM ID. Removed the following parameter: `sourceTransactionProcessedDate` `sourceTransactionPostedDate` `sourceTransactionSetteledDate`	MID
September 2023	1.2.1	The `mdmId` description has been updated to communicate that this parameter will soon deprecate in an upcoming release. Added date format YYYY-MM-DD to date parameters where applicable.	LOW
August 2023	1.2.0	Updated the `IntraDayTransaction`, `addendaInformation`, `RTPData` , and `WiresData` objects. Each addenda object now include the `transactionAmount` parameter. You can now utilize the Wire and RTP transaction amounts for reconciliation and other business purposes when making an intraday inquiry for a single day. Removed unused objects in the following: `ErrorTemplate` `Links` `Source` `IntraDayTransactionsResult`	MID
July 2023	1.1.2	The MDM ID (`mdmID`) is no longer a required parameter, it is now optional.	MID
May 2023	1.1.1	Deprecated the following parameters from the response payload: `validRequest` `noResult` `warningFlag` `Errors` `Output` `Services` Move the `systemFault` to the `errorResponse` 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