Use the ACH Inquiry API to get the status on ACH transactions based on your query criteria.
For clients with a non-consolidated settlement, you 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.
Prerequisites and best practices
KeyBank has some common prerequisites and best practices. All KeyBank APIs require certifications, user credentials, and certain permissions. Make sure to satisfy all prerequisites before building your API.
Follow these steps to prepare for operations:
-
Have valid certificates for a secure connection.
-
Make sure you have the API keys needed for basic authentication and API access.
-
Request a bearer token before you start.
-
Check the health of the API.
-
Know your MDM ID.
-
Have a trace number or PAR number.
-
Review the custom data fields, if present.
Certificates
Certificates are a digital authentication method we use to encrypt the information exchanged between KeyBank and your app or service. To access KeyBank environments, you must exchange valid certificates with KeyBank. These certificates must be properly installed on your system before you start to send API calls.
API keys
You need API keys to get a bearer token and to grant access to the APIs and the Pre-Production or Production environments. These API keys are created only for authenticated users that have partnered with KeyBank. For more information, see API security or sign up to become a KeyBank API consumer
Bearer token
Get a bearer token before you start. Only authenticated users with client credentials can request a bearer token. For more information, see API security or sign up to become a KeyBank API consumer
Health check
Before you start building your API, perform a quick health check. A health check verifies that the API is operational and responding correctly with your system. A bearer token is required to perform a health check. For more information, see Health check.
MDM ID
KeyBank assigns a Master Data Management (MDM) ID to each client. The MDM ID is used for account entitlement. This ID needs to be part of the API request to authorize the account’s data retrieval. The MDM ID can associate an ID with a single account or many accounts for verification and data retrieval. The MDM ID is shared via secure email.
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 attend 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.
Endpoints
Endpoint | Result | Description |
---|---|---|
post /accounts/transactions/v1/returnACHtransactions/list | Get the status of a returned ACH transaction | Retrieve a list of returned ACH transactions for queried accounts. |
post /accounts/transactions/v1/collectedACHtransactions/list | Get detailed information about a collected transaction | Retrieve a list of collected ACH transactions for queried accounts. |
post /accounts/transactions/v1/postedACHtransactions/list | Get the status of posted ACH transactions | Retrieves a list of posted ACH transactions for queried accounts. |
post /accounts/transactions/v1/ACHStatusInquiry/list | Get the status of ACH transactions | Get a status report on ACH transactions and their progress. |
Get the status of a returned ACH transaction
post /accounts/transactions/v1/returnACHtransactions/list
Look up the status of an ACH transaction that has been returned by account number and date. To manage your returns, KeyBank recommends that you inquire on your returns daily.
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | The universal ID to trace the transaction across all the systems involved. The ID is unique to each request. The ID must be alphanumeric with no spaces and cannot exceed 16 characters. If this field is left blank, the system generates a unique ID with the response. |
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", "receivingCustIdentificationNumber": "H874C6427 13", "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" } ] } }
Mandatory data not provided
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (400)

{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (401)

{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access Denied for client ip
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (403)

{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (404)

{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (405)

{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media type
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (415)

{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (429)

{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad Gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request." } }
Get 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. Collected ACH transactions are payment transactions pulled from an external account.
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | The universal ID to trace the transaction across all the systems involved. The ID is unique to each request. The ID must be alphanumeric with no spaces and cannot exceed 16 characters. If this field is left blank, the system generates a unique ID with the response.CorrelationId is unique per request. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
getACHCollectedTransactionsRequestoptional | Object | getACHCollectedTransactionsRequest |
Request example

{ "getACHCollectedTransactionsRequest": { "accountNumber": [ "123456789" ], "fromDate": "2022-03-12", "toDate": "2022-04-12", "creditOrDebitCode": "C", "fromAmount": "01.00", "toAmount": "180.00", "addendaFlag": "N", "secCode": "", "traceNumber": "0612123100888473", "parNumber": "", "detailsFlag": "N", "receivingCustIdentificationNumber": "H874C6427 13", "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", "sourceSysCode": "DDA", "sourceSysOfRecordCode": "ACH", "snapshotDate": "2022-03-22", "transactionCode": "22", "transactionCodeDescription": "Automated Deposit", "transactionFlowTypeCode": "INTRA", "transactionFlowTypeDescription": "Intrabank", "transactionAmount": "31.05", "transactionDescription": "DEPOSIT", "creditOrDebitCode": "C", "inboundCollectionWindow": "0500", "sourceTransactionProcessDate": "2022-03-22", "sourceTransactionProcessTime": "050022", "sourceTransactionProcessTimestamp": "2022-03-22 05:00:22", "sourceTransactionPostDate": "2022-03-22", "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", "nachaBatchNumber": "0000006", "nachaFileHeadRefererenceNumber": "22081000015", "nachaSecCode": "CCD", "nachaSecDescription": "Cash Concentration or Disbursement", "traceNumber": "061000100888473", "traceId": "041001032851213", "addendaPresentFlag": "1", "addendaRecordNumber": "0000000000", "originatingReceiverCode": "OI", "originatingReceiverDescription": "Originating Item", "goRoutingNumber": "222370040", "authorizedCustomerName": "TEST CUSTOMER1", "iatFlag": "N", "collectionPoint": "TESTPOINT", "batchId": "26052", "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" } } } ] } }
Mandatory data not provided
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (400)

{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (401)

{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access Denied for client ip
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (403)

{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (404)

{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (405)

{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media type
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (415)

{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (429)

{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad Gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request." } }
Get the status of posted ACH transactions
post /accounts/transactions/v1/postedACHtransactions/list
Look up a list of posted ACH transactions by account number and date. Posted ACH transactions are completed transactions that have been fully processed.
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-CorrelationIdoptional | string | The universal ID to trace the transaction across all the systems involved. The ID is unique to each request. The ID must be alphanumeric with no spaces and cannot exceed 16 characters. If this field is left blank, the system generates a unique ID with the response.CorrelationId is unique per request. |
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 |
---|---|---|
getACHCollectedTransactionsResponseoptional | 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": "165", "transactionCode": "22", "regulationDescription1": "TEST CORP DEP", "regulationDescription2": "TEST*527042600*01101*2", "regulationDescription3": "20201**04324", "postingWindow": "0600", "batchID": "18102" } ] } }
Mandatory data not provided
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (400)

{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (401)

{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access Denied for client ip
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (403)

{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (404)

{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (405)

{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media type
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (415)

{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (429)

{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad Gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request." } }
Get the 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 | The universal ID to trace the transaction across all the systems involved. The ID is unique to each request. The ID must be alphanumeric with no spaces and cannot exceed 16 characters. If this field is left blank, the system generates a unique ID with the response.CorrelationId is unique per request. |
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)

{ "getACHStatusInquiryResponse": { "responseHeader": { "status": "S", "statusDescription": "Successfully returned results for the requested range 1 to 1", "retrivedRows": "1", "totalRows": "1", "dataLoadDate": "2022-07-13" }, "ACHTransactionStatus": [ { "ACHStatus": "RETURNED", "ACHCollectedTransaction": { "transactionParNumber": "22018007665985", "sourceBankNumber": "1000", "sourceAccountNumber": "123456789", "transactionCode": "27", "transactionAmount": "789", "creditOrDebitCode": "D", "sourceTransactionProcessDate": "2022-01-19", "sourceTransactionProcessTime": "113148", "sourceTransactionProcessTimestamp": "2022-01-19 11:31:48", "sourceTransactionSettledDate": "2022-01-20", "sourceTransactionPostDate": "2022-01-20", "receivingCustomerName": "Receving Test Customer Name", "receivingCompanyName": "Receving Test Company Name", "originatingCompanyName": "Originating Test Company Name", "nachaSecCode": "WEB", "traceNumber": "061000100888473", "transactionDescription": "WEB PYMT" }, "ACHReturnTransaction": { "transactionParNumber": "22042012028293", "transactionCode": "26", "transactionCodeDescription": "Automated Return or Notification of Change for original transaction code 27, 28, or 29", "transactionAmount": "789", "transactionDescription1": "WEB PYMT", "transactionDescription2": "S", "creditOrDebitCode": "D", "returnReleaseDate": "2022-02-11", "returnReasonCode": "R10", "returnReasonDescription": "Customer Advises Unauthorized, Improper, Ineligible, or part of an Incomplete Transaction" } } ] } }
Mandatory data not provided
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (400)

{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (401)

{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Access Denied for client ip
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (403)

{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (404)

{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (405)

{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media type
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (415)

{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (429)

{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad Gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time(GatewayTimeout), please wait a moment and resubmit the request." } }
Schemas
exception
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | Error message related to system generating this error. |
TransactionIdoptional | string | Unique functional identifier from the data to identify a message. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
serviceErrorData
NAME | TYPE | DESCRIPTION |
---|---|---|
ServiceErrorDataoptional | oneOf | returnACHtransactionslistResponse achCollectedTransactionsResponse achPostedTransactionsResponse achStatusInquiryResponse |
connectError
NAME | TYPE | DESCRIPTION |
---|---|---|
ConnectErroroptional | string | Error information of the connectivity with downstream service. |
returnACHtransactionslistResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHReturnTransactionsResponseoptional | Object | achReturnTransactionsResponse |
ACHReturnTransaction
NAME | TYPE | DESCRIPTION |
---|---|---|
returnTransactionParNumberoptional | string | ACH Product Processor assigned transaction unique number. |
sourceBankNumberoptional | string | Originating Entry Bank Number. |
sourceAccountNumberoptional | string | The account number associated with the transaction. |
sourceTransactionRecordNumberoptional | string | Source transaction Record number. |
sourceSysCodeoptional | string | This field is for internal purpose only. |
sourceSysOfRecordCodeoptional | string | This field is for internal purpose only. |
snapshotDateoptional | string | This field is for internal purpose only. |
originalACHTransactionParNumberoptional | string | ACH Product Processor assigned unique number for the original ACH transaction. |
originalTransactionProcessDateoptional | string | Date the Original ACH transaction to be processed. |
originalTransactionProcessTimeoptional | string | Time the Original ACH transaction to be processed. |
originalTransactionProcessTimestampoptional | string | Timestamp the Original ACH transaction to be processed. |
originatingReceiverCodeoptional | string | Identifies the type Originating/Receiving and Incoming/Outgoing. |
originatingReceiverDescriptionoptional | string | Description of Originating Receiver Code. |
transactionCodeoptional | string | Two digit code identifying the account type at the receiving financial institution. |
transactionCodeDescriptionoptional | string | Transaction Description of Code. |
transactionFlowTypeCodeoptional | string | Identifies if transaction is Intra Bank accounts or Inter Bank Accounts. |
transactionFlowTypeDescriptionoptional | string | Description of Flow Type Code. |
transactionAmountoptional | string | Transaction Amount. |
transactionDescription1optional | string | Provides the receiver with a description of the purpose of the Entry. |
transactionDescription2optional | string | Provides the receiver with a description of the purpose of the Entry. |
creditOrDebitCodeoptional | string | Credit or Debit transaction identifier. |
sourceTransactionCreatedDateoptional | string | Date when User created the ACH transaction. |
sourceTransactionCreatedTimeoptional | string | Time when User created the ACH transaction. |
sourceTransactionCreatedTimestampoptional | string | Timestamp when User created the ACH transaction. |
sourceTransactionProcessDateoptional | string | This is the date the transaction was collected into ACH Product Processor . |
sourceTransactionProcessTimeoptional | string | This is the time the transaction was collected into ACH Product Processor . |
sourceTransactionProcessTimestampoptional | string | This is the timestamp the transaction was collected into ACH Product Processor . |
inboundCollectionWindowoptional | string | Inbound Processing Window of the transaction collection. |
outboundCollectionWindowoptional | string | Outbound Processing Window of the transaction collection. |
sourceTransactionSettledDateoptional | string | The date the transaction was settled |
sourceTransactionSettledTimeoptional | string | The time the transaction was settled |
sourceTransactionSettledTimestampoptional | string | The timestamp the transaction was settled |
receivingAccountNumberoptional | string | The receiving account number |
receivingCustIdentificationNumberoptional | string | The unique ID number associated with the payment recipient. This number is defined in the originating payment request. |
receivingCustomerNameoptional | string | Receiving Customer Name. |
receivingCompanyNameoptional | string | Receiving Customer Company Name. |
receivingFIBankNumberoptional | string | Receiving Financial Institution Bank Number. |
receivingFIRoutingNumberoptional | string | Receiving Financial Institution Routing Number. |
originatingAccountNumberoptional | string | Originating Financial Institution Account Number. |
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 | Immediate Destination where the file is going when it leaves from KeyBank like FED..etc. |
returnReleaseDateoptional | string | Release date of return transaction to ACH system. |
returnReasonCodeoptional | string | Return Reason Code. |
returnReasonDescriptionoptional | string | Return Reason Description. |
checkSerialNumberoptional | string | Serial number of the check converted to ACH. |
nachaBatchNumberoptional | string | Sequential Numeric Batch. |
nachaFileHeadRefererenceNumberoptional | string | Transaction File Reference Number. |
nachaSecondarySecCodeoptional | string | Secondary Nacha Sec code for the transaction |
nachaSecondarySecDescriptionoptional | string | Secondary NACHA SEC Code Description |
traceIdoptional | string | Source application created transaction Identifier. |
postCompanyCostcontrolNumberoptional | string | This field is for internal purpose only. |
glAccountNumberoptional | string | This field is for internal purpose only. |
collectionPointoptional | string | Transaction Collection Point. |
collectionApplicationTypeCodeoptional | string | This field is for internal purpose only. |
collectionApplicationTypeDescriptionoptional | string | This field is for internal purpose only. |
batchIDoptional | string | Batch ID |
customDataoptional | string | Custom data from the originating payment request. |
businessFault
NAME | TYPE | DESCRIPTION |
---|---|---|
errorCodeoptional | string | Business error code. |
errorDescriptionoptional | string | Business error description |
achReturnTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHReturnTransactionoptional | array | ACHReturnTransaction |
errorResponseoptional | Object | errorResponse |
systemFault
NAME | TYPE | DESCRIPTION |
---|---|---|
errorCodeoptional | string | System error code. |
errorDescriptionoptional | string | System error description. |
achReturnTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHReturnTransactionsRequestoptional | Object | getACHReturnTransactionsRequest |
getACHReturnTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits. |
fromDaterequired | string | Enter the start date for the date range . The date must be prior to the current date. The date format is YYYY-MM-DD. |
toDaterequired | string | Enter the end date for the date range. The date must be later than the start date (fromDate).The date format is YYYY-MM-DD. |
creditOrDebitCodeoptional | string | Use C for credit or D for debit to specify the type of transactions to return. To get both credit and debit transactions, leave this parameter blank. |
fromAmountoptional | string | Transaction amount lower limit value to be searched. |
toAmountoptional | string | Transaction amount upper limit value to be searched. |
parNumberoptional | string | ACH Product Processor assigned transaction unique number |
detailsFlagrequired | string | Use 'Y' or 'N' to pull detailed or brief response. |
receivingCustIdentificationNumberoptional | string | The unique ID number associated with the payment recipient. This number is defined in the originating payment request. |
mdmIdrequired | string | Enter your KeyBank MDM ID. The MDM ID is used for security purposes. |
startRowIndexoptional | string | This is a pagination field. It indicates the starting count available for the records. If the field 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. |
responseHeader
NAME | TYPE | DESCRIPTION |
---|---|---|
statusrequired | string | Indicates whether the result was successfully retrieved |
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. The date format is YYYY-MM-DD. For example, 2022-04-01. |
errorResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
businessFaultoptional | array | businessFault |
systemFaultoptional | array | systemFault |
achCollectedTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHCollectedTransactionsRequestoptional | Object | getACHCollectedTransactionsRequest |
getACHCollectedTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits. |
fromDaterequired | string | Enter the start date for the date range . The date must be prior to the current date. The date format is YYYY-MM-DD. |
toDaterequired | string | Enter the end date for the date range. The date must be later than the start date (fromDate).The date format is YYYY-MM-DD. |
creditOrDebitCodeoptional | string | Use C for credit or D for debit to specify the type of transactions to return. To get both credit and debit transactions, leave this parameter blank. |
fromAmountoptional | string | Transaction amount lower limit value to be searched. |
toAmountoptional | string | Transaction amount upper limit value to be searched. |
addendaFlagrequired | string | Used to retrieve Addenda Information if set to Y. |
secCodeoptional | string | SEC code filter. |
traceNumberoptional | string | Originator provided transaction identifier. |
parNumberoptional | string | ACH Product Processor assigned transaction unique number. |
detailsFlagrequired | string | Use 'Y' or 'N' to pull detailed or brief response. |
receivingCustIdentificationNumberoptional | string | The unique ID number associated with the payment recipient. This number is defined in the originating payment request. |
mdmIdrequired | string | Enter your KeyBank MDM ID. The MDM ID is used for security purposes. |
startRowIndexoptional | string | This is a pagination field. It indicates the starting count available for the records. If the field 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. |
achStatusInquiryParRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHStatusInquiryRequestoptional | Object | getACHStatusInquiryParRequest |
achStatusInquiryTraceNumberRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHStatusInquiryRequestoptional | Object | getACHStatusInquiryTraceNumberRequest |
getACHStatusInquiryParRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits. |
parNumberrequired | array | ACH Product Processor assigned transaction unique number.Multiple par numbers can be comma separated. |
traceNumberoptional | array | Source application created transaction Identifier.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. |
mdmIdrequired | string | Enter your KeyBank MDM ID. The MDM ID is used for security purposes. |
startRowIndexoptional | string | This is a pagination field. It indicates the starting count available for the records. If the field 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. |
getACHStatusInquiryTraceNumberRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits. |
traceNumberrequired | array | Source application created transaction Identifier.Multiple trace numbers can be comma separated. |
parNumberoptional | array | ACH Product Processor assigned transaction unique number.Multiple par 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. |
mdmIdrequired | string | Enter your KeyBank MDM ID. The MDM ID is used for security purposes. |
startRowIndexoptional | string | This is a pagination field. It indicates the starting count available for the records. If the field is not provided, value will default to 1. |
endRowIndexoptional | string | This is a pagination field. It indicates the last count available for the records. If the field is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex. |
achPostedTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHPostedTransactionsRequestoptional | Object | getACHPostedTransactionsRequest |
getACHPostedTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | The account number or numbers for your request. Multiple accounts can be comma separated. The account number cannot be more than 16-digits. |
fromDaterequired | string | Enter the start date for the date range . The date must be prior to the current date. The date format is YYYY-MM-DD. |
toDaterequired | string | Enter the end date for the date range. The date must be later than the start date (fromDate).The date format is YYYY-MM-DD. |
creditOrDebitCodeoptional | string | Use C for credit or D for debit to specify the type of transactions to return. To get both credit and debit transactions, leave this parameter blank. |
fromAmountoptional | string | Transaction amount lower limit value to be searched. |
toAmountoptional | string | Transaction amount upper limit value to be searched. |
parNumberoptional | string | ACH Product Processor assigned transaction unique number. |
receivingCustIdentificationNumberoptional | string | The unique ID number associated with the payment recipient. This number is defined in the originating payment request. |
mdmIdrequired | string | The keybank provided ID to client during onboarding which is associated to their account numbers. |
startRowIndexoptional | string | This is a pagination field. It indicates the starting count available for the records. If the field 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. |
achCollectedTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHCollectedTransactionsResponserequired | Object | getACHCollectedTransactionsResponse |
getACHCollectedTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHCollectedTransactionoptional | array | achCollectedTransactionsResult |
errorResponseoptional | Object | errorResponse |
achCollectedTransactionsResult
NAME | TYPE | DESCRIPTION |
---|---|---|
transactionParNumberoptional | string | ACH Product Processor assigned transaction unique number. |
sourceBankNumberoptional | string | Originating entry bank number. |
sourceAccountNumberoptional | string | Originating account number. |
origAcctSuffixoptional | string | This field is for internal purpose only. |
sourceSysCodeoptional | string | This field is for internal purpose only. |
sourceSysOfRecordCodeoptional | string | 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 | Transaction description of code. |
transactionFlowTypeCodeoptional | string | Identifies if transaction is Intra Bank accounts or Inter Bank Accounts. |
transactionFlowTypeDescriptionoptional | string | Description of flow type code. |
originatingReceiverCodeoptional | string | Identifies the type Originating/Receiving and Incoming/Outgoing. |
transactionAmountoptional | string | Transaction amount. |
transactionDescriptionoptional | string | Provides the receiver with a description of the purpose of the entry. |
creditOrDebitCodeoptional | string | Credit or Debit transaction identifier. |
inboundCollectionWindowoptional | string | Processing window of the transaction collection. |
sourceTransactionProcessDateoptional | string | This is the date the transaction was collected into ACH Product Processor. |
sourceTransactionProcessTimeoptional | string | This is the time the transaction was collected into ACH Product Processor. |
sourceTransactionProcessTimestampoptional | string | This is the timestamp the transaction was collected into ACH Product Processor. |
sourceTransactionSettledDateoptional | string | Transaction settled date. |
sourceTransactionSettledTimeoptional | string | Transaction settled time. |
sourceTransactionSettledTimestampoptional | string | Transaction settled timestamp. |
sourceTransactionPostDateoptional | string | This is the date the item is expected to be sent for posting. |
sourceTransactionPostTimeoptional | string | This is the time the transaction was collected into ACH Product Processor. |
sourceTransactionPostTimestampoptional | string | This is the timestamp the transaction was collected into ACH Product Processor. |
deliveryStatusCodeoptional | string | Transaction delivery status. |
deliveryStatusDescriptionoptional | string | Transaction delivery status description. |
receivingAccountNumberoptional | string | Receiving financial institution account number. |
receivingFIBankNumberoptional | string | Receiving financial institution bank number. |
receivingFIRoutingNumberoptional | string | Receiving financial institution routing number. |
receivingCustIdentificationNumberoptional | string | The unique ID number associated with the payment recipient. This number is defined in the originating payment request. |
receivingCustomerNameoptional | string | Receiving customer name. |
receivingCompanyNameoptional | string | Receiving customer company name. |
originatingAccountNumberoptional | string | Originating financial institution account number. |
originatingFIBankNumberoptional | string | Originating financial institution bank number. |
originatingFIRoutingNumberoptional | string | Originating financial institution routing number. |
originatingCustIdentificationNumberoptional | string | Originating customer identification number. |
originatingCompanyNameoptional | string | Originating customer company name. |
originatingCustomerNameoptional | string | Originating customer name. |
checkSerialNumberoptional | string | Transaction serial/check number. |
nachaBatchNumberoptional | string | Sequential numeric batch. |
nachaFileHeadRefererenceNumberoptional | string | Transaction file reference number. |
nachaSecCodeoptional | string | NACHA SEC Code. |
nachaSecDescriptionoptional | string | NACHA SEC Code Description |
traceNumberoptional | string | Source application created transaction Identifier. |
postCompanyCostcontrolNumberoptional | string | This field is for internal purpose only. |
glAccountNumberoptional | string | This field is for internal purpose only. |
addendaPresentFlagoptional | string | Addenda present Identifier. |
addendaRecordNumberoptional | string | Number of addenda records. |
originatingReceiverDescriptionoptional | string | Description of 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 | Batch ID. |
transactionTraceIdoptional | string | Source application created transaction Identifier. |
addendaInformationoptional | Object | addendaInformation |
customDataoptional | string | Custom data from the originating payment request. |
achPostedTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHCollectedTransactionsResponseoptional | Object | getACHPostedTransactionsResponse |
getACHPostedTransactionsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHPostedTransactionoptional | array | achPostedTransactionsResult |
errorResponseoptional | Object | errorResponse |
achPostedTransactionsResult
NAME | TYPE | DESCRIPTION |
---|---|---|
snapshotDateoptional | string | This field is for internal purpose only. |
processDateoptional | string | Date the transaction was processed. |
sourceBankNumberoptional | string | Originating Entry Bank Number. |
sourceAccountNumberoptional | string | Source Bank Account Number. |
transactionParNumberoptional | string | ACH Product Processor assigned transaction unique number. |
transactionAmountoptional | string | Transaction Amount. |
creditOrDebitCodeoptional | string | Credit or Debit transaction identifier. |
hoganTransactionCodeoptional | string | Bank Product Processor Transaction Code. |
baiCodeoptional | string | Transaction BAI Code. |
transactionCodeoptional | string | Transaction BAI Code Description. |
regulationDescription1optional | string | Transaction Description 1. |
regulationDescription2optional | string | Transaction Description 2. |
regulationDescription3optional | string | Transaction Description 3. |
regulationDescription4optional | string | Transaction Description 4. |
postingWindowoptional | string | Transaction Posting Time. |
batchIDoptional | string | Batch Id. |
customDataoptional | string | Custom data from the originating payment request. |
achStatusInquiryResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
ACHTransactionStatusoptional | array | achStatusInquiryResult |
errorResponseoptional | Object | errorResponse |
achStatusInquiryResult
NAME | TYPE | DESCRIPTION |
---|---|---|
ACHStatusoptional | string | The status of the ACH transaction identifies the ACH transaction type. This can be COLLECTED, POSTED, or RETURNED. |
ACHCollectedTransactionoptional | Object | achCollectedTransactionsStatusResult |
ACHPostedTransactionoptional | Object | achPostedTransactionsStatusResult |
ACHReturnTransactionoptional | Object | achReturnTransactionsStatusResult |
achCollectedTransactionsStatusResult
NAME | TYPE | DESCRIPTION |
---|---|---|
transactionParNumberoptional | string | ACH Product Processor assigned transaction unique number. |
sourceBankNumberoptional | string | Originating Entry Bank Number. |
sourceAccountNumberoptional | string | Account Number. |
transactionCodeoptional | string | Two digit code identifying the account type at the receiving financial institution. |
transactionAmountoptional | string | Transaction Amount. |
creditOrDebitCodeoptional | string | Credit or Debit transaction identifier. |
sourceTransactionProcessDateoptional | string | This is the date the transaction was collected into ACH Product Processor. |
sourceTransactionProcessTimeoptional | string | This is the time the transaction was collected into ACH Product Processor. |
sourceTransactionProcessTimestampoptional | string | This is the timestamp the transaction was collected into ACH Product Processor. |
sourceTransactionSettledDateoptional | string | Transaction Settled Date. |
sourceTransactionSettledTimeoptional | string | Transaction Settled time. |
sourceTransactionSettledTimestampoptional | string | Transaction Settled timestamp. |
sourceTransactionPostDateoptional | string | This is the date the item is expected to be sent for posting. |
sourceTransactionPostTimeoptional | string | This is the time the item is expected to be sent for posting. |
sourceTransactionPostTimestampoptional | string | This is the timestamp the item is expected to be sent for posting. |
receivingCustomerNameoptional | string | Receiving Customer Name. |
receivingCompanyNameoptional | string | Receiving Customer Company Name. |
originatingCompanyNameoptional | string | Originating Company Name. |
originatingCustomerNameoptional | string | Originating Customer Name. |
nachaSecCodeoptional | string | NACHA SEC Code. |
traceNumberoptional | string | Source application created transaction Identifier. |
transactionDescriptionoptional | string | Provides the receiver with a description of the purpose of the Entry. |
receivingCustIdentificationNumberrequired | string | The unique ID number associated with the payment recipient. This number is defined in the originating payment request. |
achPostedTransactionsStatusResult
NAME | TYPE | DESCRIPTION |
---|---|---|
processDateoptional | string | Date the transaction was processed. |
transactionParNumberoptional | string | ACH Product Processor assigned transaction unique number. |
transactionAmountoptional | string | Transaction Amount. |
creditOrDebitCodeoptional | string | Credit or Debit transaction identifier. |
baiCodeoptional | string | Transaction BAI Code. |
transactionCodeoptional | string | Transaction BAI Code Description. |
regulationDescription1optional | string | Transaction Description 1. |
regulationDescription2optional | string | Transaction Description 2. |
regulationDescription3optional | string | Transaction Description 3. |
regulationDescription4optional | string | Transaction Description 4. |
postingWindowoptional | string | Transaction Posting Time. |
achReturnTransactionsStatusResult
NAME | TYPE | DESCRIPTION |
---|---|---|
transactionParNumberoptional | string | Return Transaction ACH Product Processor assigned transaction unique number. |
transactionCodeoptional | string | Two digit code identifying the account type at the receiving financial institution. |
transactionCodeDescriptionoptional | string | Transaction Description of Code. |
transactionAmountoptional | string | Transaction Amount. |
transactionDescription1optional | string | Provides the receiver with a description of the purpose of the Entry. |
transactionDescription2optional | string | Provides the receiver with a description of the purpose of the Entry. |
creditOrDebitCodeoptional | string | Credit or Debit transaction identifier. |
returnReleaseDateoptional | string | Release date of return to ACH system. |
returnReasonCodeoptional | string | Return Reason Code. |
returnReasonDescriptionoptional | string | Return Reason Description. |
addendaInformation
NAME | TYPE | DESCRIPTION |
---|---|---|
iatAddendumoptional | Object | iatAddendum |
nonIatAddendumoptional | Object | nonIatAddendum |
nocAddendumoptional | Object | nocAddendum |
iatAddendum
NAME | TYPE | DESCRIPTION |
---|---|---|
addendaParNumberoptional | string | ACH Product Processor assigned transaction unique number. |
snapshotDateoptional | string | This field is for internal purpose only. |
transactionParNumberoptional | string | ACH Product Processor assigned transaction unique number for Entry Record. |
payInformationoptional | string | Remittance Payment Related Information. |
addendaTypeCodeoptional | string | Two digit code identifying the type of information. |
addendaTypeDescriptionoptional | string | Two digit code identifying the type of information description. |
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 | This field contains originating bank's physical street address 1. |
originatingCompanyAddress2optional | string | This field contains originating bank's physical street address 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 1. |
receivingCompanyAddress2optional | string | Receiving company physical address 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 | Addenda sequence number. |
entryDetailSequenceNumberoptional | string | Entry detail sequence number. |
operatorCommandFlagoptional | string | Operator command flag. |
nonIatAddendum
NAME | TYPE | DESCRIPTION |
---|---|---|
addendaParNumberoptional | string | ACH Product Processor assigned transaction unique number for addenda record. |
snapshotDateoptional | string | This field is for internal purpose only. |
transactionParNumberoptional | string | ACH Product Processor assigned transaction unique number for entry record. |
transactionSerialNumberoptional | string | Transaction serial number. |
transactionDescriptionoptional | string | Transaction description. |
sourceTransactionCreatedDateoptional | string | Source transaction created date. |
sourceTransactionCreatedTimeoptional | string | Source transaction created time. |
payInformationoptional | string | This field contains additional information associated with the payment. |
addendaTypeCodeoptional | string | Two digit code identifying the type of information. |
addendaTypeDescriptionoptional | string | Two digit code identifying the type of information Description. |
entryDetailSequenceNumberoptional | string | Entry detail sequence number. |
referenceInformation1optional | string | Free form text. |
referenceInformtion2optional | string | Free form text. |
networkIdentificationCodeoptional | string | NIC code. |
terminalIdentificationCodeoptional | string | Terminal identification code. |
terminalCityoptional | string | Terminal city. |
terminalStateoptional | string | Terminal state. |
keyBankTransactionReferenceNumberoptional | string | Key transaction reference ID. |
operatorCommandFlagoptional | string | Operator command flag. |
nocAddendum
NAME | TYPE | DESCRIPTION |
---|---|---|
addendaParNumberoptional | string | ACH Product Processor assigned transaction unique number for Addenda record. |
snapshotDateoptional | string | This field is for internal purpose only. |
transactionParNumberoptional | string | ACH Product Processor assigned transaction unique number for entry record. |
addendaTypeCodeoptional | string | Two digit code identifying the type of information. |
addendaTypeDescriptionoptional | string | Two digit code identifying the type of information description. |
changeCodeoptional | string | A three-character change code beginning with the letter 'C' is applied to all NOCs to indicate the information that is being changed. |
changeDescriptionoptional | string | Change code description. |
receivingFiIdentificationNumberoptional | string | Original receiving FI identifier. |
correctedDataoptional | string | The corrected data per the correction change code. |
externalFiTransactionIdentificationNumberoptional | string | ID used by External FI to identify transaction. |
keyBankTransactionReferenceNumberoptional | string | Key transaction reference ID. |
operatorCommandFlagoptional | string | Operator command flag. |
Error handling
An error can indicate a problem with the request, the network, or the API itself. Use the error handling information to get a better understanding of what went wrong and possible corrective actions.
Status messages
Some APIs contain status messages in the responseHeader
object of the response payload. The status
field returns the status code S, W, or F. Successful responses return the status code S with an HTTP 200 status code. Responses that were not processed as expected or failed to be processed at all return the status code W for warning or F for failure. Warning messages are associated with HTTP 299 status code. A warning message means the request was successfully received, but there was a minor issue that requires your attention. Failure messages are associated with the HTTP 400 or 500 status codes. Additional information is shared in the statusDescription
field.
Standard error message format
An erroneous response returns the HTTP code number with the content of the exception schema. Additional information in this schema like the transaction ID and transaction time can help you diagnose the issue.
API-specific error messages
Custom messages are used for API-related functional business messages or faults. Each API can contain custom messages specific to KeyBank operations or the API. These messages can be part of the exception
schema or a separate object.
KeyBank uses the ServiceError > errorResponse
object for errors specific to the API.
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, toDate, or mdmID. Review values for mandatory request fields. |
400* | ECA-W-001 | Error occurred while validating account association.
Status is F for Failure. The MDM ID provided in the request is invalid or empty. |
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. |
400 | Missing data in the request.
|
|
401 | Received request is unauthorized.
|
|
403 | Request is forbidden to access the resource.
|
|
404 | Request resource is not found.
|
|
405 | Request method is not allowed.
|
|
415 | Requested unsupported media type.
|
|
429 | Too many request received.
|
|
500 | Internal server error.
|
|
502 | Bad Gateway.
|
|
503 | Service Unavailable.
|
|
504 | Gateway timeout.
|
YAML file
