Get the status for your ACH transactions
ACH Inquiry Endpoints
In an upcoming release of ACH Inquiry API v2, only the /ach/list and /ach/detail/{parNumber} search will be available for ACH inquiry requests. This is an advanced design that allows you to perform a neutral search (regardless of transaction status) for a specific payment and get the details.
We recommend that you use the following endpoints below your ACH queries.
What you can do | Endpoint |
---|---|
Health check | get /accounts/transactions/v1/healthCheck |
Search for ACH transactions | post /accounts/transactions/v1/ach/list |
Search for ACH transaction details | get /accounts/transactions/v1/ach/detail/{parNumber} |
Before you begin
All KeyBank APIs require certificates, user credentials, and certain permissions. Check out our Getting Started Guide to learn more.
Overview
You can use the ACH Inquiry API to get the status for ACH transactions as they are received and processed by KeyBank.
The consolidation settlement type affect what information is returned. The ACHStatus
field defines the status of the transaction as in progress (COLLECTED), processed (SETTLED), or returned (RETURNED).
-
For clients with a non-consolidated settlement, you can receive information about collected, settled, and returned transactions.
-
For clients with a consolidated settlement, you will only receive collected and returned transactions. SETTLED is not an available status for consolidated settlement.
PAR-don me
ACH inquiries require a parNumber
or traceNumber
for inquiries. Learn more in our ACH APIs User Guide.
Health check
get /accounts/transactions/v1/healthCheck
Verify you can connect to the API service.
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
Statusoptional | string | Status of the health check response. |
Sourceoptional | string | System producing the health response. Genesis of the response could either be just from “gateway” or “roundtrip” from the farthest possible system involved in generating this response. |
Timestampoptional | string | Timestamp when the health response is being returned by this service. |
ClientIpoptional | string | IP of the client from which this request for health check is received by the gateway. |
X-Forwarded-Foroptional | string | Sequence of all the Ips of the systems involved between the client and the gateway. |
Response example (200)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "Status": "Ok", "Source": "Roundtrip", "Timestamp": "2022-09-15T04:49:03", "ClientIp": "156.77.111.28", "X-Forwarded-For": "[156.77.111.28]" }
Search for ACH transactions
post /accounts/transactions/v1/ach/list
Search for ACH transactions by passing certain search parameters. With ACH transactions, each status point has a start and end date. If you search using the fromDate
and toDate
parameters, use the dateSearchType
to identify if it is the start and end date for when the transaction was collected, returned, or settled. If you leave the dateSearchType
field blank, the request only searches the date range for collected transactions.
You can search up to 2 years of past records. We recommend that your date search range does not exceed 90 days.
Request
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | string | The bank account number. This field cannot exceed 16 characters. |
dateSearchTypeoptional | string | Each ACH transaction status has an associated date range. Indicate the specific transaction date set to search. If left blank, the search defaults to collected transaction dates. Valid values: COLLECTED, RETURNED, SETTLED |
fromDateoptional | string | The start date for the date range. Transaction data can be recalled from the previous 24 months. The date must be prior to the current date. Format: YYYY-MM-DD |
toDateoptional | string | The end date of a date range for the submitted transactions. Transaction data can be recalled from the previous 24 months. The date must be later than the start date (fromDate). The range should not exceed 90 days. Format: YYYY-MM-DD |
minimumAmountoptional | string | The minimum dollar amount of the transaction. This amount must be less than or equal to the maximum amount. Leave blank or enter zero for no minimum amount. |
maximumAmountoptional | string | The maximum dollar amount of the transaction. This amount must be greater than or equal to the minimum amount. Leave blank to retrieve all amounts. This amount cannot exceed one billion dollars. |
traceNumberoptional | string | The unique number for the transaction provided by the originator. |
pageNumberoptional | string | The number of the page being viewed. This number must be greater than or equal to 1. |
pageSizeoptional | string | The total number of pages returned. This number must be greater than or equal to 1 and cannot exceed 1000. |
Request example
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "accountNumber": "3123456789", "dateSearchType": "COLLECTED", "fromDate": 2024-03-15, "toDate": 2024-05-31, "minimumAmount": 100, "maximumAmount": 75020.5, "traceNumber": "041001030016002", "pageNumber": 1, "pageSize": 150 }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
transactionsoptional | string | AchListTransaction |
metadataoptional | string | Metadata |
Response example (200)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "transactions": [ { "parNumber": "22018007665985", "transactionStatus": "COLLECTED", "traceNumber": "000000000000000", "transactionAmount": 10.01, "settlementDate": "2021-03-08", "transactionCode": "22", "authorizedCustomerName": "TEST CUSTOMER1", "standardEntryClassCode": "CCD", "receivingAccount": { "accountNumber": "123456789012" }, "receivingParty": { "customerIdentificationNumber": "099999999", "companyName": "MERCHANT" }, "originatingAccount": { "accountNumber": "123456789012" }, "originatingParty": { "customerIdentificationNumber": "1234567", "companyName": "COMPANY NAME 1" }, "returnDate": "2024-02-01", "returnReasonCode": "R02", "returnReasonDescription": "Account Closed", "addendaCount": 1, "notificationOfChangeAddendaCount": 1, "internationalAddendaCount": 0 } ], "metadata": { "messages": [ { "code": "099", "message": "Search results match the criteria" } ], "page": { "pageNumber": 1, "pageSize": 10, "totalPages": 10, "totalRecords": 28, "lastPage": true } } }
Bad input parameter
NAME | TYPE | DESCRIPTION |
---|---|---|
metadataoptional | string | Metadata |
Response example (400)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "metadata": { "messages": [ { "code": "001", "message": "There are no transactions that match the parNumber." } ], "page": { "pageNumber": 1, "pageSize": 1, "totalPages": 1, "totalRecords": 0, "lastPage": false } } }
Get details about an ACH transaction with a PAR number
get /accounts/transactions/v1/ach/detail/{parNumber}
Use the PAR number to retrieve details about an ACH transaction. You do not need to know or identify the ACH payment status in this search.
Request
path FIELD | TYPE | DESCRIPTION |
---|---|---|
parNumberrequired | string | The unique PAR number assigned to the the transaction by the ACH product processor. |
Request example
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
curl --location: 'https://partner-api-qv.keybank.com/accounts/transactions/v1/ach/detail/22018007665985' --header 'Accept: application/json' --header 'Authorization: Bearer testZcKJDWnwDWmmf9qah6PJvPy8'
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
parNumberoptional | string | The unique PAR number assigned to the the transaction by the ACH product processor. |
transactionStatusoptional | string | The status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED |
traceNumberoptional | string | The unique number for the transaction provided by the originator. |
transactionAmountoptional | number | The dollar amount of the transaction. |
settlementDateoptional | string | The date the transaction settlement occurred. Format: YYYY-MM-DD |
transactionCodeoptional | string | Two-digit code identifying the account type at the receiving financial institution. |
transactionCodeDescriptionoptional | string | Description for the transaction code. |
transactionDescriptionoptional | string | Description about the purpose of the transaction. |
authorizedCustomerNameoptional | string | Authorized customer name |
standardEntryClassCodeoptional | string | The three-digit Standard Entry Class code based on Nacha rules. |
standardEntryClassDescriptionoptional | string | The description for the Nacha SEC code. |
receivingAccountoptional | Object | AccountDetail |
receivingPartyoptional | Object | PartyDetail |
originatingAccountoptional | Object | AccountDetail |
originatingPartyoptional | Object | PartyDetail |
returnDateoptional | string | Date of the returned transaction to the ACH system. Format: YYYY-MM-DD |
returnReasonCodeoptional | string | The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00 |
returnReasonDescriptionoptional | string | Description as to why the ACH transaction is returned. |
addendaCountoptional | integer | Count of addenda records. |
notificationOfChangeAddendaCountoptional | integer | Count of change notifications for addenda records. |
internationalAddendaCountoptional | integer | Count of international addenda records. |
customDataoptional | string | The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle. |
checkSerialNumberoptional | string | Serial number for the check converted to an ACH transaction. |
transactionDirectionoptional | string | Indicates the direction of the transaction. Valid values: ORIGINATING ITEM, RECEIVING ITEM |
addendaoptional | array | Addendum |
notificationOfChangeoptional | array | NotificationOfChange |
Response example (200)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "parNumber": "22018007665985", "transactionStatus": "COLLECTED", "traceNumber": "000000000000000", "transactionAmount": 10.01, "settlementDate": "2021-03-08", "transactionCode": "22", "transactionCodeDescription": "Automated Deposit", "transactionDescription": "DEPOSIT", "authorizedCustomerName": "TEST CUSTOMER1", "standardEntryClassCode": "CCD", "standardEntryClassDescription": "Cash Concentration or Disbursement", "receivingAccount": { "accountNumber": "123456789012", "bankNumber": "0000", "routingNumber": "1234567890" }, "receivingParty": { "customerIdentificationNumber": "099999999", "companyName": "MERCHANT", "customerName": "TEST MERCHANT" }, "originatingAccount": { "accountNumber": "123456789012", "bankNumber": "0000", "routingNumber": "1234567890" }, "originatingParty": { "customerIdentificationNumber": "1234567", "companyName": "COMPANY NAME 1", "customerName": "CUSTOMER NAME 1" }, "returnDate": "2024-02-01", "returnReasonCode": "R02", "returnReasonDescription": "Account Closed", "addendaCount": 1, "notificationOfChangeAddendaCount": 1, "internationalAddendaCount": 0, "customData": "merchant:status", "checkSerialNumber": "4345", "transactionDirection": "Receiving Item", "addenda": [ { "sequenceNumber": 1, "entryDetailSequenceNumber": "188", "paymentRelatedInformation": "Addenda Record (Applies to CCD, CTX, PPD, and WEB entries)" } ], "notificationOfChange": [ { "changeCode": "C02", "changeDescription": "Incorrect transit\/routing number", "correctedData": "1234567890" } ] }
Resource not found
NAME | TYPE | DESCRIPTION |
---|---|---|
metadataoptional | string | Metadata |
Response example (404)
![copylink](/modules/custom/keybank_openapispec/images/jsoncopy.png)
{ "metadata": { "messages": [ { "code": "AI-Detail-404-no-records-100", "message": "Record Not Found" } ] } }
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. |
AchDetailTransaction
NAME | TYPE | DESCRIPTION |
---|---|---|
parNumberoptional | string | The unique PAR number assigned to the the transaction by the ACH product processor. |
transactionStatusoptional | string | The status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED |
traceNumberoptional | string | The unique number for the transaction provided by the originator. |
transactionAmountoptional | number | The dollar amount of the transaction. |
settlementDateoptional | string | The date the transaction settlement occurred. Format: YYYY-MM-DD |
transactionCodeoptional | string | Two-digit code identifying the account type at the receiving financial institution. |
transactionCodeDescriptionoptional | string | Description for the transaction code. |
transactionDescriptionoptional | string | Description about the purpose of the transaction. |
authorizedCustomerNameoptional | string | Authorized customer name |
standardEntryClassCodeoptional | string | The three-digit Standard Entry Class code based on Nacha rules. |
standardEntryClassDescriptionoptional | string | The description for the Nacha SEC code. |
receivingAccountoptional | Object | AccountDetail |
receivingPartyoptional | Object | PartyDetail |
originatingAccountoptional | Object | AccountDetail |
originatingPartyoptional | Object | PartyDetail |
returnDateoptional | string | Date of the returned transaction to the ACH system. Format: YYYY-MM-DD |
returnReasonCodeoptional | string | The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00 |
returnReasonDescriptionoptional | string | Description as to why the ACH transaction is returned. |
addendaCountoptional | integer | Count of addenda records. |
notificationOfChangeAddendaCountoptional | integer | Count of change notifications for addenda records. |
internationalAddendaCountoptional | integer | Count of international addenda records. |
customDataoptional | string | The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle. |
checkSerialNumberoptional | string | Serial number for the check converted to an ACH transaction. |
transactionDirectionoptional | string | Indicates the direction of the transaction. Valid values: ORIGINATING ITEM, RECEIVING ITEM |
addendaoptional | array | Addendum |
notificationOfChangeoptional | array | NotificationOfChange |
AchListTransaction
NAME | TYPE | DESCRIPTION |
---|---|---|
parNumberoptional | string | The unique PAR number assigned to the the transaction by the ACH product processor. |
transactionStatusoptional | string | The status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED |
traceNumberoptional | string | The unique number for the transaction provided by the originator. |
transactionAmountoptional | number | The dollar amount of the transaction. |
settlementDateoptional | string | The date the transaction settlement occurred. Format: YYYY-MM-DD |
transactionCodeoptional | string | Two-digit code identifying the account type at the receiving financial institution. |
authorizedCustomerNameoptional | string | Authorized customer name |
standardEntryClassCodeoptional | string | The three-digit Standard Entry Class code based on Nacha rules. |
receivingAccountoptional | Object | AccountList |
receivingPartyoptional | Object | PartyList |
originatingAccountoptional | Object | AccountList |
originatingPartyoptional | Object | PartyList |
returnDateoptional | string | Date of the returned transaction to the ACH system. Format: YYYY-MM-DD |
returnReasonCodeoptional | string | The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00 |
returnReasonDescriptionoptional | string | Description as to why the ACH transaction is returned. |
addendaCountoptional | integer | Count of addenda records. |
notificationOfChangeAddendaCountoptional | integer | Count of change notifications for addenda records. |
internationalAddendaCountoptional | integer | Count of international addenda records. |
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. |
achPostedTransactionsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHPostedTransactionsRequestoptional | Object | getACHPostedTransactionsRequest |
ACHReturnTransaction
NAME | TYPE | DESCRIPTION |
---|---|---|
returnTransactionParNumberoptional | string | The unique PAR number assigned to the the transaction by the ACH product processor. |
sourceBankNumberoptional | string | Originating entry bank number |
sourceAccountNumberoptional | string | Originating account number |
sourceTransactionRecordNumberoptional | string | Originating record number for the transaction |
sourceSysCodeoptional | string | Do not use. This field is for internal purpose only. |
sourceSysOfRecordCodeoptional | string | Do not use. This field is for internal purpose only. |
snapshotDateoptional | string | This field is for internal purpose only. |
originalACHTransactionParNumberoptional | string | The assigned PAR number for the original ACH transaction. |
originalTransactionProcessDateoptional | string | Date the transaction is processed. Format: YYYY-MM-DD |
originalTransactionProcessTimeoptional | string | Time the transaction is processed in 24-hour time. Format: HHMMSS |
originalTransactionProcessTimestampoptional | string | The date and time the transaction is processed. Format: YYYY-MM-DD HH:MM:SS |
originatingReceiverCodeoptional | string | Two-character code that identifies the transaction type as originating (O) or receiving (R) and if the transaction is incoming (I) or outgoing (O). Codes can be OI, OO, RI, or RO. |
originatingReceiverDescriptionoptional | string | Description for the returned originating receiver code. |
transactionCodeoptional | string | Two-digit code identifying the account type at the receiving financial institution. |
transactionCodeDescriptionoptional | string | Description for the transaction code. |
transactionFlowTypeCodeoptional | string | Identifies if transaction is intrabank (within a single financial institution) or interbank (between two or more banks). Valid values: INTRA, INTER |
transactionFlowTypeDescriptionoptional | string | Description for the transaction flow type code. |
transactionAmountoptional | string | The dollar amount of the transaction. |
transactionDescription1optional | string | A free form text field that provides the receiver with a description about the purpose of the transaction. |
transactionDescription2optional | string | Additional transaction description information. |
creditOrDebitCodeoptional | string | Identifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D. |
sourceTransactionCreatedDateoptional | string | Date when the user created the ACH transaction. Format: YYYY-MM-DD |
sourceTransactionCreatedTimeoptional | string | Time when the user created the ACH transaction. The time format uses the 24-hour clock. Format: HHMM |
sourceTransactionCreatedTimestampoptional | string | The date and time that the ACH transaction was created. Format: YYYY-MM-DD HH:MM:SS |
sourceTransactionProcessDateoptional | string | Date when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD |
sourceTransactionProcessTimeoptional | string | Time when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS |
sourceTransactionProcessTimestampoptional | string | The date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS |
inboundCollectionWindowoptional | string | The time window when the transaction collection is processed. The time format uses the 24-hour clock. Format: HHMM |
outboundCollectionWindowoptional | string | The outbound processing window for the transaction collection. The time format uses the 24-hour clock. Format: HHMM |
sourceTransactionSettledDateoptional | string | Date when the transaction is settled. Format: YYYY-MM-DD |
sourceTransactionSettledTimeoptional | string | The time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM |
sourceTransactionSettledTimestampoptional | string | The date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS |
receivingAccountNumberoptional | string | Account number of the person or institution receiving the funds. |
receivingCustIdentificationNumberoptional | string | The customer identification number for the person receiving the transaction. |
receivingCustomerNameoptional | string | Customer name of the person receiving the funds. |
receivingCompanyNameoptional | string | Company name of the institution getting the funds. |
receivingFIBankNumberoptional | string | Bank number for the financial institution receiving the funds. |
receivingFIRoutingNumberoptional | string | Routing number for the receiving financial institution. |
originatingAccountNumberoptional | string | Account number of the ACH transaction originator. |
originatingCustIdentificationNumberoptional | string | Originating customer identification number |
originatingCustomerNameoptional | string | Originating customer name |
originatingCompanyNameoptional | string | Originating company name |
originatingFIBankNumberoptional | string | Originating financial institution bank number |
originatingFIRoutingNumberoptional | string | Originating financial institution routing number |
authorizedCustomerNameoptional | string | Authorized customer name |
immediateDestinationIDoptional | string | The ID indicates the next location of the file once it leaves KeyBank. |
returnReleaseDateoptional | string | Release date of the returned transaction to the ACH system. Format: YYYY-MM-DD |
returnReasonCodeoptional | string | The code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00 |
returnReasonDescriptionoptional | string | Description as to why the ACH transaction is returned. |
checkSerialNumberoptional | string | Serial number for the check converted to an ACH transaction. |
nachaBatchNumberoptional | string | The sequential number of the Nacha batch job. |
nachaFileHeadRefererenceNumberoptional | string | The Nacha transaction file reference number. |
nachaSecondarySecCodeoptional | string | The secondary Nacha standard entry class (SEC) code for the transaction, if applicable. Valid values: CCD, CTX, PPD, TEL, WEB. |
nachaSecondarySecDescriptionoptional | string | The description for the secondary Nacha SEC code. |
traceIdoptional | string | The trace ID number from the source application. |
postCompanyCostcontrolNumberoptional | string | Do not use. This field is for internal purpose only. |
glAccountNumberoptional | string | Do not use. This field is for internal purpose only. |
collectionPointoptional | string | Transaction collection point |
collectionApplicationTypeCodeoptional | string | Do not use. This field is for internal purpose only. |
collectionApplicationTypeDescriptionoptional | string | Do not use. This field is for internal purpose only. |
batchIDoptional | string | The identification number for the batch job. |
customDataoptional | string | Custom data from the originating payment request. |
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 |
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 informs you if the ACH transaction has been collected or returned. Valid values: COLLECTED or RETURNED |
ACHCollectedTransactionoptional | Object | achCollectedTransactionsStatusResult |
ACHPostedTransactionoptional | Object | achPostedTransactionsStatusResult |
ACHReturnTransactionoptional | Object | achReturnTransactionsStatusResult |
achStatusInquiryTraceNumberRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getACHStatusInquiryRequestoptional | Object | getACHStatusInquiryTraceNumberRequest |
AccountDetail
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberoptional | string | Bank account number of the ACH originator or receiver. |
bankNumberoptional | string | Bank number associated with the account number. |
routingNumberoptional | string | Nine-digit routing number for the account provided in the original request. |
AccountList
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberoptional | string | Bank account number. |
addendaInformation
NAME | TYPE | DESCRIPTION |
---|---|---|
iatAddendumoptional | Object | iatAddendum |
nonIatAddendumoptional | Object | nonIatAddendum |
nocAddendumoptional | Object | nocAddendum |
Addendum
NAME | TYPE | DESCRIPTION |
---|---|---|
sequenceNumberoptional | integer | The addenda record item number in order of sequence. Number cannot exceed 4 digits. |
entryDetailSequenceNumberoptional | string | The entry number in order of sequence. Number cannot exceed 7 digits. |
paymentRelatedInformationoptional | string | The related payment information from the addenda records. The maximum character limit is 255. |
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. |
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. |
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. |
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. |
startRowIndexoptional | string | Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1. |
endRowIndexoptional | string | Pagination parameter that indicates the last count available for the records. If this parameter is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex. |
getACHStatusInquiryTraceNumberRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
accountNumberrequired | array | One or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters. |
traceNumberrequired | array | The unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated. |
parNumberoptional | array | The PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers. |
receivingCustIdentificationNumberoptional | string | The unique ID number associated with the payment recipient. This number is defined in the originating payment request. |
startRowIndexoptional | string | Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1. |
endRowIndexoptional | string | This is a pagination field. It indicates the last count available for the records. If the field is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex. |
healthResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
Statusoptional | string | Status of the health check response. |
Sourceoptional | string | System producing the health response. Genesis of the response could either be just from “gateway” or “roundtrip” from the farthest possible system involved in generating this response. |
Timestampoptional | string | Timestamp when the health response is being returned by this service. |
ClientIpoptional | string | IP of the client from which this request for health check is received by the gateway. |
X-Forwarded-Foroptional | string | Sequence of all the Ips of the systems involved between the client and the gateway. |
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 |
Message
NAME | TYPE | DESCRIPTION |
---|---|---|
codeoptional | string | Code for the related message. |
messageoptional | string | Message associated with the code. |
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 |
NotificationOfChange
NAME | TYPE | DESCRIPTION |
---|---|---|
changeCodeoptional | string | The three-character change code begins with the letter 'C'. This code is applied to all NOCs to indicate the information that is being changed. |
changeDescriptionoptional | string | The description associated with the change code. |
correctedDataoptional | string | The corrected data per the correction change code. |
Page
NAME | TYPE | DESCRIPTION |
---|---|---|
pageNumberoptional | integer | The number of the page being viewed. |
pageSizeoptional | integer | The number of records per page. |
totalPagesoptional | integer | The number of pages there are in total. |
totalRecordsoptional | integer | The total number of transactions available in the result set. |
lastPageoptional | boolean | Indicates if the current page (page number) is the last page of the result set. Valid values: true, false |
PartyDetail
NAME | TYPE | DESCRIPTION |
---|---|---|
customerIdentificationNumberoptional | string | The unique identification number associated with the customer. |
companyNameoptional | string | The name of the corporation or institution making the request. |
customerNameoptional | string | The name of the customer. |
PartyList
NAME | TYPE | DESCRIPTION |
---|---|---|
customerIdentificationNumberoptional | string | The unique identification number associated with the customer. |
companyNameoptional | string | The name of the corporation or institution making the request. |
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 general errors, see Error handling.
API-specific KeyBank error codes and details are in the ServiceError
or errorResponse
object with additional information specific to the API. The KeyBank error codes start with ECA-W with a three-digit number that follows. The number increases by one digit for each error message. For example, if you have an issue with your request that generates two error messages specific to the API, the codes will be ECA-W-001 and ECA-W-002.
API specific KeyBank codes and messages
HTTP STATUS CODE |
CUSTOM STATUS CODE |
DESCRIPTION |
---|---|---|
299 | W | ECA-W-001 Request processing completed with warnings.
This message occurs when multiple request parameters are provided, and some of the data are not available as part of response. |
400 | F | ECA-W-001 Request Validation failed.
There is missing mandatory information like accountNumber, fromDate, or toDate. Review values for mandatory request fields. |
400 | F | ECA-W-002 Requested records range is greater than the allowed limit - 1000
Response goes beyond 1000 transactions for the requested account. Change the request criteria to help limit returned transactions to the allowed amount. |
YAML file
![download](/themes/custom/keybank_dev_portal/images/download-icon.png)