Previous Day Reporting

2-minute read 1.2.5 | updated May. 29, 2024

Run reports for posted transactions

Previous Day Reporting Endpoints

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

Before you begin

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

Overview

Previous Day is an information reporting API that returns posted transactions like deposit activity, paid checks, ACH debits and credits, wires, and ACH and wire transactions together in one report.

What does that code mean?

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

Health check

get /ddaReports/accounts/v1/healthCheck

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

Responses

Successful response

NAME	TYPE	DESCRIPTION
Statusoptional	string	Status of the health check response.
Sourceoptional	string	Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
Timestampoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIpoptional	string	Client IP address the gateway receives from the request.
X-Forwarded-Foroptional	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 list of transactions for a historical date range

post /ddaReports/accounts/v1/transactions/list

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

Request

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

Request example

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

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDATransactionsoptional	array	ddaTransactions

Response example (200)

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

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (400)

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

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (401)

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

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (403)

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

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (404)

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

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (415)

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

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (429)

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

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (500)

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

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (503)

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

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (504)

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

Get a detailed transaction report

post /ddaReports/accounts/v1/transactions/details

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

Request

BODY FIELD	TYPE	DESCRIPTION
transactionKeyrequired	array	The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated.
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.

Request example

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

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDATransactionsDetailsoptional	array	ddaTransactionsDetails

Response example (200)

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

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (400)

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

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (401)

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

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (403)

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

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (404)

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

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (415)

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

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (429)

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

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (500)

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

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (503)

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

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (504)

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

Get an account summary report for a single historical date

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

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

Request

BODY FIELD	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

Request example

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

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDAPrevDaySummaryoptional	array	ddaPrevDaySummary

Response example (200)

{
    "getDDAPrevDaySummaryResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully processed the request.",
            "dataLoadDate": "2022-05-10",
            "summaryTotal": {
                "totalClosingLedger": "42.21",
                "totalClosingAvailable": "42.21",
                "totalFloatDay1": "0.0",
                "totalFloatDay2": "0.0",
                "sumTotalCredits": "2.22",
                "sumTotalDebits": "0.02",
                "totalOpeningAvailable": "42.21"
            }
        },
        "DDAPrevDaySummary": [
            {
                "accountNumber": "123456789",
                "arrangementName": "TEST COMPANY 1, LLC",
                "closingLedger": "42.21",
                "closingAvailable": "42.21",
                "shortFloatAmountDay0": "0",
                "shortFloatAmountDay1": "0",
                "shortFloatAmountDay2": "0",
                "shortFloatAmountDay3": "0",
                "shortFloatAmountDay4": "0",
                "shortFloatAmountDay5": "0",
                "shortFloatAmountDay6": "0",
                "reportDate": "07\/18\/2022",
                "totalCredits": "2.22",
                "totalDebits": "0.02",
                "openingAvailable": "42.21",
                "achCredits": "0",
                "depositsAmount": "0",
                "wireTransferCredits": "0.21",
                "zbaCredits": "0",
                "otherMiscCredits": "2.01",
                "achDebits": "0",
                "checksAmount": "0",
                "returnedItemDebits": "0",
                "wireTransferDebits": "0.01",
                "zbaDebits": "0",
                "otherMiscDebits": "0.01",
                "totalAccountCredits": "2.22",
                "totalAccountDebits": "0.02",
                "achCreditCount": "0",
                "depositsCount": "0",
                "wireTransferCreditsCount": "4",
                "zbaCreditsCount": "0",
                "otherMiscCreditsCount": "3",
                "achDebitsCount": "0",
                "checksCount": "0",
                "returnedItemDebitsCount": "0",
                "wireTransferDebitsCount": "1",
                "zbaDebitsCount": "0",
                "otherMiscDebitsCount": "1",
                "totalCreditCount": "7",
                "totalDebitCount": "2"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (400)

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

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (401)

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

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (403)

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

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (404)

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

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (415)

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

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (429)

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

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (500)

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

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (503)

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

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

Response example (504)

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

Schemas

addendaInformation

NAME	TYPE	DESCRIPTION
WiresDataoptional	object	wiresData

businessFault

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

connectError

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

ddaPrevDaySummary

NAME	TYPE	DESCRIPTION
accountNumberoptional	string	Account number associated with the transaction.
closingLedgeroptional	string	Ledger balance in the account at the time of closure.
closingAvailableoptional	string	Amount available end of day for transactions.
shortFloatAmountDay0optional	string	Dollar amount of short float day 0.
shortFloatAmountDay1optional	string	Dollar amount of short float day 1.
shortFloatAmountDay2optional	string	Dollar amount of short float day 2.
shortFloatAmountDay3optional	string	Dollar amount of short float day 3.
shortFloatAmountDay4optional	string	Dollar amount of short float day 4.
shortFloatAmountDay5optional	string	Dollar amount of short float day 5.
shortFloatAmountDay6optional	string	Dollar amount of short float day 6.
reportDateoptional	string	Date the transaction posted. Format: MM-DD-YYYY
totalCreditsoptional	string	Total credit transaction amount
totalDebitsoptional	string	Total debit transaction amount
openingAvailableoptional	string	Opening available balance
achCreditsoptional	string	ACH credits amount
depositsAmountoptional	string	Deposits amount
wireTransferCreditsoptional	string	Wire transfer credits amount
zbaCreditsoptional	string	ZBA credits amount
otherMiscCreditsoptional	string	Other miscellaneous credits amount
achDebitsoptional	string	ACH debits amount
checksAmountoptional	string	Checks amount
returnedItemDebitsoptional	string	Returned item debits amount
wireTransferDebitsoptional	string	Wire transfer debits amount
zbaDebitsoptional	string	ZBA debits amount
otherMiscDebitsoptional	string	Other miscellaneous debits amount
totalAccountCreditsoptional	string	Total account credits
totalAccountDebitsoptional	string	Total account debits
achCreditCountoptional	string	ACH credits count
depositsCountoptional	string	Deposits count
wireTransferCreditsCountoptional	string	Wire transfer credits count
zbaCreditsCountoptional	string	ZBA credits count
otherMiscCreditsCountoptional	string	Other miscellaneous credits count
achDebitsCountoptional	string	ACH debits count
checksCountoptional	string	Checks count
returnedItemDebitsCountoptional	string	Returned item debits count
wireTransferDebitsCountoptional	string	Wire transfer debits count
zbaDebitsCountoptional	string	ZBA debits count
otherMiscDebitsCountoptional	string	Other miscellaneous debits count
totalCreditCountoptional	string	Total credits count
totalDebitCountoptional	string	Total debits count

DDAPrevDaySummaryRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

DDAPrevDaySummaryResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDAPrevDaySummaryoptional	array	ddaPrevDaySummary

DDAPrevDaySummaryResponseError

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

ddaTransactions

NAME	TYPE	DESCRIPTION
accountNumberoptional	string	Account number associated with the transaction.
transactionEffectiveDateoptional	string	Effective date of the transaction. Format: MM-DD-YYYY
creditOrDebitCodeoptional	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
transactionTypeCodeoptional	string	The banking processor code for a particular transaction type.
transactionAmountoptional	string	Transaction amount
transactionKeyoptional	string	An alphanumeric code used to keep the transaction activity secure.
transactionDescriptionoptional	string	Brief description of the transaction.
transactionSequenceNumberoptional	string	Batch sequence number of the transaction.
currentLedgerBalancePostTransactionoptional	string	Current ledger balance following the posting of this transaction.
currencyCodeoptional	string	Currency code of the transaction. Default value: USD
addendaInformationoptional	object	addendaInformation

ddaTransactionsDetails

NAME	TYPE	DESCRIPTION
accountNumberoptional	string	Account number associated with the transaction.
transactionEffectiveDateoptional	string	Effective date of the transaction. Format: MM-DD-YYYY
dataLoadDateoptional	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD
creditOrDebitCodeoptional	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
transactionTypeoptional	string	The banking processor code for a particular transaction type.
transactionAmountoptional	string	Transaction amount
transactionKeyoptional	string	An alphanumeric code used to keep the transaction activity secure.
transactionDescriptionoptional	string	Brief description of the transaction.
transactionSequenceNumberoptional	string	Batch sequence number of the transaction.
currentLedgerBalancePostTransactionoptional	string	Current ledger balance following the posting of this transaction.
snapshotDateoptional	string	Snapshot date. Format: MM-DD-YYYY
collectedCashAmountoptional	string	Collected cash amount
shortFloatAmountDay1optional	string	Dollar amount of short float for the current business day.
checkSerialNumberoptional	string	Serial number of the check.
traceIDoptional	string	Source transaction identifier
glSourceCodeoptional	string	KeyBank-assigned GL source code
operatorIDoptional	string	Operator ID - free-form text field for use by sending application.
BAICodeoptional	string	The three-digit BAI (Bank Administration Institute) code for the transaction.
BAICodeDescoptional	string	Provides the description corresponding to a BAI code.
addendaInformationoptional	object	ddaTransactionsDetailsAddendaInformation

ddaTransactionsDetailsAddendaInformation

NAME	TYPE	DESCRIPTION
WiresDataoptional	object	wiresData

DDATransactionsDetailsRequest

NAME	TYPE	DESCRIPTION
transactionKeyrequired	array	The alphanumeric code used to keep the transaction activity secure. Multiple transactionKeys can be comma separated.
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.

DDATransactionsDetailsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDATransactionsDetailsoptional	array	ddaTransactionsDetails

DDATransactionsDetailsResponseError

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

DDATransactionsRequest

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

DDATransactionsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDATransactionsoptional	array	ddaTransactions

DDATransactionsResponseError

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

errorResponse

NAME	TYPE	DESCRIPTION
businessFaultoptional	array	businessFault
systemFaultoptional	array	systemFault

Exception

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ServiceErrorData connectError

healthResponse

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

responseHeaders

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

ServiceErrorData

NAME	TYPE	DESCRIPTION
ServiceErrorDataoptional	oneOf	DDATransactionsResponseError DDATransactionsDetailsResponseError DDAPrevDaySummaryResponseError

SummaryTotal

NAME	TYPE	DESCRIPTION
totalClosingLedgeroptional	string	Sum of all account-level closing ledger balances.
totalClosingAvailableoptional	string	Sum of all account-level closing available balances.
totalFloatDay1optional	string	Sum of all account-level 1 day float.
totalFloatDay2optional	string	Sum of all account-level 2 day float.
sumTotalCreditsoptional	string	Sum of all account-level total credits.
sumTotalDebitsoptional	string	Sum of all account-level total debits.
totalOpeningAvailableoptional	string	Sum of all account-level opening available balances.

systemFault

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

wiresData

NAME	TYPE	DESCRIPTION
creditArrangementTypeCodeoptional	string	Credit account type code
creditArrangementBankNumberoptional	string	Bank number holding the credit account.
creditArrangementBankBranchoptional	string	Bank branch holding the credit account.
creditArrangementCurrencyCodeoptional	string	Transaction currency code of the credit account.
creditInvolvedPartyIdentifieroptional	string	Customer number associated with the credit account.
creditInvolvedPartyNameoptional	string	Customer name associated with the credit account.
creditArrangementCountryCodeoptional	string	Country of the credit account.
creditInvolvedPartyTypeCodeoptional	string	Customer type associated with the credit account.
debitArrangementTypeCodeoptional	string	Debit account type code
debitArrangementBankNumberoptional	string	Bank number holding the debit account.
debitArrangementBankBranchoptional	string	Bank branch holding the debit account.
debitArrangementCurrencyCodeoptional	string	Transaction currency code of the debit account.
debitInvolvedPartyIdentifieroptional	string	Customer number associated with the debit account.
debitInvolvedPartyNameoptional	string	Customer name associated with the debit account.
transactionBusinessStatusCodeoptional	string	Transaction business status code
sendingBankReferenceNumberoptional	string	Reference number attached to a wire, issued by the sending bank.
originatingInvolvedPartyNameoptional	string	Name of the wire transaction originator.
originatingArrangementNumberoptional	string	Account number of the wire transaction originator.
originatingInvolvedPartyAddressLine1optional	string	Address line 1 of the wire transaction originator.
originatingInvolvedPartyAddressLine2optional	string	Address line 2 of the wire transaction originator.
beneficiaryInvolvedPartyNameoptional	string	Beneficiary of the wire payment.
beneficiaryArrangementNumberoptional	string	Account number of the beneficiary.
beneficiaryInvolvedPartyAddressLine1optional	string	Address line 1 of the beneficiary.
beneficiaryInvolvedPartyAddressLine2optional	string	Address line 2 of the beneficiary.
intermediaryBankNameoptional	string	Name of the intermediary bank.
intermediaryBankABANumberoptional	string	ABA number of the intermediary bank.
intermediaryBICCodeoptional	string	BIC number of the intermediary bank.
intermediaryBankAddressLine1optional	string	Address line 1 of the intermediary bank.
intermediaryBankAddressLine2optional	string	Address line 2 of the intermediary bank.
originatingBankNameoptional	string	Name of the wire originating bank.
originatingBankABANumberoptional	string	ABA number of the wire originating bank.
originatingBankBICcodeoptional	string	BIC number of the wire originating bank.
originatingBankAddressLine1optional	string	Address line 1 of the wire originating bank.
originatingBankAddressLine2optional	string	Address line 2 of the wire originating bank.
beneficiaryBankNameoptional	string	Name of the beneficiary bank.
beneficiaryBankABANumberoptional	string	ABA number of the beneficiary bank.
beneficiaryBankBICcodeoptional	string	BIC number of the beneficiary bank.
beneficiaryBankAddressLine1optional	string	Address line 1 of the beneficiary bank.
beneficiaryBankAddressLine2optional	string	Address line 2 of the beneficiary bank.
sourceTransactionIdentifieroptional	string	End-to-end ID to uniquely identify a transaction in source systems.
transactionSettledDateoptional	string	Date the transaction is settled. Format: MM-DD-YYYY
federalReferenceNumberoptional	string	Federal reference number
incomingReferenceNumberoptional	string	The incoming reference number, which is provided by the sending bank.
currencyExchangeRateoptional	string	Exchange rate
transactionExecutedDateoptional	string	Date the transaction is executed. Format: MM-DD-YYYY
bankToBankMemooptional	string	Free-form text transmitted between the banks.
transactionIdentifieroptional	string	Transaction identifier
originatingABAoptional	string	Originating ABA
originating2ABAoptional	string	Originating 2 ABA
originating3ABAoptional	string	Originating 3 ABA
beneficiaryBankArangeNumoptional	string	Beneficiary bank account number
beneficiaryABAoptional	string	Beneficiary ABA
originatingBankDebitBICoptional	string	Originating bank debit BIC
originatingBankCreditBICoptional	string	Originating bank credit BIC

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.

YAML file

ACH Inquiry

4-minute read 1.2.2 | updated Sep. 15, 2024

Get the status for your ACH transactions

Use the ACH Inquiry API to get the status on ACH transactions based on your query criteria. For clients with a non-consolidated settlement, you can receive collected (in progress), posted (processed), and returned transactions. For clients with a consolidated settlement, you only receive collected and returned transactions. Posted transactions is not an available status for consolidated settlement.

ACH Inquiry Endpoints

In an upcoming release of ACH Inquiry API v2, only the /ach/list and /ach/detail/{parNumber} search will be available for ACH inquiry requests. This is an advanced design that allows you to perform a neutral search (regardless of transaction status) for a specific payment and get the details.

We recommend that you use the following endpoints below your ACH queries.

What you can do	Endpoint
Health check	get /accounts/transactions/v1/healthCheck
Search for ACH transactions	post /accounts/transactions/v1/ach/list
Search for ACH transaction details	get /accounts/transactions/v1/ach/detail/{parNumber}

Before you begin

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

Overview

You can use the ACH Inquiry API to get the status for ACH transactions as they are received and processed by KeyBank.

The consolidation settlement type affect what information is returned. The ACHStatus field defines the status of the transaction as in progress (COLLECTED), processed (SETTLED), or returned (RETURNED).

For clients with a non-consolidated settlement, you can receive information about collected, settled, and returned transactions.
For clients with a consolidated settlement, you will only receive collected and returned transactions. SETTLED is not an available status for consolidated settlement.

PAR-don me

ACH inquiries require a parNumber or traceNumber for inquiries. Learn more in our ACH APIs User Guide.

Health check

get /accounts/transactions/v1/healthCheck

Verify you can connect to the API service.

Request

Responses

Successful response

NAME	TYPE	DESCRIPTION
Statusoptional	string	Status of the health check response.
Sourceoptional	string	System producing the health response. Genesis of the response could either be just from “gateway” or “roundtrip” from the farthest possible system involved in generating this response.
Timestampoptional	string	Timestamp when the health response is being returned by this service.
ClientIpoptional	string	IP of the client from which this request for health check is received by the gateway.
X-Forwarded-Foroptional	string	Sequence of all the Ips of the systems involved 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]"
}

Search for ACH transactions

post /accounts/transactions/v1/ach/list

Search for ACH transactions by passing certain search parameters. With ACH transactions, each status point has a start and end date. If you search using the fromDate and toDate parameters, use the dateSearchType to identify if it is the start and end date for when the transaction was collected, returned, or settled. If you leave the dateSearchType field blank, the request only searches the date range for collected transactions.

You can search up to 2 years of past records. We recommend that your date search range does not exceed 31 days.

Request

NAME	TYPE	DESCRIPTION
accountNumberrequired	string	The bank account number. This field cannot exceed 16 characters.
dateSearchTypeoptional	string	Each ACH transaction status has an associated date range. Indicate the specific transaction date set to search. If left blank, the search defaults to collected transaction dates. Valid values: COLLECTED, RETURNED, SETTLED
fromDateoptional	string	Start date for the date range. This date must be the current date or prior to the current date. Transaction data can be recalled within 180 days of the current date. Format: YYYY-MM-DD
toDateoptional	string	End date for the date range. This date can be the current day or a later date from the start date (fromDate). The date range should not exceed 31 days. Format: YYYY-MM-DD
minimumAmountoptional	string	The minimum dollar amount of the transaction. This amount must be less than or equal to the maximum amount. Leave blank or enter zero for no minimum amount.
maximumAmountoptional	string	The maximum dollar amount of the transaction. This amount must be greater than or equal to the minimum amount. Leave blank to retrieve all amounts. This amount cannot exceed one billion dollars.
traceNumberoptional	string	The unique number for the transaction provided by the originator.
pageNumberoptional	string	The number of the page being viewed. This number must be greater than or equal to 1.
pageSizeoptional	string	The total number of pages returned. This number must be greater than or equal to 1 and cannot exceed 1000.

Request example

{
    "accountNumber": "3123456789",
    "dateSearchType": "COLLECTED",
    "fromDate": "2024-03-15",
    "toDate": "2024-03-15",
    "minimumAmount": 100,
    "maximumAmount": 75020.5,
    "traceNumber": "041001030016002",
    "pageNumber": 1,
    "pageSize": 150
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
transactionsoptional	string	AchListTransaction
metadataoptional	string	Metadata

Response example (200)

{
"transactions": [{
  "parNumber": "22018007665985",
  "transactionStatus": "COLLECTED",
  "traceNumber": "000000000000000",
  "transactionAmount": 10.01,
  "settlementDate": "2024-03-15",
  "transactionCode": "22",
  "authorizedCustomerName": "TEST CUSTOMER1",
  "standardEntryClassCode": "CCD",
  "receivingAccount": {
    "accountNumber": "123456789012"
    },
  "receivingParty": {
    "customerIdentificationNumber": "099999999",
    "companyName": "MERCHANT"
    },
  "originatingAccount": {
    "accountNumber": "123456789012"
    },
  "originatingParty": {
    "customerIdentificationNumber": "1234567",
    "companyName": "COMPANY NAME 1"
    },
  "returnDate": "2024-02-01",
  "returnReasonCode": "R02",
  "returnReasonDescription": "Account Closed",
  "addendaCount": 1,
  "notificationOfChangeAddendaCount": 1,
  "internationalAddendaCount": 0
  }],
"metadata": {
  "messages": [{
    "code": "099",
    "message": "Search results match the criteria"
    }],
"page": {
  "pageNumber": 1,
  "pageSize": 10,
  "totalPages": 10,
  "totalRecords": 28,
  "lastPage": true
  }
}}

Bad input parameter

NAME	TYPE	DESCRIPTION
metadataoptional	string	Metadata

Response example (400)

{
"metadata": {
  "messages": [{
    "code": "001",
    "message": "There are no transactions that match the parNumber."
    }],
"page": {
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalRecords": 0,
  "lastPage": false
  }
}}

Get details about an ACH transaction with a PAR number

get /accounts/transactions/v1/ach/detail/{parNumber}

Use the PAR number to retrieve information about an ACH transaction.

Request

path FIELD	TYPE	DESCRIPTION
parNumberrequired	string	The unique PAR number assigned to the the transaction by the ACH product processor.

Responses

Successful response

NAME	TYPE	DESCRIPTION
parNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
transactionStatusoptional	string	The status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED
traceNumberoptional	string	The unique number for the transaction provided by the originator.
transactionAmountoptional	number	The dollar amount of the transaction.
settlementDateoptional	string	The date the transaction settlement occurred. Format: YYYY-MM-DD
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptional	string	Description for the transaction code.
transactionDescriptionoptional	string	Description about the purpose of the transaction.
authorizedCustomerNameoptional	string	Authorized customer name
standardEntryClassCodeoptional	string	The three-digit Standard Entry Class code based on Nacha rules.
standardEntryClassDescriptionoptional	string	The description for the Nacha SEC code.
receivingAccountoptional	Object	AccountDetail
receivingPartyoptional	Object	PartyDetail
originatingAccountoptional	Object	AccountDetail
originatingPartyoptional	Object	PartyDetail
returnDateoptional	string	Date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptional	string	The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00
returnReasonDescriptionoptional	string	Description as to why the ACH transaction is returned.
addendaCountoptional	integer	Count of addenda records.
notificationOfChangeAddendaCountoptional	integer	Count of change notifications for addenda records.
internationalAddendaCountoptional	integer	Count of international addenda records.
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.
checkSerialNumberoptional	string	Serial number for the check converted to an ACH transaction.
transactionDirectionoptional	string	Indicates the direction of the transaction. Valid values: ORIGINATING ITEM, RECEIVING ITEM
addendaoptional	array	Addendum
notificationOfChangeoptional	array	NotificationOfChange

Response example (200)

{
    "parNumber": "22018007665985",
    "transactionStatus": "COLLECTED",
    "traceNumber": "000000000000000",
    "transactionAmount": 10.01,
    "settlementDate": "2021-03-08",
    "transactionCode": "22",
    "transactionCodeDescription": "Automated Deposit",
    "transactionDescription": "DEPOSIT",
    "authorizedCustomerName": "TEST CUSTOMER1",
    "standardEntryClassCode": "CCD",
    "standardEntryClassDescription": "Cash Concentration or Disbursement",
    "receivingAccount": {
        "accountNumber": "123456789012",
        "bankNumber": "0000",
        "routingNumber": "1234567890"
    },
    "receivingParty": {
        "customerIdentificationNumber": "099999999",
        "companyName": "MERCHANT",
        "customerName": "TEST MERCHANT"
    },
    "originatingAccount": {
        "accountNumber": "123456789012",
        "bankNumber": "0000",
        "routingNumber": "1234567890"
    },
    "originatingParty": {
        "customerIdentificationNumber": "1234567",
        "companyName": "COMPANY NAME 1",
        "customerName": "CUSTOMER NAME 1"
    },
    "returnDate": "2024-02-01",
    "returnReasonCode": "R02",
    "returnReasonDescription": "Account Closed",
    "addendaCount": 1,
    "notificationOfChangeAddendaCount": 1,
    "internationalAddendaCount": 0,
    "customData": "merchant:status",
    "checkSerialNumber": "4345",
    "transactionDirection": "Receiving Item",
    "addenda": [
        {
            "sequenceNumber": 1,
            "entryDetailSequenceNumber": "188",
            "paymentRelatedInformation": "Addenda Record (Applies to CCD, CTX, PPD, and WEB entries)"
        }
    ],
    "notificationOfChange": [
        {
            "changeCode": "C02",
            "changeDescription": "Incorrect transit\/routing number",
            "correctedData": "1234567890"
        }
    ]
}

Successful response

NAME	TYPE	DESCRIPTION
parNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
transactionStatusoptional	string	The status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED
traceNumberoptional	string	The unique number for the transaction provided by the originator.
transactionAmountoptional	number	The dollar amount of the transaction.
settlementDateoptional	string	The date the transaction settlement occurred. Format: YYYY-MM-DD
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptional	string	Description for the transaction code.
transactionDescriptionoptional	string	Description about the purpose of the transaction.
authorizedCustomerNameoptional	string	Authorized customer name
standardEntryClassCodeoptional	string	The three-digit Standard Entry Class code based on Nacha rules.
standardEntryClassDescriptionoptional	string	The description for the Nacha SEC code.
receivingAccountoptional	Object	AccountDetail
receivingPartyoptional	Object	PartyDetail
originatingAccountoptional	Object	AccountDetail
originatingPartyoptional	Object	PartyDetail
returnDateoptional	string	Date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptional	string	The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00
returnReasonDescriptionoptional	string	Description as to why the ACH transaction is returned.
addendaCountoptional	integer	Count of addenda records.
notificationOfChangeAddendaCountoptional	integer	Count of change notifications for addenda records.
internationalAddendaCountoptional	integer	Count of international addenda records.
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.
checkSerialNumberoptional	string	Serial number for the check converted to an ACH transaction.
transactionDirectionoptional	string	Indicates the direction of the transaction. Valid values: ORIGINATING ITEM, RECEIVING ITEM
addendaoptional	array	Addendum
notificationOfChangeoptional	array	NotificationOfChange

Response example (200)

{
    "parNumber": "22018007665985",
    "transactionStatus": "COLLECTED",
    "traceNumber": "000000000000000",
    "transactionAmount": 10.01,
    "settlementDate": "2021-03-08",
    "transactionCode": "22",
    "transactionCodeDescription": "Automated Deposit",
    "transactionDescription": "DEPOSIT",
    "authorizedCustomerName": "TEST CUSTOMER1",
    "standardEntryClassCode": "CCD",
    "standardEntryClassDescription": "Cash Concentration or Disbursement",
    "receivingAccount": {
        "accountNumber": "123456789012",
        "bankNumber": "0000",
        "routingNumber": "1234567890"
    },
    "receivingParty": {
        "customerIdentificationNumber": "099999999",
        "companyName": "MERCHANT",
        "customerName": "TEST MERCHANT"
    },
    "originatingAccount": {
        "accountNumber": "123456789012",
        "bankNumber": "0000",
        "routingNumber": "1234567890"
    },
    "originatingParty": {
        "customerIdentificationNumber": "1234567",
        "companyName": "COMPANY NAME 1",
        "customerName": "CUSTOMER NAME 1"
    },
    "returnDate": "2024-02-01",
    "returnReasonCode": "R02",
    "returnReasonDescription": "Account Closed",
    "addendaCount": 1,
    "notificationOfChangeAddendaCount": 1,
    "internationalAddendaCount": 0,
    "customData": "merchant:status",
    "checkSerialNumber": "4345",
    "transactionDirection": "Receiving Item",
    "addenda": [
        {
            "sequenceNumber": 1,
            "entryDetailSequenceNumber": "188",
            "paymentRelatedInformation": "Addenda Record (Applies to CCD, CTX, PPD, and WEB entries)"
        }
    ],
    "notificationOfChange": [
        {
            "changeCode": "C02",
            "changeDescription": "Incorrect transit\/routing number",
            "correctedData": "1234567890"
        }
    ]
}

Schemas

exception

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	serviceErrorData connectError

serviceErrorData

NAME	TYPE	DESCRIPTION
ServiceErrorDataoptional	oneOf	returnACHtransactionslistResponse achCollectedTransactionsResponse achPostedTransactionsResponse achStatusInquiryResponse

connectError

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

returnACHtransactionslistResponse

NAME	TYPE	DESCRIPTION
getACHReturnTransactionsResponseoptional	Object	achReturnTransactionsResponse

ACHReturnTransaction

NAME	TYPE	DESCRIPTION
returnTransactionParNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
sourceBankNumberoptional	string	Originating entry bank number
sourceAccountNumberoptional	string	Originating account number
sourceTransactionRecordNumberoptional	string	Originating record number for the transaction
sourceSysCodeoptional	string	Do not use. This field is for internal purpose only.
sourceSysOfRecordCodeoptional	string	Do not use. This field is for internal purpose only.
snapshotDateoptional	string	This field is for internal purpose only.
originalACHTransactionParNumberoptional	string	The assigned PAR number for the original ACH transaction.
originalTransactionProcessDateoptional	string	Date the transaction is processed. Format: YYYY-MM-DD
originalTransactionProcessTimeoptional	string	Time the transaction is processed in 24-hour time. Format: HHMMSS
originalTransactionProcessTimestampoptional	string	The date and time the transaction is processed. Format: YYYY-MM-DD HH:MM:SS
originatingReceiverCodeoptional	string	Two-character code that identifies the transaction type as originating (O) or receiving (R) and if the transaction is incoming (I) or outgoing (O). Codes can be OI, OO, RI, or RO.
originatingReceiverDescriptionoptional	string	Description for the returned originating receiver code.
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptional	string	Description for the transaction code.
transactionFlowTypeCodeoptional	string	Identifies if transaction is intrabank (within a single financial institution) or interbank (between two or more banks). Valid values: INTRA, INTER
transactionFlowTypeDescriptionoptional	string	Description for the transaction flow type code.
transactionAmountoptional	string	The dollar amount of the transaction.
transactionDescription1optional	string	A free form text field that provides the receiver with a description about the purpose of the transaction.
transactionDescription2optional	string	Additional transaction description information.
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
sourceTransactionCreatedDateoptional	string	Date when the user created the ACH transaction. Format: YYYY-MM-DD
sourceTransactionCreatedTimeoptional	string	Time when the user created the ACH transaction. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionCreatedTimestampoptional	string	The date and time that the ACH transaction was created. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionProcessDateoptional	string	Date when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptional	string	Time when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptional	string	The date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
inboundCollectionWindowoptional	string	The time window when the transaction collection is processed. The time format uses the 24-hour clock. Format: HHMM
outboundCollectionWindowoptional	string	The outbound processing window for the transaction collection. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledDateoptional	string	Date when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptional	string	The time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptional	string	The date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
receivingAccountNumberoptional	string	Account number of the person or institution receiving the funds.
receivingCustIdentificationNumberoptional	string	The customer identification number for the person receiving the transaction.
receivingCustomerNameoptional	string	Customer name of the person receiving the funds.
receivingCompanyNameoptional	string	Company name of the institution getting the funds.
receivingFIBankNumberoptional	string	Bank number for the financial institution receiving the funds.
receivingFIRoutingNumberoptional	string	Routing number for the receiving financial institution.
originatingAccountNumberoptional	string	Account number of the ACH transaction originator.
originatingCustIdentificationNumberoptional	string	Originating customer identification number
originatingCustomerNameoptional	string	Originating customer name
originatingCompanyNameoptional	string	Originating company name
originatingFIBankNumberoptional	string	Originating financial institution bank number
originatingFIRoutingNumberoptional	string	Originating financial institution routing number
authorizedCustomerNameoptional	string	Authorized customer name
immediateDestinationIDoptional	string	The ID indicates the next location of the file once it leaves KeyBank.
returnReleaseDateoptional	string	Release date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptional	string	The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00
returnReasonDescriptionoptional	string	Description as to why the ACH transaction is returned.
checkSerialNumberoptional	string	Serial number for the check converted to an ACH transaction.
nachaBatchNumberoptional	string	The sequential number of the Nacha batch job.
nachaFileHeadRefererenceNumberoptional	string	The Nacha transaction file reference number.
nachaSecondarySecCodeoptional	string	The secondary Nacha standard entry class (SEC) code for the transaction, if applicable. Valid values: CCD, CTX, PPD, TEL, WEB.
nachaSecondarySecDescriptionoptional	string	The description for the secondary Nacha SEC code.
traceIdoptional	string	The trace ID number from the source application.
postCompanyCostcontrolNumberoptional	string	Do not use. This field is for internal purpose only.
glAccountNumberoptional	string	Do not use. This field is for internal purpose only.
collectionPointoptional	string	Transaction collection point
collectionApplicationTypeCodeoptional	string	Do not use. This field is for internal purpose only.
collectionApplicationTypeDescriptionoptional	string	Do not use. This field is for internal purpose only.
batchIDoptional	string	The identification number for the batch job.
customDataoptional	string	Custom data from the originating payment request.

businessFault

NAME	TYPE	DESCRIPTION
errorCodeoptional	string	Business error code
errorDescriptionoptional	string	Business error description

achReturnTransactionsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeader
ACHReturnTransactionoptional	array	ACHReturnTransaction
errorResponseoptional	Object	errorResponse

systemFault

NAME	TYPE	DESCRIPTION
errorCodeoptional	string	System error code
errorDescriptionoptional	string	System error description

achReturnTransactionsRequest

NAME	TYPE	DESCRIPTION
getACHReturnTransactionsRequestoptional	Object	getACHReturnTransactionsRequest

getACHReturnTransactionsRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequired	string	The start date of a date range for submitted transactions. This date should be less than or equal to the current date. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequired	string	The end date of a date range for the submitted transactions. The date must be later than the start date (fromDate). Date range cannot exceed more than one year. Format: YYYY-MM-DD
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptional	string	Transaction amount lower limit value to be searched.
toAmountoptional	string	Transaction amount upper limit value to be searched.
parNumberoptional	string	The PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
detailsFlagrequired	string	Return a detailed response (Y) or a brief response (N). Valid values: Y, N
receivingCustIdentificationNumberoptional	string	The unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptional	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional	string	Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.

responseHeader

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successful or not. Valid values: accepted, failure
statusDescriptionrequired	string	Description of the status
retrivedRowsoptional	string	Total number of transactions retrieved.
totalRowsoptional	string	Total number of transactions matching the requested criteria.
dataLoadDateoptional	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD

errorResponse

NAME	TYPE	DESCRIPTION
businessFaultoptional	array	businessFault
systemFaultoptional	array	systemFault

achCollectedTransactionsRequest

NAME	TYPE	DESCRIPTION
getACHCollectedTransactionsRequestoptional	Object	getACHCollectedTransactionsRequest

getACHCollectedTransactionsRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequired	string	The start date of a date range for submitted transactions. This date should be less than or equal to the current date. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequired	string	The end date of a date range for the submitted transactions. The date must be later than the start date (fromDate). Date range cannot exceed more than one year. Format: YYYY-MM-DD
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptional	string	Transaction amount lower limit value to be searched.
toAmountoptional	string	Transaction amount upper limit value to be searched.
addendaFlagrequired	string	Retrieves addenda information if set to Y for yes. Valid values: Y, N
secCodeoptional	string	The three-digit Standard Entry Class code based on Nacha rules. Valid values: CCD, CTX, PPD, TEL, WEB
traceNumberoptional	string	The unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
parNumberoptional	string	The PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
detailsFlagrequired	string	Return a detailed response (Y) or a brief response (N). Valid values: Y, N
receivingCustIdentificationNumberoptional	string	The unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptional	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional	string	Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.

achStatusInquiryParRequest

NAME	TYPE	DESCRIPTION
getACHStatusInquiryRequestoptional	Object	getACHStatusInquiryParRequest

achStatusInquiryTraceNumberRequest

NAME	TYPE	DESCRIPTION
getACHStatusInquiryRequestoptional	Object	getACHStatusInquiryTraceNumberRequest

getACHStatusInquiryParRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
parNumberrequired	array	The PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
traceNumberoptional	array	The unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
receivingCustIdentificationNumberoptional	string	The unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptional	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional	string	Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.

getACHStatusInquiryTraceNumberRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
traceNumberrequired	array	The unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
parNumberoptional	array	The PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
receivingCustIdentificationNumberoptional	string	The unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptional	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional	string	This is a pagination field. It indicates the last count available for the records. If the field is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.

achPostedTransactionsRequest

NAME	TYPE	DESCRIPTION
getACHPostedTransactionsRequestoptional	Object	getACHPostedTransactionsRequest

getACHPostedTransactionsRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequired	string	The start date of a date range for submitted transactions. This date should be less than or equal to the current date. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequired	string	The end date of a date range for the submitted transactions. The date must be later than the start date (fromDate). Date range cannot exceed more than one year. Format: YYYY-MM-DD
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptional	string	Transaction amount lower limit value to be searched.
toAmountoptional	string	Transaction amount upper limit value to be searched.
parNumberoptional	string	The PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
receivingCustIdentificationNumberoptional	string	The unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptional	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional	string	Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.

achCollectedTransactionsResponse

NAME	TYPE	DESCRIPTION
getACHCollectedTransactionsResponserequired	Object	getACHCollectedTransactionsResponse

getACHCollectedTransactionsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeader
ACHCollectedTransactionoptional	array	achCollectedTransactionsResult
errorResponseoptional	Object	errorResponse

achCollectedTransactionsResult

NAME	TYPE	DESCRIPTION
transactionParNumberoptional	string	The unique PAR number assigned to the transaction by the ACH product processor.
sourceBankNumberoptional	string	Originating entry bank number
sourceAccountNumberoptional	string	Originating account number.
origAcctSuffixoptional	string	Do not use. This field is for internal purpose only.
sourceSysCodeoptional	string	Do not use. This field is for internal purpose only.
sourceSysOfRecordCodeoptional	string	Do not use. This field is for internal purpose only.
snapshotDateoptional	string	This field is for internal purpose only.
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptional	string	Description for the transaction code.
transactionFlowTypeCodeoptional	string	Identifies if transaction is intrabank (within a single financial institution) or interbank (between two or more banks). Valid values: INTRA, INTER
transactionFlowTypeDescriptionoptional	string	Description for the transaction flow type code.
originatingReceiverCodeoptional	string	Two-character code that identifies the transaction type as originating (O) or receiving (R) and if the transaction is incoming (I) or outgoing (O). Codes can be OI, OO, RI, or RO.
transactionAmountoptional	string	The dollar amount of the transaction.
transactionDescriptionoptional	string	A free form text field that provides the receiver with a description about the purpose of the transaction.
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
inboundCollectionWindowoptional	string	The time window when the transaction collection is processed. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionProcessDateoptional	string	Date when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptional	string	Time when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptional	string	The date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionSettledDateoptional	string	Date when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptional	string	The time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptional	string	The date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionPostDateoptional	string	Date the ACH transaction is posted. Format: YYYY-MM-DD
sourceTransactionPostTimeoptional	string	Time the ACH transaction is posted. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionPostTimestampoptional	string	The date and time the transaction is posted. Format: YYYY-MM-DD HH:MM:SS
deliveryStatusCodeoptional	string	The code abbreviation for the delivery status of the ACH transaction.
deliveryStatusDescriptionoptional	string	The delivery status description for the abbreviated code.
receivingAccountNumberoptional	string	Account number of the person or institution receiving the funds.
receivingFIBankNumberoptional	string	Bank number for the financial institution receiving the funds.
receivingFIRoutingNumberoptional	string	Routing number for the receiving financial institution.
receivingCustIdentificationNumberoptional	string	The customer identification number for the person receiving the transaction.
receivingCustomerNameoptional	string	Customer name of the person receiving the funds.
receivingCompanyNameoptional	string	Company name of the institution getting the funds.
originatingAccountNumberoptional	string	Account number of the ACH transaction originator.
originatingFIBankNumberoptional	string	Originating financial institution bank number
originatingFIRoutingNumberoptional	string	Originating financial institution routing number
originatingCustIdentificationNumberoptional	string	Originating customer identification number
originatingCompanyNameoptional	string	Originating company name
originatingCustomerNameoptional	string	Originating customer name
checkSerialNumberoptional	string	Serial number for the check converted to an ACH transaction.
nachaBatchNumberoptional	string	The sequential number of the Nacha batch job.
nachaFileHeadRefererenceNumberoptional	string	The Nacha transaction file reference number.
nachaSecCodeoptional	string	The Nacha standard entry class (SEC) code for the transaction. Valid values: CCD, CTX, PPD, TEL WEB
nachaSecDescriptionoptional	string	The description for the Nacha SEC code.
traceNumberoptional	string	The unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
postCompanyCostcontrolNumberoptional	string	Do not use. This field is for internal purpose only.
glAccountNumberoptional	string	Do not use. This field is for internal purpose only.
addendaPresentFlagoptional	string	Indicates if there are addenda records or not.
addendaRecordNumberoptional	string	Number of addenda records.
originatingReceiverDescriptionoptional	string	Description for the collected originating receiver code.
goRoutingNumberoptional	string	Gateway operator routing number for international transactions.
authorizedCustomerNameoptional	string	Authorized customer name
iatFlagoptional	string	International transaction identifier
collectionPointoptional	string	Transaction collection point
batchIdoptional	string	The identification number for the batch job.
transactionTraceIdoptional	string	The trace ID number from the source application.
addendaInformationoptional	Object	addendaInformation
customDataoptional	string	Custom data from the originating payment request.

achPostedTransactionsResponse

NAME	TYPE	DESCRIPTION
getACHPostedTransactionsResponserequired	Object	getACHPostedTransactionsResponse

getACHPostedTransactionsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeader
ACHPostedTransactionoptional	array	achPostedTransactionsResult
errorResponseoptional	Object	errorResponse

achPostedTransactionsResult

NAME	TYPE	DESCRIPTION
snapshotDateoptional	string	Do not use. This field is for internal purpose only.
processDateoptional	string	Date the transaction was processed. Format: YYYY-MM-DD
sourceBankNumberoptional	string	Originating entry bank number
sourceAccountNumberoptional	string	Originating account number
transactionParNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
transactionAmountoptional	string	The dollar amount of the transaction.
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
hoganTransactionCodeoptional	string	The KeyBank Hogan code for the transaction.
baiCodeoptional	string	The three-digit BAI (Bank Administration Institute) code for the transaction.
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
regulationDescription1optional	string	Regulation description for the transaction.
regulationDescription2optional	string	Additional regulation information for the transaction.
regulationDescription3optional	string	Additional regulation information for the transaction.
regulationDescription4optional	string	Additional regulation information for the transaction.
postingWindowoptional	string	The time window when the transaction collection is posted. The time format uses the 24-hour clock. Format: HHMM
batchIDoptional	string	The identification number for the batch job.
customDataoptional	string	Custom data from the originating payment request.

achStatusInquiryResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeader
ACHTransactionStatusoptional	array	achStatusInquiryResult
errorResponseoptional	Object	errorResponse

achStatusInquiryResult

NAME	TYPE	DESCRIPTION
ACHStatusoptional	string	The status informs you if the ACH transaction has been collected or returned. Valid values: COLLECTED or RETURNED
ACHCollectedTransactionoptional	Object	achCollectedTransactionsStatusResult
ACHPostedTransactionoptional	Object	achPostedTransactionsStatusResult
ACHReturnTransactionoptional	Object	achReturnTransactionsStatusResult

achCollectedTransactionsStatusResult

NAME	TYPE	DESCRIPTION
transactionParNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
sourceBankNumberoptional	string	Originating entry bank number
sourceAccountNumberoptional	string	Originating account number.
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
transactionAmountoptional	string	The dollar amount of the transaction.
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
sourceTransactionProcessDateoptional	string	Date when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptional	string	Time when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptional	string	The date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionSettledDateoptional	string	Date when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptional	string	The time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptional	string	The date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionPostDateoptional	string	Date the ACH transaction is posted. Format: YYYY-MM-DD
sourceTransactionPostTimeoptional	string	Time the ACH transaction is posted. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionPostTimestampoptional	string	The date and time the transaction is posted. Format: YYYY-MM-DD HH:MM:SS
receivingCustomerNameoptional	string	Customer name of the person receiving the funds.
receivingCompanyNameoptional	string	Company name of the institution getting the funds.
originatingCompanyNameoptional	string	Originating company name
originatingCustomerNameoptional	string	Originating customer name
nachaSecCodeoptional	string	The Nacha standard entry class (SEC) code for the transaction. Valid values: CCD, CTX, PPD, TEL, WEB
traceNumberoptional	string	The unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
transactionDescriptionoptional	string	A free form text field that provides the receiver with a description about the purpose of the transaction.
receivingCustIdentificationNumberrequired	string	The unique ID number associated with the payment recipient. This number is defined in the originating payment request.

achPostedTransactionsStatusResult

NAME	TYPE	DESCRIPTION
processDateoptional	string	Date the transaction was processed. Format: YYYY-MM-DD
transactionParNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
transactionAmountoptional	string	The dollar amount of the transaction.
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
baiCodeoptional	string	The three-digit BAI (Bank Administration Institute) code for the transaction.
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
regulationDescription1optional	string	Regulation description for the transaction.
regulationDescription2optional	string	Additional regulation information for the transaction.
regulationDescription3optional	string	Additional regulation information for the transaction.
regulationDescription4optional	string	Additional regulation information for the transaction.
postingWindowoptional	string	The time window when the transaction collection is posted. The time format uses the 24-hour clock. Format: HHMM

achReturnTransactionsStatusResult

NAME	TYPE	DESCRIPTION
transactionParNumberoptional	string	The unique PAR number assigned to the transaction by the ACH product processor.
transactionCodeoptional	string	Two digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptional	string	Description for the transaction code.
transactionAmountoptional	string	The dollar amount of the transaction.
transactionDescription1optional	string	A free form text field that provides the receiver with a description about the purpose of the transaction.
transactionDescription2optional	string	Additional transaction description information.
creditOrDebitCodeoptional	string	Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
returnReleaseDateoptional	string	Release date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptional	string	The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00
returnReasonDescriptionoptional	string	Description as to why the ACH transaction is returned.

addendaInformation

NAME	TYPE	DESCRIPTION
iatAddendumoptional	Object	iatAddendum
nonIatAddendumoptional	Object	nonIatAddendum
nocAddendumoptional	Object	nocAddendum

iatAddendum

NAME	TYPE	DESCRIPTION
addendaParNumberoptional	string	The unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptional	string	Do not use. This field is for internal purpose only.
transactionParNumberoptional	string	The unique PAR number assigned to the transaction by the ACH product processor.
payInformationoptional	string	Additional information about the remittance payment.
addendaTypeCodeoptional	string	Two-digit code identifying the type of information.
addendaTypeDescriptionoptional	string	Description of the addenda type associated with the code.
transactionTypeCodeoptional	string	This field contains a three-character code used to identify the type of transaction.
transactionTypeDescroptional	string	This field contains description of the the transaction type code
originatingFiIdentificationNumberCodeoptional	string	Originating financial institution code
originatingFiNameoptional	string	Originating financial institution name
originatingFiIdentificationNumberoptional	string	Originating financial institution identification number
originatingFiBranchCountryCodeoptional	string	Originating company country branch code
originatingCompanyNameoptional	string	Originating company name
originatingCompanyAddress1optional	string	Originating bank physical street address, line 1
originatingCompanyAddress2optional	string	Originating bank physical street address, line 2
originatingCompanyCityStateProvinceoptional	string	Originator city and state
originatingCompanyCountryPostalCodeoptional	string	Originator country and postal code
receivingFiNameoptional	string	Receiving financial institution name
receivingFiIdentificationNumberoptional	string	Receiving financial institution identification number
receivingFiIdentificationNumberCodeoptional	string	Receiving financial institution code
receivingFiBranchCountryCodeoptional	string	Receiving company country branch code
receivingCustomerNameoptional	string	Receiving customer name
receivingCompanyNameoptional	string	Receiving company name
receivingCompanyNumberoptional	string	Receiving company number
receivingCompanyAddress1optional	string	Receiving company physical address, line 1
receivingCompanyAddress2optional	string	Receiving company physical address, line 2
receivingCompanyCityStateProvinceoptional	string	Receiving company city and state
receivingCompanyCountryPostalCodeoptional	string	Receiving company country and postal code
foreignCorrespondentFiIdNumberCodeoptional	string	Foreign correspondent bank identification number qualifier
foreignCorrespondentFiNameoptional	string	Correspondent bank name
foreignCorrespondentFiBRCountryCodeoptional	string	Correspondent bank country code
foreignCorrespondentBankIdNumberoptional	string	Correspondent bank identifier
foreignOriginatingAmountoptional	string	Foreign payment amount
foreignOriginatingCurrencyCodeoptional	string	Foreign currency code
foreignTraceNumberoptional	string	Identifier number of the foreign transaction.
addendaSequenceNumberoptional	string	The sequence number of the addenda. The number cannot exceed 4 digits.
entryDetailSequenceNumberoptional	string	Sequence number of the entry detail
operatorCommandFlagoptional	string	Operator command flag

nonIatAddendum

NAME	TYPE	DESCRIPTION
addendaParNumberoptional	string	The unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptional	string	Do not use. This field is for internal purpose only.
transactionParNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
transactionSerialNumberoptional	string	Serial number for the transaction
transactionDescriptionoptional	string	A free form text field that provides the receiver with a description about the purpose of the transaction.
sourceTransactionCreatedDateoptional	string	Date when the user created the ACH transaction. Format: YYYY-MM-DD
sourceTransactionCreatedTimeoptional	string	Time when the user created the ACH transaction. The time format uses the 24-hour clock. Format: HHMM
payInformationoptional	string	Additional information associated with the payment transaction.
addendaTypeCodeoptional	string	Two-digit code identifying the type of information.
addendaTypeDescriptionoptional	string	Description of the addenda type associated with the code.
entryDetailSequenceNumberoptional	string	Sequence number of the entry detail
referenceInformation1optional	string	Free form text field with additional reference information.
referenceInformtion2optional	string	Free form text field with additional reference information.
networkIdentificationCodeoptional	string	Network identification code (NIC)
terminalIdentificationCodeoptional	string	Terminal identification code
terminalCityoptional	string	City location of the terminal
terminalStateoptional	string	State location of the terminal
keyBankTransactionReferenceNumberoptional	string	Unique ACH transaction identifier created by KeyBank.
operatorCommandFlagoptional	string	Operator command flag

nocAddendum

NAME	TYPE	DESCRIPTION
addendaParNumberoptional	string	The unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptional	string	Do not use. This field is for internal purpose only.
transactionParNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
addendaTypeCodeoptional	string	Two-digit code identifying the type of information.
addendaTypeDescriptionoptional	string	Description of the addenda type associated with the code.
changeCodeoptional	string	The three-character change code begins with the letter 'C'. This code is applied to all NOCs to indicate the information that is being changed.
changeDescriptionoptional	string	The description associated with the change code.
receivingFiIdentificationNumberoptional	string	Receiving financial institution identification number
correctedDataoptional	string	The corrected data per the correction change code.
externalFiTransactionIdentificationNumberoptional	string	The number used by an external financial institution to identify the transaction.
keyBankTransactionReferenceNumberoptional	string	Unique ACH transaction identifier created by KeyBank.
operatorCommandFlagoptional	string	Operator command flag.

AccountList

NAME	TYPE	DESCRIPTION
accountNumberoptional	string	Bank account number.

AccountDetail

NAME	TYPE	DESCRIPTION
accountNumberoptional	string	Bank account number of the ACH originator or receiver.
bankNumberoptional	string	Bank number associated with the account number.
routingNumberoptional	string	Nine-digit routing number for the account provided in the original request.

AchDetailTransaction

NAME	TYPE	DESCRIPTION
parNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
transactionStatusoptional	string	The status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED
traceNumberoptional	string	The unique number for the transaction provided by the originator.
transactionAmountoptional	number	The dollar amount of the transaction.
settlementDateoptional	string	The date the transaction settlement occurred. Format: YYYY-MM-DD
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptional	string	Description for the transaction code.
transactionDescriptionoptional	string	Description about the purpose of the transaction.
authorizedCustomerNameoptional	string	Authorized customer name
standardEntryClassCodeoptional	string	The three-digit Standard Entry Class code based on Nacha rules.
standardEntryClassDescriptionoptional	string	The description for the Nacha SEC code.
receivingAccountoptional	Object	AccountDetail
receivingPartyoptional	Object	PartyDetail
originatingAccountoptional	Object	AccountDetail
originatingPartyoptional	Object	PartyDetail
returnDateoptional	string	Date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptional	string	The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00
returnReasonDescriptionoptional	string	Description as to why the ACH transaction is returned.
addendaCountoptional	integer	Count of addenda records.
notificationOfChangeAddendaCountoptional	integer	Count of change notifications for addenda records.
internationalAddendaCountoptional	integer	Count of international addenda records.
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.
checkSerialNumberoptional	string	Serial number for the check converted to an ACH transaction.
transactionDirectionoptional	string	Indicates the direction of the transaction. Valid values: ORIGINATING ITEM, RECEIVING ITEM
addendaoptional	array	Addendum
notificationOfChangeoptional	array	NotificationOfChange

AchListTransaction

NAME	TYPE	DESCRIPTION
parNumberoptional	string	The unique PAR number assigned to the the transaction by the ACH product processor.
transactionStatusoptional	string	The status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED
traceNumberoptional	string	The unique number for the transaction provided by the originator.
transactionAmountoptional	number	The dollar amount of the transaction.
settlementDateoptional	string	The date the transaction settlement occurred. Format: YYYY-MM-DD
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
authorizedCustomerNameoptional	string	Authorized customer name
standardEntryClassCodeoptional	string	The three-digit Standard Entry Class code based on Nacha rules.
receivingAccountoptional	Object	AccountList
receivingPartyoptional	Object	PartyList
originatingAccountoptional	Object	AccountList
originatingPartyoptional	Object	PartyList
returnDateoptional	string	Date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptional	string	The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00
returnReasonDescriptionoptional	string	Description as to why the ACH transaction is returned.
addendaCountoptional	integer	Count of addenda records.
notificationOfChangeAddendaCountoptional	integer	Count of change notifications for addenda records.
internationalAddendaCountoptional	integer	Count of international addenda records.

Addendum

NAME	TYPE	DESCRIPTION
sequenceNumberoptional	integer	The addenda record item number in order of sequence. Number cannot exceed 4 digits.
entryDetailSequenceNumberoptional	string	The entry number in order of sequence. Number cannot exceed 7 digits.
paymentRelatedInformationoptional	string	The related payment information from the addenda records. The maximum character limit is 255.

Message

NAME	TYPE	DESCRIPTION
codeoptional	string	Code for the related message.
messageoptional	string	Message associated with the code.

Page

NAME	TYPE	DESCRIPTION
pageNumberoptional	integer	The number of the page being viewed.
pageSizeoptional	integer	The number of records per page.
totalPagesoptional	integer	The number of pages there are in total.
totalRecordsoptional	integer	The total number of transactions available in the result set.
lastPageoptional	boolean	Indicates if the current page (page number) is the last page of the result set. Valid values: true, false

Metadata

NAME	TYPE	DESCRIPTION
messagesoptional	array	Message
pageoptional	Object	Page

PartyList

NAME	TYPE	DESCRIPTION
customerIdentificationNumberoptional	string	The unique identification number associated with the customer.
companyNameoptional	string	The name of the corporation or institution making the request.

PartyDetail

NAME	TYPE	DESCRIPTION
customerIdentificationNumberoptional	string	The unique identification number associated with the customer.
companyNameoptional	string	The name of the corporation or institution making the request.
customerNameoptional	string	The name of the customer.

NotificationOfChange

NAME	TYPE	DESCRIPTION
changeCodeoptional	string	The three-character change code begins with the letter 'C'. This code is applied to all NOCs to indicate the information that is being changed.
changeDescriptionoptional	string	The description associated with the change code.
correctedDataoptional	string	The corrected data per the correction change code.

Errors

For more information about general errors, see Error handling.

API specific KeyBank codes and messages

HTTP
STATUS CODE CUSTOM
STATUS CODE DESCRIPTION

299

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

ECA-W-001 Request Validation failed.

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

400

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.

YAML file

Intraday Reporting

3-minute read 1.2.6 | updated Apr. 29, 2024

Get the memo for today's activities

Intraday Information Reporting Endpoints

What you can do	Endpoint
Health check	get /ddaReports/accounts/v1/healthCheck
Get a list of transactions for the current day	post /ddaReports/accounts/v1/transactions/intraday/list
Get an account summary report for the current day	post /ddaReports/accounts/v1/transactions/intraday/summary
Get a CDA summary report for the current day	post /ddaReports/accounts/v1/transactions/cda/summary
Get the current balance for one or more accounts	post /ddaReports/accounts/v1/transactions/current/balances

Before you begin

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

Overview

Intraday information includes all memo transactions from the current day, such as deposit activity, CDA funding requirements, incoming CDA checks, incoming ACH debits and credits, incoming wires, and ACH and wire transactions that you originate.

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.

Responses

Successful response

NAME	TYPE	DESCRIPTION
Statusoptional	string	Status of the health check response.
Sourceoptional	string	Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
Timestampoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIpoptional	string	Client IP address the gateway receives from the request.
X-Forwarded-Foroptional	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 list of transactions for the current day

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

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

Request

BODY FIELD	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the list of transactions is to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD
startRowIndexoptional	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional	string	Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.

Request example

{
    "getIntraDayTransactionsRequest": {
        "accountNumber": [
            "123456789"
        ],
        "date": "2022-04-11",
        "startRowIndex": "1",
        "endRowIndex": "1"
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
IntraDayTransactionsoptional	array	IntraDayTransactions

Response example (200)

{
    "getIntraDayTransactionsResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully returned results for the requested range 1 to 10",
            "retrivedRows": "1",
            "totalRows": "1",
            "dataLoadDate": "2022-07-05"
        },
        "IntraDayTransactions": [
            {
                "accountNumber": "123456789",
                "transactionEffectiveDate": "04\/11\/2022",
                "transactionTypeId": "RTP",
                "addendaInformation": {
                    "WiresData": {
                        "creditArrangementTypeCode": "NOSTRO",
                        "creditArrangementBankNumber": "0101",
                        "creditArrangementBankBranch": "US",
                        "creditArrangementCurrencyCode": "USD",
                        "creditInvolvedPartyIdentifier": "22850641",
                        "creditInvolvedPartyName": "TEST COMPANY 3, LLC",
                        "creditArrangementCountryCode": "CORP",
                        "creditInvolvedPartyTypeCode": "US",
                        "debitArrangementTypeCode": "DDA",
                        "debitArrangementBankNumber": "3290",
                        "debitArrangementBankBranch": "US",
                        "debitArrangementCurrencyCode": "USD",
                        "debitInvolvedPartyIdentifier": "35008380",
                        "debitInvolvedPartyName": "TEST COMPANY 1, LLC",
                        "transactionBusinessStatusCode": "Completed",
                        "sendingBankReferenceNumber": "KTT96632162612772R",
                        "originatingInvolvedPartyName": "TEST COMPANY 1, LLC",
                        "originatingArrangementNumber": "12345123",
                        "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland",
                        "originatingInvolvedPartyAddressLine2": "OH 44114",
                        "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC",
                        "beneficiaryArrangementNumber": "987654321",
                        "beneficiaryInvolvedPartyAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryInvolvedPartyAddressLine2": "Buffalo,NY 14202",
                        "intermediaryBankName": "KeyBank National Association",
                        "intermediaryBankABANumber": "21300077",
                        "intermediaryBICCode": "KEYBUS33 XXX",
                        "intermediaryBankAddressLine1": "250 Delaware Ave Ste",
                        "intermediaryBankAddressLine2": "Buffalo,NY 14202",
                        "originatingBankName": "ORIGINATING BANK USA",
                        "originatingBankABANumber": "123001088",
                        "originatingBankBICcode": "ORIBICODE",
                        "originatingBankAddressLine1": "127 Public Sq",
                        "originatingBankAddressLine2": "Cleveland, OH 44114",
                        "beneficiaryBankName": "KeyBank National Association",
                        "beneficiaryBankABANumber": "21300077",
                        "beneficiaryBankBICcode": "KEYBUS33 XXX",
                        "beneficiaryBankAddressLine1": "250 Delaware Ave Ste",
                        "beneficiaryBankAddressLine2": "Buffalo,NY 14202",
                        "sourceTransactionIdentifier": "NOTPROVIDED",
                        "transactionSettledDate": "04\/11\/2022",
                        "federalReferenceNumber": "20220411MMFMP1D002353",
                        "incomingReferenceNumber": "2021092123304446",
                        "transactionExecutedDate": "04\/11\/2022",
                        "transactionIdentifier": "US22041123510763"
                    },
                    "OLDSData": {
                        "bankNumber": "0101",
                        "transactionTypeId": "1085",
                        "srcArrangementNumber": "123456789",
                        "transactionEffDate": "25\/10\/2021",
                        "transactionAmount": "375",
                        "transactionTypeCode": "D",
                        "transactionSrcCode": "ODS",
                        "transactionDescription": "TRANSFER FROM CHECKING TO CHECKING"
                    },
                    "LockboxData": {
                        "lockboxNumber": "1234",
                        "lockboxName": "Keybank Lockbox #1",
                        "lockboxGrpNumber": "1001",
                        "lockboxGrpName": "Keybank Group #1",
                        "firstContactName": "John Doe",
                        "firstContactStreetAddr": "127 Public Sq",
                        "firstContactCity": "Cleveland",
                        "firstContactState": "OH",
                        "firstContactPostalCode": "44114",
                        "firstDepositTransitNumber": "12235",
                        "customDataField1": "XXX123"
                    },
                    "LockboxTransactionData": {
                        "DDAAccountNumber": "123456789",
                        "processDate": "02\/01\/2022",
                        "lockboxGrpBankNumber": "1001",
                        "lockboxNumber": "1234",
                        "remittanceTransactionNumber": "28",
                        "remittancePaidAmount": "36.9",
                        "paidAmount": "250",
                        "payerFinInstRoutingNum": "000008002",
                        "payerArrangementNum": "27911525005",
                        "checkSeqNumber": "27911525005",
                        "floatAmountDay0": "0",
                        "floatAmountDay1": "250",
                        "floatAmountDay2": "0"
                    },
                    "CPCSData": {
                        "sourceArrangementNumber": "1234567890",
                        "regulationEDescription": "KEYCAP ",
                        "transactionDescription2": "E#3830Y",
                        "transactionEffectiveDate": "08\/09\/2021",
                        "transactionActionCode": "D",
                        "transactionAmount": "49985.07",
                        "float1Amount": "49985",
                        "creditOrDebitCode": "C",
                        "traceID": "C 003121080937346069"
                    },
                    "ACHTransactionData": {
                        "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"
                    },
                    "RTPData": {
                        "creditArrangementTypeCode": "NOSTRO",
                        "creditArrangementBankNumber": "0101",
                        "creditArrangementBankBranch": "US",
                        "creditArrangementCurrencyCode": "USD",
                        "creditInvolvedPartyIdentifier": "999997",
                        "creditInvolvedPartyName": "TEST RTP Clearing Account",
                        "creditArrangementCountryCode": "US",
                        "debitArrangementTypeCode": "DDA",
                        "debitArrangementBankNumber": "0618",
                        "debitArrangementBankBranch": "US",
                        "debitArrangementCurrencyCode": "USD",
                        "debitInvolvedPartyIdentifier": "12359355",
                        "debitInvolvedPartyName": "TEST COMPANY 2, LLC",
                        "transactionBusinessStatusCode": "Completed",
                        "originatingInvolvedPartyName": "TEST COMPANY 1, LLC",
                        "originatingArrangementNumber": "12345123",
                        "originatingInvolvedPartyAddressLine1": "127 Public Sq, Cleveland",
                        "originatingInvolvedPartyAddressLine2": "OH 44114",
                        "beneficiaryInvolvedPartyName": "TEST COMPANY 3, LLC",
                        "beneficiaryArrangementNumber": "987654321",
                        "sourceTransactionIdentifier": "NOTPROVIDED",
                        "transactionSettledDate": "09\/30\/2021",
                        "federalReferenceNumber": "20210930041001039T1BUSRT06428125521",
                        "transactionExecutedDate": "09\/30\/2021",
                        "transactionIdentifier": "US21093000082075",
                        "transactionAmount": "400"
                    }
                }
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (400)

{
    "ErrorMessage": "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"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (401)

{
    "ErrorMessage": "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": {
        "getIntraDayTransactionsResponse": {
            "responseHeader": {
                "status": "F",
                "statusDescription": "Error Message from Backend Servers for unauthorized access"
            },
            "errorResponse": {
                "businessFault": [
                    {
                        "errorCode": "ECA-W-001",
                        "errorDescription": "Error Message from Backend Servers for unauthorized access"
                    }
                ]
            }
        }
    }
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (403)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (404)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (405)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (415)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (429)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (500)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (502)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (503)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (504)

{
    "ErrorMessage": "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 an account summary report for the current day

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

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

Request

BODY FIELD	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

Request example

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

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
DDAIntraDaySummaryoptional	array	GetIntraDaySummaryResult

Response example (200)

{
    "getIntraDaySummaryResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully processed the request.",
            "dataLoadDate": "2022-07-05"
        },
        "DDAIntraDaySummary": [
            {
                "earlyACHCredit": "5163394",
                "earlyACHCreditCount": "10",
                "lateACHCredit": "6137.55",
                "lateACHCreditCount": "1",
                "lockboxCredit": "0",
                "lockboxCreditCount": "0",
                "wireTransferCredit": "566308.64",
                "wireTransferCreditCount": "6",
                "depositsCredit": "0",
                "otherMiscCredit": "0",
                "otherMiscCreditCount": "0",
                "totalCredit": "5735840.19",
                "totalCreditCount": "17",
                "earlyACHDebit": "4602565.25",
                "earlyACHDebitCount": "2",
                "lateACHDebit": "0",
                "lateACHDebitCount": "0",
                "wireTransferDebit": "1420669.84",
                "wireTransferDebitCount": "2",
                "otherMiscDebit": "0",
                "otherMiscDebitCount": "0",
                "totalDebit": "6023235.09",
                "totalDebitCount": "4",
                "srcBankNum": "0101",
                "srcSysCode": "DDA"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (400)

{
    "ErrorMessage": "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": {
        "getIntraDaySummaryResponse": {
            "responseHeader": {
                "status": "F",
                "statusDescription": "Request Validation failed."
            },
            "errorResponse": {
                "businessFault": [
                    {
                        "errorCode": "ECA-W-001",
                        "errorDescription": "Missing mandatory field(s) - accountNumber."
                    }
                ]
            }
        }
    }
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (401)

{
    "ErrorMessage": "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": {
        "getIntraDaySummaryResponse": {
            "responseHeader": {
                "status": "F",
                "statusDescription": "Error Message from Backend Servers for unauthorized access"
            },
            "errorResponse": {
                "businessFault": [
                    {
                        "errorCode": "ECA-W-001",
                        "errorDescription": "Error Message from Backend Servers for unauthorized access"
                    }
                ]
            }
        }
    }
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (403)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (404)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (405)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (415)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (429)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (500)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (502)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (503)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (504)

{
    "ErrorMessage": "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 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	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (400)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (401)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (403)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (404)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (405)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (415)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (429)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (500)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (502)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (503)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (504)

{
    "ErrorMessage": "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	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the current balances are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

Request example

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

Responses

Successful response

NAME	TYPE	DESCRIPTION
responseHeaderoptional	Object	responseHeaders
CurrentBalancesoptional	array	GetCurrentBalancesResult

Response example (200)

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

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (400)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (401)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (403)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (404)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (405)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (415)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (429)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (500)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (502)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (503)

{
    "ErrorMessage": "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
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

Response example (504)

{
    "ErrorMessage": "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

ACHMemoPost

NAME	TYPE	DESCRIPTION
sourceArrangementNumberoptional	string	Account number
transactionProcessedDateoptional	string	Date the transaction was processed. Format: YYYY-MM-DD
transactionAmountoptional	string	Transaction amount
transactionCreditDebitCodeoptional	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
derivedBAICodeoptional	string	BAI2 transaction code
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
description1optional	string	Brief description of the transaction.
description2optional	string	Brief description of the transaction.
description3optional	string	Brief description of the transaction.
description4optional	string	Brief description of the transaction.
transactionPostingWindowoptional	string	Posting window of the transaction.

ACHTransactionData

NAME	TYPE	DESCRIPTION
sourceArrangementNumberoptional	string	Account number
transactionProcessedDateoptional	string	Date the transaction was processed. Format: YYYY-MM-DD
transactionAmountoptional	string	Transaction amount
transactionCreditDebitCodeoptional	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
derivedBAICodeoptional	string	BAI2 transaction code
transactionCodeoptional	string	Two-digit code identifying the account type at the receiving financial institution.
description1optional	string	Brief description of the transaction.
description2optional	string	Brief description of the transaction.
description3optional	string	Brief description of the transaction.
description4optional	string	Brief description of the transaction.
transactionPostingWindowoptional	string	Posting window of the transaction.

AddendaInformation

NAME	TYPE	DESCRIPTION
WiresDataoptional	Object	WiresData
OLDSDataoptional	Object	OLDSData
LockboxDataoptional	Object	LockboxData
LockboxTransactionDataoptional	Object	LockboxTransactionData
CPCSDataoptional	Object	CPCSData
ACHTransactionDataoptional	Object	ACHTransactionData
RTPDataoptional	Object	RTPData

BusinessFault

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

CDATransactionDetails

NAME	TYPE	DESCRIPTION
transactionDateoptional	string	Date the transaction posted. Format: MM-DD-YYYY
snapshotDateoptional	string	Date that requested data was loaded. Format: MM-DD-YYYY
originatingFinancialInstitutionReferenceNumberoptional	string	Reference number of the originating financial institution.
currencyCodeoptional	string	Currency code of the transaction. Default value: USD
transactionDescriptionoptional	string	Brief description of the transaction.
transactionTypeCodeoptional	string	The banking processor code for a particular transaction type.
fundTypeCodeoptional	string	Code associated with the fund type.
amountoptional	string	Transaction amount
customerReferenceNumberoptional	string	Reference number attached to the customer.
processSequenceNumberoptional	string	Sequence number of the transaction.

connectError

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

CPCSData

NAME	TYPE	DESCRIPTION
transactionPostedDateoptional	string	Date the transaction posted. Format: MM-DD-YYYY
sourceArrangementNumberoptional	string	Account number
transactionDescriptionPart1optional	string	Description of transaction, part 1
transactionDescriptionPart2optional	string	Description of transaction, part 2
transactionDescriptionPart3optional	string	Description of transaction, part 3
regulationEDescriptionoptional	string	Regulation E description
transactionDescription2optional	string	Description of transaction
transactionEffectiveDateoptional	string	Effective date of the transaction. Format: YYYY-MM-DD
transactionActionCodeoptional	string	Transaction action identifier
transactionAmountoptional	string	Transaction amount
cashAmountoptional	string	Cash part of transaction amount
checkIdentificationNumberoptional	string	Can contain serial number of item or store number for identification purposes.
float0Amountoptional	string	Float 0 amount
float1Amountoptional	string	Float 1 amount
float2Amountoptional	string	Float 2 amount
float3Amountoptional	string	Float 3 amount
float4Amountoptional	string	Float 4 amount
float5Amountoptional	string	Float 5 amount
float6Amountoptional	string	Float 6 amount
float7Amountoptional	string	Float 7 amount
priorDateFlagoptional	string	If the transaction date is prior to the current business date then this is set to "P".
creditOrDebitCodeoptional	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
traceIDoptional	string	Source transaction identifier

CurrentBalances

NAME	TYPE	DESCRIPTION
holdsoptional	string	Amount that is on hold
uncollectedFundsoptional	string	Uncollected funds amount
currentLedgeroptional	string	Current ledger balance
currentAvailableoptional	string	Current available balance
openingAvailableoptional	string	Opening available balance

ErrorResponse

NAME	TYPE	DESCRIPTION
businessFaultoptional	array	BusinessFault
systemFaultoptional	array	SystemFault

Exception

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	A human-readable message that describes the type or source of the error.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionIdoptional	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptional	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptional	oneOf	ExceptionIntraDayList ExceptionIntraDaySummary ExceptionCDASummary ExceptionCurrentBalance connectError

ExceptionCDASummary

NAME	TYPE	DESCRIPTION
ExceptionCDASummary	object	GetCDASummaryResponseException

ExceptionCurrentBalance

NAME	TYPE	DESCRIPTION
ExceptionCurrentBalance	object	GetCurrentBalancesResponseException

ExceptionIntraDayList

NAME	TYPE	DESCRIPTION
ExceptionIntraDayList	object	GetIntraDayTransactionsResponseException

ExceptionIntraDaySummary

NAME	TYPE	DESCRIPTION
ExceptionIntraDaySummary	object	GetIntraDaySummaryResponseException

GetCDASummaryRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

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.
dataLoadDateoptional	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrivedRowsoptional	string	Total number of transactions retrieved.
totalRowsoptional	string	Total number of transactions matching the requested criteria.
errorResponseoptional	Object	ErrorResponse

GetCDASummaryResult

NAME	TYPE	DESCRIPTION
summaryoptional	Object	Summary
CDATransactionDetailsoptional	Object	CDATransactionDetails
ACHMemoPostoptional	Object	ACHMemoPost

GetCurrentBalancesRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the current balances are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

GetCurrentBalancesResponse

NAME	TYPE	DESCRIPTION
responseHeaderoptional	Object	responseHeaders
CurrentBalancesoptional	array	GetCurrentBalancesResult

GetCurrentBalancesResponseException

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successfully retrieved.
statusDescriptionrequired	string	Description of the status.
dataLoadDateoptional	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrivedRowsoptional	string	Total number of transactions retrieved.
totalRowsoptional	string	Total number of transactions matching the requested criteria.
errorResponseoptional	Object	ErrorResponse

GetCurrentBalancesResult

NAME	TYPE	DESCRIPTION
currentBalancesoptional	Object	CurrentBalances

GetIntraDaySummaryRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the transaction summaries are to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD

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
dataLoadDateoptional	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD
errorResponseoptional	Object	ErrorResponse

GetIntraDaySummaryResult

NAME	TYPE	DESCRIPTION
earlyACHCreditoptional	string	Total credit amount as of 0600 posting window.
earlyACHCreditCountoptional	string	Total number of ACH credit transactions as of 0600 posting window.
lateACHCreditoptional	string	Total credit amount from posting windows other than 0600.
lateACHCreditCountoptional	string	Total number of ACH credit transactions from posting windows other than 0600.
lockboxCreditoptional	string	Total credit amount of lockbox transactions.
lockboxCreditCountoptional	string	Total number of lockbox credit transactions.
wireTransferCreditoptional	string	Total credit amount of wire transfer transactions.
wireTransferCreditCountoptional	string	Total number of wire transfer credit transactions.
depositsCreditoptional	string	Total credit amount through deposits.
otherMiscCreditoptional	string	Other miscellaneous credit amounts.
otherMiscCreditCountoptional	string	Total number of miscellaneous credit transactions.
totalCreditoptional	string	Total credit amount from memo post, lockbox, wires, OLDS, and CPCS transactions.
totalCreditCountoptional	string	Total number of credits from memo post, lockbox, wires, OLDS, and CPCS transactions.
earlyACHDebitoptional	string	Total debit amount as of 0600 posting window.
earlyACHDebitCountoptional	string	Total number of ACH debit transactions as of 0600 posting window.
lateACHDebitoptional	string	Total debit amount from posting windows other than 0600.
lateACHDebitCountoptional	string	Total number of ACH debit transactions from posting windows other than 0600.
wireTransferDebitoptional	string	Total debit amount of wire transfer transactions.
wireTransferDebitCountoptional	string	Total number of wire transfer debit transactions.
otherMiscDebitoptional	string	Other miscellaneous debit amounts.
otherMiscDebitCountoptional	string	Total number of miscellaneous debit transactions.
totalDebitoptional	string	Total debit amount from memo post, lockbox, wires, OLDS, and CPCS transactions.
totalDebitCountoptional	string	Total number of debits from memo post, lockbox, wires, OLDS, and CPCS transactions.
srcBankNumoptional	string	Source bank number
srcSysCodeoptional	string	Source system code
currentBalancesoptional	Object	GetCurrentBalancesResult

getIntraDayTransactionsRequest

NAME	TYPE	DESCRIPTION
accountNumberrequired	array	One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
daterequired	string	Date for which the list of transactions is to be retrieved. Transaction data can be recalled from the previous 24 months. Format: YYYY-MM-DD
startRowIndexoptional	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptional	string	Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.

getIntraDayTransactionsResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeaders
IntraDayTransactionsoptional	array	IntraDayTransactions

GetIntraDayTransactionsResponseException

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successfully retrieved.
statusDescriptionrequired	string	Description of the status.
dataLoadDateoptional	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrivedRowsoptional	string	Total number of transactions retrieved.
totalRowsoptional	string	Total number of transactions matching the requested criteria.
errorResponseoptional	Object	ErrorResponse

healthResponse

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

IntraDayTransactions

NAME	TYPE	DESCRIPTION
accountNumberoptional	string	Account number associated with the transaction.
transactionEffectiveDateoptional	string	Effective date of the transaction. Format: YYYY-MM-DD
transactionTypeIdoptional	string	Transaction type identifier
addendaInformationoptional	Object	AddendaInformation

LockboxData

NAME	TYPE	DESCRIPTION
lockboxNumberoptional	string	Lockbox number
lockboxNameoptional	string	Lockbox name
lockboxGrpNumberoptional	string	Lockbox grouping number
lockboxGrpNameoptional	string	Lockbox grouping name
firstContactNameoptional	string	First contact name defined in lockbox contacts
firstContactStreetAddroptional	string	Street address for named contact
firstContactCityoptional	string	City for named contact
firstContactStateoptional	string	State for named contact
firstContactPostalCodeoptional	string	Zip code for named contact
firstDepositTransitNumberoptional	string	Transit number for named contact
customDataField1optional	string	Custom data field

LockboxTransactionData

NAME	TYPE	DESCRIPTION
DDAAccountNumberoptional	string	DDA account number associated with lockbox.
processDateoptional	string	Date the transaction was processed. Format: YYYY-MM-DD
lockboxGrpBankNumberoptional	string	Not a KeyBank bank number. Used by lockbox application to group lockboxes.
lockboxNumberoptional	string	Lockbox number
remittanceTransactionNumberoptional	string	Transaction number
remittancePaidAmountoptional	string	Remittance applied amount
paidAmountoptional	string	Amount being paid by the payment record.
payerFinInstRoutingNumoptional	string	Routing and transit number field from payment. This is the routing number of the payer account.
payerArrangementNumoptional	string	Account number field from payment
checkSeqNumberoptional	string	Check number from payment
floatAmountDay0optional	string	Lockbox float - amount available day 0
floatAmountDay1optional	string	Lockbox float - amount available day 1
floatAmountDay2optional	string	Lockbox float - amount available day 2

OLDSData

NAME	TYPE	DESCRIPTION
bankNumberoptional	string	Bank number associated with the account number.
transactionTypeIdoptional	string	Four-digit transaction type identifier.
srcArrangementNumberoptional	string	Can be any account number, DDA, loan account, credit card, or savings.
transactionEffDateoptional	string	Effective date of the transaction. Format: YYYY-MM-DD
transactionAmountoptional	string	Transaction amount
transactionTypeCodeoptional	string	Code that indicates if the transaction is a credit or a debit. Valid values: C (credit), D (debit)
reversalFlagoptional	string	Denotes if the transaction is a reversal transaction of an earlier transaction.
transactionSrcCodeoptional	string	Identifies the source of the transaction.
transactionDescriptionoptional	string	Brief description of the transaction.
traceIdoptional	string	Source transaction identifier
transactionCodeBAI2optional	string	BAI2 transaction code

responseHeaders

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successfully retrieved.
statusDescriptionrequired	string	Description of the status.
dataLoadDateoptional	string	Indicates the date that the requested data was loaded. Format: YYYY-MM-DD
retrivedRowsoptional	string	Total number of transactions retrieved.
totalRowsoptional	string	Total number of transactions matching the requested criteria.

RTPData

NAME	TYPE	DESCRIPTION
creditArrangementTypeCodeoptional	string	Credit account type code
creditArrangementBankNumberoptional	string	Bank number holding the credit account.
creditArrangementBankBranchoptional	string	Bank branch holding the credit account.
creditArrangementCurrencyCodeoptional	string	Transaction currency code of the credit account.
creditInvolvedPartyIdentifieroptional	string	Customer number associated with the credit account.
creditInvolvedPartyNameoptional	string	Customer name associated with the credit account.
creditArrangementCountryCodeoptional	string	Country of the credit account.
creditInvolvedPartyTypeCodeoptional	string	Customer type associated with the credit account.
debitArrangementTypeCodeoptional	string	Debit account type code
debitArrangementBankNumberoptional	string	Bank number holding the debit account.
debitArrangementBankBranchoptional	string	Bank branch holding the debit account.
debitArrangementCurrencyCodeoptional	string	Transaction currency code of the debit account.
debitInvolvedPartyIdentifieroptional	string	Customer number associated with the debit account.
debitInvolvedPartyNameoptional	string	Customer name associated with the debit account.
transactionBusinessStatusCodeoptional	string	Transaction business status code
sendingBankReferenceNumberoptional	string	Reference number attached to a wire, issued by the sending bank.
originatingInvolvedPartyNameoptional	string	Name of the wire transaction originator.
originatingArrangementNumberoptional	string	Account number of the wire transaction originator.
originatingInvolvedPartyAddressLine1optional	string	Address line 1 of the wire transaction originator.
originatingInvolvedPartyAddressLine2optional	string	Address line 2 of the wire transaction originator.
beneficiaryInvolvedPartyNameoptional	string	Beneficiary of the wire payment.
beneficiaryArrangementNumberoptional	string	Account number of the beneficiary.
beneficiaryInvolvedPartyAddressLine1optional	string	Address line 1 of the beneficiary.
beneficiaryInvolvedPartyAddressLine2optional	string	Address line 2 of the beneficiary.
intermediaryBankNameoptional	string	Name of the intermediary bank.
intermediaryBankABANumberoptional	string	ABA number of the intermediary bank.
intermediaryBICCodeoptional	string	BIC number of the intermediary bank.
intermediaryBankAddressLine1optional	string	Address line 1 of the intermediary bank.
intermediaryBankAddressLine2optional	string	Address line 2 of the intermediary bank.
originatingBankNameoptional	string	Name of the wire originating bank.
originatingBankABANumberoptional	string	ABA number of the wire originating bank.
originatingBankBICcodeoptional	string	BIC number of the wire originating bank.
originatingBankAddressLine1optional	string	Address line 1 of the wire originating bank.
originatingBankAddressLine2optional	string	Address line 2 of the wire originating bank.
beneficiaryBankNameoptional	string	Name of the beneficiary bank.
beneficiaryBankABANumberoptional	string	ABA number of the beneficiary bank.
beneficiaryBankBICcodeoptional	string	BIC number of the beneficiary bank.
beneficiaryBankAddressLine1optional	string	Address line 1 of the beneficiary bank.
beneficiaryBankAddressLine2optional	string	Address line 2 of the beneficiary bank.
sourceTransactionIdentifieroptional	string	End-to-end ID to uniquely identify a transaction in source systems.
transactionSettledDateoptional	string	Date the transaction is settled. Format: MM-DD-YYYY
federalReferenceNumberoptional	string	Federal reference number
incomingReferenceNumberoptional	string	The incoming reference number, which is provided by the sending bank.
currencyExchangeRateoptional	string	Exchange rate
transactionExecutedDateoptional	string	Date the transaction is executed. Format: MM-DD-YYYY
bankToBankMemooptional	string	Free-form text transmitted between the banks.
transactionIdentifieroptional	string	Transaction identifier
transactionAmountoptional	string	The amount of the RTP transaction.

Summary

NAME	TYPE	DESCRIPTION
sourceArrangementNumberoptional	string	Account number
snapshotDateoptional	string	Date that requested data was loaded. Format: MM-DD-YYYY
sourceSystemOfRecordCodeoptional	string	This field is for internal purposes only.
currencyCodeoptional	string	Currency code of the transaction. Default value: USD
amountoptional	string	Transaction amount
amountTypeCodeoptional	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)
FundTypeCodeoptional	string	Code associated with the fund type.
itemCountoptional	string	Total number of transactions
processSequenceNumberoptional	string	Sequence number of the transaction.
earlyACHCreditoptional	string	Total credit amount as of 0600 posting window.
earlyACHDebitoptional	string	Total debit amount as of 0600 posting window.

SystemFault

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

WiresData

NAME	TYPE	DESCRIPTION
creditArrangementTypeCodeoptional	string	Credit account type code
creditArrangementBankNumberoptional	string	Bank number holding the credit account.
creditArrangementBankBranchoptional	string	Bank branch holding the credit account.
creditArrangementCurrencyCodeoptional	string	Transaction currency code of the credit account.
creditInvolvedPartyIdentifieroptional	string	Customer number associated with the credit account.
creditInvolvedPartyNameoptional	string	Customer name associated with the credit account.
creditArrangementCountryCodeoptional	string	Country of the credit account.
creditInvolvedPartyTypeCodeoptional	string	Customer type associated with the credit account.
debitArrangementTypeCodeoptional	string	Debit account type code
debitArrangementBankNumberoptional	string	Bank number holding the debit account.
debitArrangementBankBranchoptional	string	Bank branch holding the debit account.
debitArrangementCurrencyCodeoptional	string	Transaction currency code of the debit account.
debitInvolvedPartyIdentifieroptional	string	Customer number associated with the debit account.
debitInvolvedPartyNameoptional	string	Customer name associated with the debit account.
transactionBusinessStatusCodeoptional	string	Transaction business status code
sendingBankReferenceNumberoptional	string	Reference number attached to a wire, issued by the sending bank.
originatingInvolvedPartyNameoptional	string	Name of the wire transaction originator.
originatingArrangementNumberoptional	string	Account number of the wire transaction originator.
originatingInvolvedPartyAddressLine1optional	string	Address line 1 of the wire transaction originator.
originatingInvolvedPartyAddressLine2optional	string	Address line 2 of the wire transaction originator.
beneficiaryInvolvedPartyNameoptional	string	Beneficiary of the wire payment.
beneficiaryArrangementNumberoptional	string	Account number of the beneficiary.
beneficiaryInvolvedPartyAddressLine1optional	string	Address line 1 of the beneficiary.
beneficiaryInvolvedPartyAddressLine2optional	string	Address line 2 of the beneficiary.
intermediaryBankNameoptional	string	Name of the intermediary bank.
intermediaryBankABANumberoptional	string	ABA number of the intermediary bank.
intermediaryBICCodeoptional	string	BIC number of the intermediary bank.
intermediaryBankAddressLine1optional	string	Address line 1 of the intermediary bank.
intermediaryBankAddressLine2optional	string	Address line 2 of the intermediary bank.
originatingBankNameoptional	string	Name of the wire originating bank.
originatingBankABANumberoptional	string	ABA number of the wire originating bank.
originatingBankBICcodeoptional	string	BIC number of the wire originating bank.
originatingBankAddressLine1optional	string	Address line 1 of the wire originating bank.
originatingBankAddressLine2optional	string	Address line 2 of the wire originating bank.
beneficiaryBankNameoptional	string	Name of the beneficiary bank.
beneficiaryBankABANumberoptional	string	ABA number of the beneficiary bank.
beneficiaryBankBICcodeoptional	string	BIC number of the beneficiary bank.
beneficiaryBankAddressLine1optional	string	Address line 1 of the beneficiary bank.
beneficiaryBankAddressLine2optional	string	Address line 2 of the beneficiary bank.
sourceTransactionIdentifieroptional	string	End-to-end ID to uniquely identify a transaction in source systems.
transactionSettledDateoptional	string	Date the transaction is settled. Format: MM-DD-YYYY
federalReferenceNumberoptional	string	Federal reference number
incomingReferenceNumberoptional	string	The incoming reference number, which is provided by the sending bank.
currencyExchangeRateoptional	string	Exchange rate
transactionExecutedDateoptional	string	Date the transaction is executed. Format: MM-DD-YYYY
bankToBankMemooptional	string	Free-form text transmitted between the banks.
transactionIdentifieroptional	string	Transaction identifier
transactionAmountoptional	string	The amount of the wire transaction.

Errors

For more information about general errors, see Error handling.

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.

YAML file

Enjoy embedded banking made easy

The KeyBank Developer Portal has everything you need to bring our services to your software. Browse a suite of flexible APIs and read our comprehensive documentation. Integrate, test, and take it live. Better banking begins now.

Explore APIs

Hero_illustrationConstruction crew and equipment putting together a development website.

Why KeyBank?

It’s simple. We designed our self-service developer portal for one thing: easy and effective embedded banking. And we deliver it by offering all the technology you need with a guided, personal touch.

A computer screen with the cursor pointing on a window box.

Flexible APIs

Complete with comprehensive documentation and helpful user guides, our APIs take the guess work out of your work. Browse the API products we offer.

Easy onboarding

The Getting Started Guide gets you up and running in a hurry. We’ll help you through the process with a few tips and tricks for a smooth ride.

KeyVAM

Key Virtual Account Management (KeyVAM) is a digital solution to manage multiple accounts with one physical account. Go to KeyVAM site to learn more.

Laptop with code screen and beaker for experiments.

API Simulator

Simulate dynamic request and response operations to get a better understanding of the APIs. We currently offer this experience for our ACH APIs.

Explore the possibilities

What can you do with KeyBank APIs? Well, for starters, you can:

Confirm accounts before paying
Help keep your money safe by verifying the status of a payer or payee before sending any payments.

Verify an account and its owner.

View specs | View guide

Make and manage payments
Move and track money quickly with super-fast payment options, easy stops, and instant status checks.

Create and send a real-time payment.

View specs

Stop an issued payment.

View specs

Make an ACH payment.

View specs | View guide

Prepare and send a wire payment.

View specs

Review your account activity
See how your money moves with comprehensive, on-demand reporting and recordkeeping for all transactions.

Get past transaction activity.

View specs

Get transaction activity for the current day.

View specs

Get a single check image.

View specs

Get the status of an ACH payment.

View specs | View guide

Get the status of a wire payment.

View specs

How to get started

Integrating our APIs into your software is easy. Here's how it works:

LEARN MORE

Explore the portal to learn more about KeyBank APIs.

Get involved

Onboard with KeyBank and exchange certificates.

Begin Testing

Test our APIs with your data in a certified and secure environment.

Go Live

Create API sequences and publish your work.

Start here

Subscribe to