Use the ACH Inquiry API to get the status for ACH transactions as they are received and processed by KeyBank.
For clients with a non-consolidated settlement, you will receive collected (in progress), posted (processed), returned transactions. For clients with a consolidated settlement, you will only receive collected and returned transactions. Posted transactions is not an available status for consolidated settlement.
Before you begin
All KeyBank APIs require certificates, user credentials, and certain permissions. Before you begin, see Key concepts to learn more about these fundamental elements as well as other recommended best practices.
API-specific requirements
Trace number
You get a trace number after you initiate an ACH transaction. The trace number is a unique identifier for an ACH transaction generated by the API. The trace number is useful for the transaction inquiries and traceability. Save this trace number if you intend to check on the progress of the ACH transaction. For status inquiries of multiple transactions, separate the trace numbers with a comma.
PAR number
The PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. This is used to identify the transaction without exposing any sensitive consumer identification information. To get the status of multiple transactions with the PAR number, separate the numbers with a comma.
Custom data fields
Responses will return custom data fields from the originating payment request for ACH returned, collected, and posted transactions. The custom data fields are customData
and receivingCustIdentificationNumber
. The receivingCustIdentificationNumber
field is the unique ID associated with the payment recipient. The customData
field returns any custom fields that were part of the originating payment request stored for recall after a successful ACH transaction completes. The request uses the trace number or PAR number to retrieve the custom data.
ACH Inquiry Endpoints
Summary | Endpoint |
---|---|
Get the status of ACH transactions | post /accounts/transactions/v1/ACHStatusInquiry/list |
Get detailed information about a collected transaction | post /accounts/transactions/v1/collectedACHtransactions/list |
Get the status of posted ACH transactions | post /accounts/transactions/v1/postedACHtransactions/list |
Get the status of a returned ACH transaction | post /accounts/transactions/v1/returnACHtransactions/list |
Get the status of ACH transactions
post /accounts/transactions/v1/ACHStatusInquiry/list
Inquire about the status of an ACH transaction with a trace number or PAR number. Use the trace number or PAR number from the response of the originating transaction request. You cannot use both the trace number and PAR number for a query. You can look up multiple transactions with either number. When you submit an inquiry for multiple numbers, separate the values with a comma.
Request
header FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | A universal ID to trace the transaction across all the systems involved, useful for system logging and identification. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
Get the status of ACH transactionsoptional | oneOf | achStatusInquiryParRequest achStatusInquiryTraceNumberRequest |
Request example

{ "getACHStatusInquiryRequest": { "accountNumber": [ "987654321", "123456789" ], "parNumber": [ "22018007665985" ], "traceNumber": [], "mdmId": "ABCD12FG34", "startRowIndex": "1", "endRowIndex": "" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHTransactionStatusoptional | array | achStatusInquiryResult |
errorResponseoptional | Object | errorResponse |
Response example (200)

{ "responseHeader": { "status": "S", "statusDescription": "Successfully returned results for the requested range 1 to 1000", "retrivedRows": "1", "totalRows": "1", "dataLoadDate": "2023-03-10" }, "ACHTransactionStatus": [ { "ACHStatus": "COLLECTED", "ACHCollectedTransaction": { "transactionParNumber": "1234567891113", "sourceBankNumber": "1234", "sourceAccountNumber": "123456789", "transactionCode": "22", "transactionAmount": "10.01", "creditOrDebitCode": "C", "sourceTransactionProcessDate": "2021-03-08", "sourceTransactionProcessTime": "060011", "sourceTransactionProcessTimestamp": "2021-03-08 06:00:11", "sourceTransactionPostDate": "2021-03-08", "receivingCustomerName": "TEST COMPANY 1, LLC", "receivingCompanyName": "TEST COMPANY 2, LLC", "receivingCustIdentificationNumber": "TESTCOMPANY", "originatingCompanyName": "TESTCOMPANY VRU", "originatingCustomerName": "TEST CORP DEP", "nachaSecCode": "ABC", "traceNumber": "000000000000000", "transactionDescription": "VALIDATION" } } ] }
Missing data
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": "Please make sure your request is correct and try again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "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": "Please make sure you're using the correct credentials. Then log in again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access denied
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": "You don't have access to this resource. Contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
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": "We can't seem to find what you're looking for. Please verify the resource and try again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method denied
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": "Looks like something went wrong. Please check your request method and try again.\"", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Media type not supported
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": "We currently don't support that format. Please check the format type defined in your request and try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests
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": "Looks like you've sent too many requests. Please wait a moment and try again later.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "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": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution. ", "TransactionId": "rrt-770941720727587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "2ebd0e8d5a70-e91", "ServiceError": { "ConnectError": "A connectivity error occurred with the downstream service(unexpected end of file at the target). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Service unavailable
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": "Looks like something went wrong. Please try again later. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "This service is currently unavailable(there are no active targets). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Gateway 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 (504)

{ "ErrorMessage": "Your request took too long to process. Please try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "The request could not be processed on time (gateway timeout). Please wait a moment and try again later." } }
Get detailed information about a collected transaction
post /accounts/transactions/v1/collectedACHtransactions/list
Look up a list of collected ACH transactions by account number and date.
Request
header FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | A universal ID to trace the transaction across all the systems involved, useful for system logging and identification. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
getACHCollectedTransactionsRequestoptional | Object | getACHCollectedTransactionsRequest |
Request example

{ "getACHCollectedTransactionsRequest": { "accountNumber": [ "123456789" ], "fromDate": "2022-03-12", "toDate": "2022-04-12", "sourceTransactionSettledDate": "2022-04-12", "creditOrDebitCode": "C", "fromAmount": "01.00", "toAmount": "180.00", "addendaFlag": "N", "secCode": "", "traceNumber": "0612123100888473", "parNumber": "", "detailsFlag": "N", "mdmId": "ABCD12FG34", "startRowIndex": "1", "endRowIndex": "1" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHCollectedTransactionsResponserequired | Object | getACHCollectedTransactionsResponse |
Response example (200)

{ "getACHCollectedTransactionsResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully returned results for the requested range 1 to 1", "retrivedRows": "1", "totalRows": "1", "dataLoadDate": "2022-04-07" }, "ACHCollectedTransaction": [ { "transactionParNumber": "22081003123797", "sourceBankNumber": "1000", "sourceAccountNumber": "123456789", "origAcctSuffix": "XX", "sourceSysCode": "DDA", "sourceSysOfRecordCode": "ACH", "snapshotDate": "2022-03-22", "transactionCode": "22", "transactionCodeDescription": "Automated Deposit", "transactionFlowTypeCode": "INTRA", "transactionFlowTypeDescription": "Intrabank", "originatingReceiverCode": "OI", "transactionAmount": "31.05", "transactionDescription": "DEPOSIT", "creditOrDebitCode": "C", "inboundCollectionWindow": "0500", "sourceTransactionProcessDate": "2022-03-22", "sourceTransactionProcessTime": "050022", "sourceTransactionProcessTimestamp": "2022-03-22 05:00:22", "sourceTransactionSettledDate": 1647907200, "sourceTransactionSettledTime": "1715", "sourceTransactionSettledTimestamp": "2022-03-22 17:15:42", "sourceTransactionPostDate": "2022-03-22", "sourceTransactionPostTime": "1716", "sourceTransactionPostTimestamp": "2022-03-22 17:16:02", "deliveryStatusCode": "DEL", "deliveryStatusDescription": "DELIVERED", "receivingAccountNumber": "987654321", "receivingFIBankNumber": "0001", "receivingFIRoutingNumber": "123456789", "receivingCustIdentificationNumber": "1234567", "receivingCustomerName": "CUSTOMER NAME 1", "receivingCompanyName": "COMPANY NAME 1", "originatingAccountNumber": "123456789012", "originatingFIBankNumber": "0000", "originatingFIRoutingNumber": "1234567890", "originatingCustIdentificationNumber": "0580215200", "originatingCompanyName": "MERCHANT", "originatingCustomerName": "TEST MERCHANT", "checkSerialNumber": "4345", "nachaBatchNumber": "0000006", "nachaFileHeadRefererenceNumber": "22081000015", "nachaSecCode": "CCD", "nachaSecDescription": "Cash Concentration or Disbursement", "traceNumber": "061000100888473", "addendaPresentFlag": "0", "addendaRecordNumber": "0000000000", "originatingReceiverDescription": "Originating Item", "goRoutingNumber": "222370040", "authorizedCustomerName": "TEST CUSTOMER1", "iatFlag": "N", "collectionPoint": "TESTPOINT", "batchId": "26052", "transactionTraceId": "041001032851213", "addendaInformation": { "nonIatAddendum": { "addendaParNumber": "21063004069232", "payInformation": "TXP51662854201101210305T*0004081318", "addendaTypeCode": "05", "addendaTypeDescription": "Addenda Record (Applies to CCD, CIE, CTX, PPD, TRX, and WEB entries)", "entryDetailSequenceNumber": "986756", "keyBankTransactionReferenceNumber": "0" } }, "customData": "merchant:status" } ] } }
Missing data
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": "Please make sure your request is correct and try again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "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": "Please make sure you're using the correct credentials. Then log in again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access denied
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": "You don't have access to this resource. Contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
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": "We can't seem to find what you're looking for. Please verify the resource and try again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method denied
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": "Looks like something went wrong. Please check your request method and try again.\"", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Media type not supported
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": "We currently don't support that format. Please check the format type defined in your request and try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests
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": "Looks like you've sent too many requests. Please wait a moment and try again later.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "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": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution. ", "TransactionId": "rrt-770941720727587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "2ebd0e8d5a70-e91", "ServiceError": { "ConnectError": "A connectivity error occurred with the downstream service(unexpected end of file at the target). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Service unavailable
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": "Looks like something went wrong. Please try again later. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "This service is currently unavailable(there are no active targets). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Gateway 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 (504)

{ "ErrorMessage": "Your request took too long to process. Please try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "The request could not be processed on time (gateway timeout). Please wait a moment and try again later." } }
Get the status of posted ACH transactions
post /accounts/transactions/v1/postedACHtransactions/list
Retrieves a list of posted ACH transactions for queried accounts.
Request
header FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | A universal ID to trace the transaction across all the systems involved, useful for system logging and identification. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
getACHPostedTransactionsRequestoptional | Object | getACHPostedTransactionsRequest |
Request example

{ "getACHPostedTransactionsRequest": { "accountNumber": [ "123456789" ], "fromDate": "2022-01-12", "toDate": "2022-04-12", "creditOrDebitCode": "", "fromAmount": "01.00", "toAmount": "180.00", "parNumber": "", "mdmId": "ABCD12FG34", "startRowIndex": "1", "endRowIndex": "1" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHPostedTransactionsResponserequired | Object | getACHPostedTransactionsResponse |
Response example (200)

{ "getACHPostedTransactionsResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully returned results for the requested range 1 to 1", "retrivedRows": "1", "totalRows": "1", "dataLoadDate": "2022-03-04" }, "ACHPostedTransaction": [ { "snapshotDate": "2022-02-04", "processDate": "2022-02-04", "sourceBankNumber": "0000", "sourceAccountNumber": "987654321", "transactionParNumber": "22023411528113", "transactionAmount": "10.0", "creditOrDebitCode": "C", "hoganTransactionCode": "1007", "baiCode": "169", "transactionCode": "22", "regulationDescription1": "TEST CORP DEP", "regulationDescription2": "TEST*527042600*01101*2", "regulationDescription3": "20201**04324", "postingWindow": "0600", "batchID": "18102" } ] } }
Missing data
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": "Please make sure your request is correct and try again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "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": "Please make sure you're using the correct credentials. Then log in again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access denied
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": "You don't have access to this resource. Contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
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": "We can't seem to find what you're looking for. Please verify the resource and try again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method denied
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": "Looks like something went wrong. Please check your request method and try again.\"", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Media type not supported
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": "We currently don't support that format. Please check the format type defined in your request and try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests
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": "Looks like you've sent too many requests. Please wait a moment and try again later.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "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": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution. ", "TransactionId": "rrt-770941720727587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "2ebd0e8d5a70-e91", "ServiceError": { "ConnectError": "A connectivity error occurred with the downstream service(unexpected end of file at the target). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Service unavailable
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": "Looks like something went wrong. Please try again later. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "This service is currently unavailable(there are no active targets). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Gateway 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 (504)

{ "ErrorMessage": "Your request took too long to process. Please try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "The request could not be processed on time (gateway timeout). Please wait a moment and try again later." } }
Get the status of a returned ACH transaction
post /accounts/transactions/v1/returnACHtransactions/list
Retrieve a list of returned ACH transactions for queried accounts.
Request
header FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | A universal ID to trace the transaction across all the systems involved, useful for system logging and identification. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
getACHReturnTransactionsRequestoptional | Object | getACHReturnTransactionsRequest |
Request example

{ "getACHReturnTransactionsRequest": { "accountNumber": [ "123456789" ], "fromDate": "2021-06-12", "toDate": "2021-07-12", "creditOrDebitCode": "C", "fromAmount": "01.00", "toAmount": "180.00", "parNumber": "", "detailsFlag": "Y", "mdmId": "ABCD12FG34", "startRowIndex": "1", "endRowIndex": "10" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHReturnTransactionsResponseoptional | Object | achReturnTransactionsResponse |
Response example (200)

{ "getACHReturnTransactionsResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully returned results for the requested range 1 to 1", "retrivedRows": "1", "totalRows": "1", "dataLoadDate": "2022-07-16" }, "ACHReturnTransaction": [ { "returnTransactionParNumber": "21181233817881", "sourceBankNumber": "1234", "sourceAccountNumber": "123456789", "sourceTransactionRecordNumber": "2118123373937", "sourceSysCode": "DDA", "sourceSysOfRecordCode": "ACH", "snapshotDate": "2021-07-22", "originalACHTransactionParNumber": "21176003985391", "originalTransactionProcessDate": "2021-06-25", "originalTransactionProcessTime": "153644", "originalTransactionProcessTimestamp": "2021-06-25 15:36:44", "originatingReceiverCode": "OR", "originatingReceiverDescription": "Originating Return", "transactionCode": "21", "transactionCodeDescription": "Automated Return or Notification of Change for original transaction code 22, 23, or 24", "transactionFlowTypeCode": "INTRA", "transactionFlowTypeDescription": "Intrabank", "transactionAmount": "128.7", "transactionDescription1": "RETURN NOTE", "creditOrDebitCode": "C", "sourceTransactionCreatedDate": "2021-06-25", "sourceTransactionCreatedTime": "1406", "sourceTransactionCreatedTimestamp": "2021-06-25 14:06:00", "sourceTransactionProcessDate": "2021-06-25", "sourceTransactionProcessTime": "153644", "sourceTransactionProcessTimestamp": "2021-06-25 15:36:44", "inboundCollectionWindow": "1600", "outboundCollectionWindow": "2000", "sourceTransactionSettledDate": "2021-06-28", "receivingAccountNumber": "12345123234", "receivingCustIdentificationNumber": "34344", "receivingCustomerName": "Test receiveCustomer Name", "receivingCompanyName": "Test receiveCompany Name", "receivingFIBankNumber": "1234", "receivingFIRoutingNumber": "437364783", "originatingAccountNumber": "123456789", "originatingCustIdentificationNumber": "146013200U", "originatingCustomerName": "Test origCustomerName", "originatingCompanyName": "Test origCompanyName", "originatingFIBankNumber": "5556", "originatingFIRoutingNumber": "454646334", "authorizedCustomerName": "Test authCustName", "immediateDestinationID": "021300077", "returnReleaseDate": "2021-06-29", "returnReasonCode": "R02", "returnReasonDescription": "Account Closed", "nachaBatchNumber": "0000013", "nachaFileHeadRefererenceNumber": "21176000442", "nachaSecCode": "PPD", "nachaSecDescription": "Prearranged Payment & Deposit Entry", "traceId": "041001012851361", "collectionPoint": "TESTPOINT", "batchID": "1125" } ] } }
Missing data
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": "Please make sure your request is correct and try again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "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": "Please make sure you're using the correct credentials. Then log in again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access denied
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": "You don't have access to this resource. Contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
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": "We can't seem to find what you're looking for. Please verify the resource and try again.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method denied
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": "Looks like something went wrong. Please check your request method and try again.\"", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Media type not supported
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": "We currently don't support that format. Please check the format type defined in your request and try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests
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": "Looks like you've sent too many requests. Please wait a moment and try again later.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "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": "Looks like something went wrong. Please try again when you're ready. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution. ", "TransactionId": "rrt-770941720727587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "2ebd0e8d5a70-e91", "ServiceError": { "ConnectError": "A connectivity error occurred with the downstream service(unexpected end of file at the target). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Service unavailable
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": "Looks like something went wrong. Please try again later. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "This service is currently unavailable(there are no active targets). Please check with your KeyBank Client Success Manager or email developers@keybank.com before trying the request again." } }
Gateway 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 (504)

{ "ErrorMessage": "Your request took too long to process. Please try again. If you experience more issues, contact your KeyBank Client Success Manager or email developers@keybank.com for help with a resolution.", "TransactionId": "rrt-770941720727587-2383364-1", "X-CorrelationId": "2ebd0e8d5a70-e91", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "The request could not be processed on time (gateway timeout). Please wait a moment and try again later." } }
Schemas
achCollectedTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHCollectedTransactionsRequestoptional | Object | getACHCollectedTransactionsRequest |
achCollectedTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHCollectedTransactionsResponserequired | Object | getACHCollectedTransactionsResponse |
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. |
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. |
achPostedTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHPostedTransactionsRequestoptional | Object | getACHPostedTransactionsRequest |
achPostedTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHPostedTransactionsResponserequired | Object | getACHPostedTransactionsResponse |
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. |
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 |
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 intra-bank (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. |
achReturnTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHReturnTransactionsRequestoptional | Object | getACHReturnTransactionsRequest |
achReturnTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHReturnTransactionoptional | array | ACHReturnTransaction |
errorResponseoptional | Object | errorResponse |
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. |
achStatusInquiryParRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHStatusInquiryRequestoptional | Object | getACHStatusInquiryParRequest |
achStatusInquiryResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHTransactionStatusoptional | array | achStatusInquiryResult |
errorResponseoptional | Object | errorResponse |
achStatusInquiryResult
NAME | TYPE | DESCRIPTION |
---|---|---|
ACHStatusoptional | string | The status what stage the ACH transaction is at in its lifecycle once it has been received by KeyBank. Valid values: COLLECTED, POSTED, or RETURNED |
ACHCollectedTransactionoptional | Object | achCollectedTransactionsStatusResult |
ACHPostedTransactionoptional | Object | achPostedTransactionsStatusResult |
ACHReturnTransactionoptional | Object | achReturnTransactionsStatusResult |
achStatusInquiryTraceNumberRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHStatusInquiryRequestoptional | Object | getACHStatusInquiryTraceNumberRequest |
addendaInformation
NAME | TYPE | DESCRIPTION |
---|---|---|
iatAddendumoptional | Object | iatAddendum |
nonIatAddendumoptional | Object | nonIatAddendum |
nocAddendumoptional | Object | nocAddendum |
businessFault
NAME | TYPE | DESCRIPTION |
---|---|---|
errorCodeoptional | string | Business error code |
errorDescriptionoptional | string | Business error description |
connectError
NAME | TYPE | DESCRIPTION |
---|---|---|
ConnectErroroptional | string | API connectivity error information, if available. |
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 |
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 starting date range for the transaction. The date must be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD |
toDaterequired | string | The ending date range for the transaction. The date must be be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD |
sourceTransactionSettledDateoptional | string | Date when the transaction is settled. 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. |
mdmIdoptional | string | The MDM ID will soon deprecate. This is an ID number that can associate with a single account or many accounts for verification and data retrieval. |
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. |
getACHCollectedTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHCollectedTransactionoptional | array | achCollectedTransactionsResult |
errorResponseoptional | Object | errorResponse |
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 starting date range for the transaction. The date must be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD |
toDaterequired | string | The ending date range for the transaction. The date must be be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. 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. |
mdmIdoptional | string | The MDM ID will soon deprecate. This is an ID number that can associate with a single account or many accounts for verification and data retrieval. |
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. |
getACHPostedTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHPostedTransactionoptional | array | achPostedTransactionsResult |
errorResponseoptional | Object | errorResponse |
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 starting date range for the transaction. The date must be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD |
toDaterequired | string | The ending date range for the transaction. The date must be be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. 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. |
mdmIdoptional | string | The MDM ID will soon deprecate. This is an ID number that can associate with a single account or many accounts for verification and data retrieval. |
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. |
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. |
mdmIdoptional | string | The MDM ID will soon deprecate. This is an ID number that can associate with a single account or many accounts for verification and data retrieval. |
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. |
mdmIdoptional | string | The MDM ID will soon deprecate. This is an ID number that can associate with a single account or many accounts for verification and data retrieval. |
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. |
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 |
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 |
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 |
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 |
returnACHtransactionslistResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHReturnTransactionsResponseoptional | Object | achReturnTransactionsResponse |
serviceErrorData
NAME | TYPE | DESCRIPTION |
---|---|---|
ServiceErrorDataoptional | oneOf | returnACHtransactionslistResponse achCollectedTransactionsResponse achPostedTransactionsResponse achStatusInquiryResponse |
systemFault
NAME | TYPE | DESCRIPTION |
---|---|---|
errorCodeoptional | string | System error code |
errorDescriptionoptional | string | System error description |
Errors
For more information about errors, see Error handling.
Error codes and messages
Standard errors use the typical HTTP status codes. Messages specific to KeyBank have an asterisk (*) after the message code number. The ServiceError > errorResponse
object has additional information specific to the API.
KeyBank error codes start with ECA-W with a three-digit number that follows. The number increases by one digit for each error message. For example, if you have an issue with your request that generates two error messages specific to the API, the codes will be ECA-W-001 and ECA-W-002.
HTTP STATUS CODE | CUSTOM STATUS CODE | DESCRIPTION |
---|---|---|
299* | Request processing completed with warnings.
Status is W for Warning. This message occurs when multiple request parameters are provided, and some of the data are not available as part of response. |
|
400* | ECA-W-001 | Request Validation failed.
Status is F for Failure. There is missing mandatory information like accountNumber, fromDate, or toDate. Review values for mandatory request fields. |
400* | ECA-W-001 | Requested records range is greater than the allowed limit - 1000
Status is F for Failure. Response goes beyond 1000 transactions for the requested account. Change the request criteria to help limit returned transactions to the allowed amount. |
YAML file
