ACH Inquiry

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

Get the status for your ACH transactions

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

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 doEndpoint
Health checkget /accounts/transactions/v1/healthCheck
Search for ACH transactionspost /accounts/transactions/v1/ach/list
Search for ACH transaction detailsget /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.

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.


get /accounts/transactions/v1/healthCheck

Verify you can connect to the API service.

NAMETYPEDESCRIPTION
StatusoptionalstringStatus of the health check response.
SourceoptionalstringSystem 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.
TimestampoptionalstringTimestamp when the health response is being returned by this service.
ClientIpoptionalstringIP of the client from which this request for health check is received by the gateway.
X-Forwarded-ForoptionalstringSequence of all the Ips of the systems involved between the client and the gateway.

Response example (200)

copylink
{
    "Status": "Ok",
    "Source": "Roundtrip",
    "Timestamp": "2022-09-15T04:49:03",
    "ClientIp": "156.77.111.28",
    "X-Forwarded-For": "[156.77.111.28]"
}

post /accounts/transactions/v1/ach/list

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

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

NAMETYPEDESCRIPTION
accountNumberrequiredstringThe bank account number. This field cannot exceed 16 characters.
dateSearchTypeoptionalstringEach 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
fromDateoptionalstringStart date for the date range. This date must be the current date or prior to the current date. Transaction data can be recalled within 180 days of the current date. Format: YYYY-MM-DD
toDateoptionalstringEnd date for the date range. This date can be the current day or a later date from the start date (fromDate). The date range should not exceed 31 days. Format: YYYY-MM-DD
minimumAmountoptionalstringThe 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.
maximumAmountoptionalstringThe 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.
traceNumberoptionalstringThe unique number for the transaction provided by the originator.
pageNumberoptionalstringThe number of the page being viewed. This number must be greater than or equal to 1.
pageSizeoptionalstringThe total number of pages returned. This number must be greater than or equal to 1 and cannot exceed 1000.

Request example

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

Response example (200)

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

Response example (400)

copylink
{
"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 /accounts/transactions/v1/ach/detail/{parNumber}

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

path FIELDTYPEDESCRIPTION
parNumberrequiredstringThe unique PAR number assigned to the the transaction by the ACH product processor.
 
NAMETYPEDESCRIPTION
parNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionStatusoptionalstringThe status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED
traceNumberoptionalstringThe unique number for the transaction provided by the originator.
transactionAmountoptionalnumberThe dollar amount of the transaction.
settlementDateoptionalstringThe date the transaction settlement occurred. Format: YYYY-MM-DD
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionDescriptionoptionalstringDescription about the purpose of the transaction.
authorizedCustomerNameoptionalstringAuthorized customer name
standardEntryClassCodeoptionalstringThe three-digit Standard Entry Class code based on Nacha rules.
standardEntryClassDescriptionoptionalstringThe description for the Nacha SEC code.
receivingAccountoptionalObjectAccountDetail
receivingPartyoptionalObjectPartyDetail
originatingAccountoptionalObjectAccountDetail
originatingPartyoptionalObjectPartyDetail
returnDateoptionalstringDate of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptionalstringThe 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
returnReasonDescriptionoptionalstringDescription as to why the ACH transaction is returned.
addendaCountoptionalintegerCount of addenda records.
notificationOfChangeAddendaCountoptionalintegerCount of change notifications for addenda records.
internationalAddendaCountoptionalintegerCount of international addenda records.
customDataoptionalstringThe 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.
checkSerialNumberoptionalstringSerial number for the check converted to an ACH transaction.
transactionDirectionoptionalstringIndicates the direction of the transaction. Valid values: ORIGINATING ITEM, RECEIVING ITEM
addendaoptionalarrayAddendum
notificationOfChangeoptionalarrayNotificationOfChange

Response example (200)

copylink
{
    "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"
        }
    ]
}
NAMETYPEDESCRIPTION
parNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionStatusoptionalstringThe status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED
traceNumberoptionalstringThe unique number for the transaction provided by the originator.
transactionAmountoptionalnumberThe dollar amount of the transaction.
settlementDateoptionalstringThe date the transaction settlement occurred. Format: YYYY-MM-DD
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionDescriptionoptionalstringDescription about the purpose of the transaction.
authorizedCustomerNameoptionalstringAuthorized customer name
standardEntryClassCodeoptionalstringThe three-digit Standard Entry Class code based on Nacha rules.
standardEntryClassDescriptionoptionalstringThe description for the Nacha SEC code.
receivingAccountoptionalObjectAccountDetail
receivingPartyoptionalObjectPartyDetail
originatingAccountoptionalObjectAccountDetail
originatingPartyoptionalObjectPartyDetail
returnDateoptionalstringDate of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptionalstringThe 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
returnReasonDescriptionoptionalstringDescription as to why the ACH transaction is returned.
addendaCountoptionalintegerCount of addenda records.
notificationOfChangeAddendaCountoptionalintegerCount of change notifications for addenda records.
internationalAddendaCountoptionalintegerCount of international addenda records.
customDataoptionalstringThe 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.
checkSerialNumberoptionalstringSerial number for the check converted to an ACH transaction.
transactionDirectionoptionalstringIndicates the direction of the transaction. Valid values: ORIGINATING ITEM, RECEIVING ITEM
addendaoptionalarrayAddendum
notificationOfChangeoptionalarrayNotificationOfChange

Response example (200)

copylink
{
    "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"
        }
    ]
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringA human-readable message that describes the type or source of the error.
TransactionIdoptionalstringA unique transaction ID returned with the response, useful for traceability.
TransactionTimeoptionalstringDate (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
ServiceErroroptionaloneOfserviceErrorData connectError
NAMETYPEDESCRIPTION
ConnectErroroptionalstringAPI connectivity error information, if available.
NAMETYPEDESCRIPTION
getACHReturnTransactionsResponseoptionalObjectachReturnTransactionsResponse
NAMETYPEDESCRIPTION
returnTransactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
sourceBankNumberoptionalstringOriginating entry bank number
sourceAccountNumberoptionalstringOriginating account number
sourceTransactionRecordNumberoptionalstringOriginating record number for the transaction
sourceSysCodeoptionalstringDo not use. This field is for internal purpose only.
sourceSysOfRecordCodeoptionalstringDo not use. This field is for internal purpose only.
snapshotDateoptionalstringThis field is for internal purpose only.
originalACHTransactionParNumberoptionalstringThe assigned PAR number for the original ACH transaction.
originalTransactionProcessDateoptionalstringDate the transaction is processed. Format: YYYY-MM-DD
originalTransactionProcessTimeoptionalstringTime the transaction is processed in 24-hour time. Format: HHMMSS
originalTransactionProcessTimestampoptionalstringThe date and time the transaction is processed. Format: YYYY-MM-DD HH:MM:SS
originatingReceiverCodeoptionalstringTwo-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.
originatingReceiverDescriptionoptionalstringDescription for the returned originating receiver code.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionFlowTypeCodeoptionalstringIdentifies if transaction is intrabank (within a single financial institution) or interbank (between two or more banks). Valid values: INTRA, INTER
transactionFlowTypeDescriptionoptionalstringDescription for the transaction flow type code.
transactionAmountoptionalstringThe dollar amount of the transaction.
transactionDescription1optionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
transactionDescription2optionalstringAdditional transaction description information.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
sourceTransactionCreatedDateoptionalstringDate when the user created the ACH transaction. Format: YYYY-MM-DD
sourceTransactionCreatedTimeoptionalstringTime when the user created the ACH transaction. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionCreatedTimestampoptionalstringThe date and time that the ACH transaction was created. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionProcessDateoptionalstringDate when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptionalstringTime when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptionalstringThe date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
inboundCollectionWindowoptionalstringThe time window when the transaction collection is processed. The time format uses the 24-hour clock. Format: HHMM
outboundCollectionWindowoptionalstringThe outbound processing window for the transaction collection. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledDateoptionalstringDate when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptionalstringThe time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptionalstringThe date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
receivingAccountNumberoptionalstringAccount number of the person or institution receiving the funds.
receivingCustIdentificationNumberoptionalstringThe customer identification number for the person receiving the transaction.
receivingCustomerNameoptionalstringCustomer name of the person receiving the funds.
receivingCompanyNameoptionalstringCompany name of the institution getting the funds.
receivingFIBankNumberoptionalstringBank number for the financial institution receiving the funds.
receivingFIRoutingNumberoptionalstringRouting number for the receiving financial institution.
originatingAccountNumberoptionalstringAccount number of the ACH transaction originator.
originatingCustIdentificationNumberoptionalstringOriginating customer identification number
originatingCustomerNameoptionalstringOriginating customer name
originatingCompanyNameoptionalstringOriginating company name
originatingFIBankNumberoptionalstringOriginating financial institution bank number
originatingFIRoutingNumberoptionalstringOriginating financial institution routing number
authorizedCustomerNameoptionalstringAuthorized customer name
immediateDestinationIDoptionalstringThe ID indicates the next location of the file once it leaves KeyBank.
returnReleaseDateoptionalstringRelease date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptionalstringThe 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
returnReasonDescriptionoptionalstringDescription as to why the ACH transaction is returned.
checkSerialNumberoptionalstringSerial number for the check converted to an ACH transaction.
nachaBatchNumberoptionalstringThe sequential number of the Nacha batch job.
nachaFileHeadRefererenceNumberoptionalstringThe Nacha transaction file reference number.
nachaSecondarySecCodeoptionalstringThe secondary Nacha standard entry class (SEC) code for the transaction, if applicable. Valid values: CCD, CTX, PPD, TEL, WEB.
nachaSecondarySecDescriptionoptionalstringThe description for the secondary Nacha SEC code.
traceIdoptionalstringThe trace ID number from the source application.
postCompanyCostcontrolNumberoptionalstringDo not use. This field is for internal purpose only.
glAccountNumberoptionalstringDo not use. This field is for internal purpose only.
collectionPointoptionalstringTransaction collection point
collectionApplicationTypeCodeoptionalstringDo not use. This field is for internal purpose only.
collectionApplicationTypeDescriptionoptionalstringDo not use. This field is for internal purpose only.
batchIDoptionalstringThe identification number for the batch job.
customDataoptionalstringCustom data from the originating payment request.
NAMETYPEDESCRIPTION
errorCodeoptionalstringBusiness error code
errorDescriptionoptionalstringBusiness error description
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
ACHReturnTransactionoptionalarrayACHReturnTransaction
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
errorCodeoptionalstringSystem error code
errorDescriptionoptionalstringSystem error description
NAMETYPEDESCRIPTION
getACHReturnTransactionsRequestoptionalObjectgetACHReturnTransactionsRequest
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequiredstringThe start date of a date range for submitted transactions. This date should be less than or equal to the current date. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequiredstringThe end date of a date range for the submitted transactions. The date must be later than the start date (fromDate). Date range cannot exceed more than one year. Format: YYYY-MM-DD
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptionalstringTransaction amount lower limit value to be searched.
toAmountoptionalstringTransaction amount upper limit value to be searched.
parNumberoptionalstringThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
detailsFlagrequiredstringReturn a detailed response (Y) or a brief response (N). Valid values: Y, N
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptionalstringPagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptionalstringPagination 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.
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successful or not. Valid values: accepted, failure
statusDescriptionrequiredstringDescription of the status
retrivedRowsoptionalstringTotal number of transactions retrieved.
totalRowsoptionalstringTotal number of transactions matching the requested criteria.
dataLoadDateoptionalstringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
NAMETYPEDESCRIPTION
businessFaultoptionalarraybusinessFault
systemFaultoptionalarraysystemFault
NAMETYPEDESCRIPTION
getACHCollectedTransactionsRequestoptionalObjectgetACHCollectedTransactionsRequest
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequiredstringThe start date of a date range for submitted transactions. This date should be less than or equal to the current date. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequiredstringThe end date of a date range for the submitted transactions. The date must be later than the start date (fromDate). Date range cannot exceed more than one year. Format: YYYY-MM-DD
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptionalstringTransaction amount lower limit value to be searched.
toAmountoptionalstringTransaction amount upper limit value to be searched.
addendaFlagrequiredstringRetrieves addenda information if set to Y for yes. Valid values: Y, N
secCodeoptionalstringThe three-digit Standard Entry Class code based on Nacha rules. Valid values: CCD, CTX, PPD, TEL, WEB
traceNumberoptionalstringThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
parNumberoptionalstringThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
detailsFlagrequiredstringReturn a detailed response (Y) or a brief response (N). Valid values: Y, N
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptionalstringPagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptionalstringPagination 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.
NAMETYPEDESCRIPTION
getACHStatusInquiryRequestoptionalObjectgetACHStatusInquiryParRequest
NAMETYPEDESCRIPTION
getACHStatusInquiryRequestoptionalObjectgetACHStatusInquiryTraceNumberRequest
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
parNumberrequiredarrayThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
traceNumberoptionalarrayThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptionalstringPagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptionalstringPagination 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.
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
traceNumberrequiredarrayThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
parNumberoptionalarrayThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptionalstringPagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptionalstringThis 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.
NAMETYPEDESCRIPTION
getACHPostedTransactionsRequestoptionalObjectgetACHPostedTransactionsRequest
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequiredstringThe start date of a date range for submitted transactions. This date should be less than or equal to the current date. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequiredstringThe end date of a date range for the submitted transactions. The date must be later than the start date (fromDate). Date range cannot exceed more than one year. Format: YYYY-MM-DD
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptionalstringTransaction amount lower limit value to be searched.
toAmountoptionalstringTransaction amount upper limit value to be searched.
parNumberoptionalstringThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptionalstringPagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptionalstringPagination 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.
NAMETYPEDESCRIPTION
getACHCollectedTransactionsResponserequiredObjectgetACHCollectedTransactionsResponse
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
ACHCollectedTransactionoptionalarrayachCollectedTransactionsResult
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
transactionParNumberoptionalstringThe unique PAR number assigned to the transaction by the ACH product processor.
sourceBankNumberoptionalstringOriginating entry bank number
sourceAccountNumberoptionalstringOriginating account number.
origAcctSuffixoptionalstringDo not use. This field is for internal purpose only.
sourceSysCodeoptionalstringDo not use. This field is for internal purpose only.
sourceSysOfRecordCodeoptionalstringDo not use. This field is for internal purpose only.
snapshotDateoptionalstringThis field is for internal purpose only.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionFlowTypeCodeoptionalstringIdentifies if transaction is intrabank (within a single financial institution) or interbank (between two or more banks). Valid values: INTRA, INTER
transactionFlowTypeDescriptionoptionalstringDescription for the transaction flow type code.
originatingReceiverCodeoptionalstringTwo-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.
transactionAmountoptionalstringThe dollar amount of the transaction.
transactionDescriptionoptionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
inboundCollectionWindowoptionalstringThe time window when the transaction collection is processed. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionProcessDateoptionalstringDate when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptionalstringTime when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptionalstringThe date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionSettledDateoptionalstringDate when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptionalstringThe time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptionalstringThe date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionPostDateoptionalstringDate the ACH transaction is posted. Format: YYYY-MM-DD
sourceTransactionPostTimeoptionalstringTime the ACH transaction is posted. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionPostTimestampoptionalstringThe date and time the transaction is posted. Format: YYYY-MM-DD HH:MM:SS
deliveryStatusCodeoptionalstringThe code abbreviation for the delivery status of the ACH transaction.
deliveryStatusDescriptionoptionalstringThe delivery status description for the abbreviated code.
receivingAccountNumberoptionalstringAccount number of the person or institution receiving the funds.
receivingFIBankNumberoptionalstringBank number for the financial institution receiving the funds.
receivingFIRoutingNumberoptionalstringRouting number for the receiving financial institution.
receivingCustIdentificationNumberoptionalstringThe customer identification number for the person receiving the transaction.
receivingCustomerNameoptionalstringCustomer name of the person receiving the funds.
receivingCompanyNameoptionalstringCompany name of the institution getting the funds.
originatingAccountNumberoptionalstringAccount number of the ACH transaction originator.
originatingFIBankNumberoptionalstringOriginating financial institution bank number
originatingFIRoutingNumberoptionalstringOriginating financial institution routing number
originatingCustIdentificationNumberoptionalstringOriginating customer identification number
originatingCompanyNameoptionalstringOriginating company name
originatingCustomerNameoptionalstringOriginating customer name
checkSerialNumberoptionalstringSerial number for the check converted to an ACH transaction.
nachaBatchNumberoptionalstringThe sequential number of the Nacha batch job.
nachaFileHeadRefererenceNumberoptionalstringThe Nacha transaction file reference number.
nachaSecCodeoptionalstringThe Nacha standard entry class (SEC) code for the transaction. Valid values: CCD, CTX, PPD, TEL WEB
nachaSecDescriptionoptionalstringThe description for the Nacha SEC code.
traceNumberoptionalstringThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
postCompanyCostcontrolNumberoptionalstringDo not use. This field is for internal purpose only.
glAccountNumberoptionalstringDo not use. This field is for internal purpose only.
addendaPresentFlagoptionalstringIndicates if there are addenda records or not.
addendaRecordNumberoptionalstringNumber of addenda records.
originatingReceiverDescriptionoptionalstringDescription for the collected originating receiver code.
goRoutingNumberoptionalstringGateway operator routing number for international transactions.
authorizedCustomerNameoptionalstringAuthorized customer name
iatFlagoptionalstringInternational transaction identifier
collectionPointoptionalstringTransaction collection point
batchIdoptionalstringThe identification number for the batch job.
transactionTraceIdoptionalstringThe trace ID number from the source application.
addendaInformationoptionalObjectaddendaInformation
customDataoptionalstringCustom data from the originating payment request.
NAMETYPEDESCRIPTION
getACHPostedTransactionsResponserequiredObjectgetACHPostedTransactionsResponse
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
ACHPostedTransactionoptionalarrayachPostedTransactionsResult
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
snapshotDateoptionalstringDo not use. This field is for internal purpose only.
processDateoptionalstringDate the transaction was processed. Format: YYYY-MM-DD
sourceBankNumberoptionalstringOriginating entry bank number
sourceAccountNumberoptionalstringOriginating account number
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionAmountoptionalstringThe dollar amount of the transaction.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
hoganTransactionCodeoptionalstringThe KeyBank Hogan code for the transaction.
baiCodeoptionalstringThe three-digit BAI (Bank Administration Institute) code for the transaction.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
regulationDescription1optionalstringRegulation description for the transaction.
regulationDescription2optionalstringAdditional regulation information for the transaction.
regulationDescription3optionalstringAdditional regulation information for the transaction.
regulationDescription4optionalstringAdditional regulation information for the transaction.
postingWindowoptionalstringThe time window when the transaction collection is posted. The time format uses the 24-hour clock. Format: HHMM
batchIDoptionalstringThe identification number for the batch job.
customDataoptionalstringCustom data from the originating payment request.
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
ACHTransactionStatusoptionalarrayachStatusInquiryResult
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
ACHStatusoptionalstringThe status informs you if the ACH transaction has been collected or returned. Valid values: COLLECTED or RETURNED
ACHCollectedTransactionoptionalObjectachCollectedTransactionsStatusResult
ACHPostedTransactionoptionalObjectachPostedTransactionsStatusResult
ACHReturnTransactionoptionalObjectachReturnTransactionsStatusResult
NAMETYPEDESCRIPTION
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
sourceBankNumberoptionalstringOriginating entry bank number
sourceAccountNumberoptionalstringOriginating account number.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionAmountoptionalstringThe dollar amount of the transaction.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
sourceTransactionProcessDateoptionalstringDate when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptionalstringTime when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptionalstringThe date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionSettledDateoptionalstringDate when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptionalstringThe time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptionalstringThe date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionPostDateoptionalstringDate the ACH transaction is posted. Format: YYYY-MM-DD
sourceTransactionPostTimeoptionalstringTime the ACH transaction is posted. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionPostTimestampoptionalstringThe date and time the transaction is posted. Format: YYYY-MM-DD HH:MM:SS
receivingCustomerNameoptionalstringCustomer name of the person receiving the funds.
receivingCompanyNameoptionalstringCompany name of the institution getting the funds.
originatingCompanyNameoptionalstringOriginating company name
originatingCustomerNameoptionalstringOriginating customer name
nachaSecCodeoptionalstringThe Nacha standard entry class (SEC) code for the transaction. Valid values: CCD, CTX, PPD, TEL, WEB
traceNumberoptionalstringThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
transactionDescriptionoptionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
receivingCustIdentificationNumberrequiredstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
NAMETYPEDESCRIPTION
processDateoptionalstringDate the transaction was processed. Format: YYYY-MM-DD
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionAmountoptionalstringThe dollar amount of the transaction.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
baiCodeoptionalstringThe three-digit BAI (Bank Administration Institute) code for the transaction.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
regulationDescription1optionalstringRegulation description for the transaction.
regulationDescription2optionalstringAdditional regulation information for the transaction.
regulationDescription3optionalstringAdditional regulation information for the transaction.
regulationDescription4optionalstringAdditional regulation information for the transaction.
postingWindowoptionalstringThe time window when the transaction collection is posted. The time format uses the 24-hour clock. Format: HHMM
NAMETYPEDESCRIPTION
transactionParNumberoptionalstringThe unique PAR number assigned to the transaction by the ACH product processor.
transactionCodeoptionalstringTwo digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionAmountoptionalstringThe dollar amount of the transaction.
transactionDescription1optionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
transactionDescription2optionalstringAdditional transaction description information.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
returnReleaseDateoptionalstringRelease date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptionalstringThe 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
returnReasonDescriptionoptionalstringDescription as to why the ACH transaction is returned.
NAMETYPEDESCRIPTION
iatAddendumoptionalObjectiatAddendum
nonIatAddendumoptionalObjectnonIatAddendum
nocAddendumoptionalObjectnocAddendum
NAMETYPEDESCRIPTION
addendaParNumberoptionalstringThe unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptionalstringDo not use. This field is for internal purpose only.
transactionParNumberoptionalstringThe unique PAR number assigned to the transaction by the ACH product processor.
payInformationoptionalstringAdditional information about the remittance payment.
addendaTypeCodeoptionalstringTwo-digit code identifying the type of information.
addendaTypeDescriptionoptionalstringDescription of the addenda type associated with the code.
transactionTypeCodeoptionalstringThis field contains a three-character code used to identify the type of transaction.
transactionTypeDescroptionalstringThis field contains description of the the transaction type code
originatingFiIdentificationNumberCodeoptionalstringOriginating financial institution code
originatingFiNameoptionalstringOriginating financial institution name
originatingFiIdentificationNumberoptionalstringOriginating financial institution identification number
originatingFiBranchCountryCodeoptionalstringOriginating company country branch code
originatingCompanyNameoptionalstringOriginating company name
originatingCompanyAddress1optionalstringOriginating bank physical street address, line 1
originatingCompanyAddress2optionalstringOriginating bank physical street address, line 2
originatingCompanyCityStateProvinceoptionalstringOriginator city and state
originatingCompanyCountryPostalCodeoptionalstringOriginator country and postal code
receivingFiNameoptionalstringReceiving financial institution name
receivingFiIdentificationNumberoptionalstringReceiving financial institution identification number
receivingFiIdentificationNumberCodeoptionalstringReceiving financial institution code
receivingFiBranchCountryCodeoptionalstringReceiving company country branch code
receivingCustomerNameoptionalstringReceiving customer name
receivingCompanyNameoptionalstringReceiving company name
receivingCompanyNumberoptionalstringReceiving company number
receivingCompanyAddress1optionalstringReceiving company physical address, line 1
receivingCompanyAddress2optionalstringReceiving company physical address, line 2
receivingCompanyCityStateProvinceoptionalstringReceiving company city and state
receivingCompanyCountryPostalCodeoptionalstringReceiving company country and postal code
foreignCorrespondentFiIdNumberCodeoptionalstringForeign correspondent bank identification number qualifier
foreignCorrespondentFiNameoptionalstringCorrespondent bank name
foreignCorrespondentFiBRCountryCodeoptionalstringCorrespondent bank country code
foreignCorrespondentBankIdNumberoptionalstringCorrespondent bank identifier
foreignOriginatingAmountoptionalstringForeign payment amount
foreignOriginatingCurrencyCodeoptionalstringForeign currency code
foreignTraceNumberoptionalstringIdentifier number of the foreign transaction.
addendaSequenceNumberoptionalstringThe sequence number of the addenda. The number cannot exceed 4 digits.
entryDetailSequenceNumberoptionalstringSequence number of the entry detail
operatorCommandFlagoptionalstringOperator command flag
NAMETYPEDESCRIPTION
addendaParNumberoptionalstringThe unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptionalstringDo not use. This field is for internal purpose only.
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionSerialNumberoptionalstringSerial number for the transaction
transactionDescriptionoptionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
sourceTransactionCreatedDateoptionalstringDate when the user created the ACH transaction. Format: YYYY-MM-DD
sourceTransactionCreatedTimeoptionalstringTime when the user created the ACH transaction. The time format uses the 24-hour clock. Format: HHMM
payInformationoptionalstringAdditional information associated with the payment transaction.
addendaTypeCodeoptionalstringTwo-digit code identifying the type of information.
addendaTypeDescriptionoptionalstringDescription of the addenda type associated with the code.
entryDetailSequenceNumberoptionalstringSequence number of the entry detail
referenceInformation1optionalstringFree form text field with additional reference information.
referenceInformtion2optionalstringFree form text field with additional reference information.
networkIdentificationCodeoptionalstringNetwork identification code (NIC)
terminalIdentificationCodeoptionalstringTerminal identification code
terminalCityoptionalstringCity location of the terminal
terminalStateoptionalstringState location of the terminal
keyBankTransactionReferenceNumberoptionalstringUnique ACH transaction identifier created by KeyBank.
operatorCommandFlagoptionalstringOperator command flag
NAMETYPEDESCRIPTION
addendaParNumberoptionalstringThe unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptionalstringDo not use. This field is for internal purpose only.
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
addendaTypeCodeoptionalstringTwo-digit code identifying the type of information.
addendaTypeDescriptionoptionalstringDescription of the addenda type associated with the code.
changeCodeoptionalstringThe three-character change code begins with the letter 'C'. This code is applied to all NOCs to indicate the information that is being changed.
changeDescriptionoptionalstringThe description associated with the change code.
receivingFiIdentificationNumberoptionalstringReceiving financial institution identification number
correctedDataoptionalstringThe corrected data per the correction change code.
externalFiTransactionIdentificationNumberoptionalstringThe number used by an external financial institution to identify the transaction.
keyBankTransactionReferenceNumberoptionalstringUnique ACH transaction identifier created by KeyBank.
operatorCommandFlagoptionalstringOperator command flag.
NAMETYPEDESCRIPTION
accountNumberoptionalstringBank account number.
NAMETYPEDESCRIPTION
accountNumberoptionalstringBank account number of the ACH originator or receiver.
bankNumberoptionalstringBank number associated with the account number.
routingNumberoptionalstringNine-digit routing number for the account provided in the original request.
NAMETYPEDESCRIPTION
parNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionStatusoptionalstringThe status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED
traceNumberoptionalstringThe unique number for the transaction provided by the originator.
transactionAmountoptionalnumberThe dollar amount of the transaction.
settlementDateoptionalstringThe date the transaction settlement occurred. Format: YYYY-MM-DD
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionDescriptionoptionalstringDescription about the purpose of the transaction.
authorizedCustomerNameoptionalstringAuthorized customer name
standardEntryClassCodeoptionalstringThe three-digit Standard Entry Class code based on Nacha rules.
standardEntryClassDescriptionoptionalstringThe description for the Nacha SEC code.
receivingAccountoptionalObjectAccountDetail
receivingPartyoptionalObjectPartyDetail
originatingAccountoptionalObjectAccountDetail
originatingPartyoptionalObjectPartyDetail
returnDateoptionalstringDate of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptionalstringThe 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
returnReasonDescriptionoptionalstringDescription as to why the ACH transaction is returned.
addendaCountoptionalintegerCount of addenda records.
notificationOfChangeAddendaCountoptionalintegerCount of change notifications for addenda records.
internationalAddendaCountoptionalintegerCount of international addenda records.
customDataoptionalstringThe 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.
checkSerialNumberoptionalstringSerial number for the check converted to an ACH transaction.
transactionDirectionoptionalstringIndicates the direction of the transaction. Valid values: ORIGINATING ITEM, RECEIVING ITEM
addendaoptionalarrayAddendum
notificationOfChangeoptionalarrayNotificationOfChange
NAMETYPEDESCRIPTION
parNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionStatusoptionalstringThe status of the ACH transaction. Valid values: COLLECTED, RETURNED, SETTLED
traceNumberoptionalstringThe unique number for the transaction provided by the originator.
transactionAmountoptionalnumberThe dollar amount of the transaction.
settlementDateoptionalstringThe date the transaction settlement occurred. Format: YYYY-MM-DD
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
authorizedCustomerNameoptionalstringAuthorized customer name
standardEntryClassCodeoptionalstringThe three-digit Standard Entry Class code based on Nacha rules.
receivingAccountoptionalObjectAccountList
receivingPartyoptionalObjectPartyList
originatingAccountoptionalObjectAccountList
originatingPartyoptionalObjectPartyList
returnDateoptionalstringDate of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptionalstringThe 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
returnReasonDescriptionoptionalstringDescription as to why the ACH transaction is returned.
addendaCountoptionalintegerCount of addenda records.
notificationOfChangeAddendaCountoptionalintegerCount of change notifications for addenda records.
internationalAddendaCountoptionalintegerCount of international addenda records.
NAMETYPEDESCRIPTION
sequenceNumberoptionalintegerThe addenda record item number in order of sequence. Number cannot exceed 4 digits.
entryDetailSequenceNumberoptionalstringThe entry number in order of sequence. Number cannot exceed 7 digits.
paymentRelatedInformationoptionalstringThe related payment information from the addenda records. The maximum character limit is 255.
NAMETYPEDESCRIPTION
codeoptionalstringCode for the related message.
messageoptionalstringMessage associated with the code.
NAMETYPEDESCRIPTION
pageNumberoptionalintegerThe number of the page being viewed.
pageSizeoptionalintegerThe number of records per page.
totalPagesoptionalintegerThe number of pages there are in total.
totalRecordsoptionalintegerThe total number of transactions available in the result set.
lastPageoptionalbooleanIndicates if the current page (page number) is the last page of the result set. Valid values: true, false
NAMETYPEDESCRIPTION
messagesoptionalarrayMessage
pageoptionalObjectPage
NAMETYPEDESCRIPTION
customerIdentificationNumberoptionalstringThe unique identification number associated with the customer.
companyNameoptionalstringThe name of the corporation or institution making the request.
NAMETYPEDESCRIPTION
customerIdentificationNumberoptionalstringThe unique identification number associated with the customer.
companyNameoptionalstringThe name of the corporation or institution making the request.
customerNameoptionalstringThe name of the customer.
NAMETYPEDESCRIPTION
changeCodeoptionalstringThe three-character change code begins with the letter 'C'. This code is applied to all NOCs to indicate the information that is being changed.
changeDescriptionoptionalstringThe description associated with the change code.
correctedDataoptionalstringThe corrected data per the correction change code.

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.

 

HTTP
STATUS CODE
CUSTOM
STATUS CODE
DESCRIPTION
299W

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.

400F

ECA-W-001 Request Validation failed.

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

400F

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