Data values

clock 8-minute read calender 3.1.0 | updated Aug. 07, 2024

Decrypting and decoding API parameters

There are fields present across KeyBank APIs, in both request and response objects, that have predefined values. Some of these values are specific to KeyBank and others are industry-standard values. The purpose of this page is to catalog as many of these data values as possible and provide definitions for their usage within our APIs.

Each data value definition contains a brief description, the specific fields and APIs where the data value can be found, and a tabular listing of possible values and what these values mean.

Data valuesField namesApplicable APIsDescription
Addenda type codesaddendaTypeCodeACH Origination, ACH InquiryA two-digit code that defines the specific interpretation and format for the addenda information contained in the addenda record.
BAI codesbaiCode, amountTypeCode, derivedBaiCode,transactionCodeBAI2ACH Inquiry, Intraday Reporting, Previous Day ReportingA BAI (Bank Administration Institute) code is a three-digit code identifying a banking transaction and are divided into balance codes and transaction codes.
Change codeschangeCode, nocChangeCodeACH Inquiry, Webhooks (ACH alerts)In the case of a Notification of Change (NOC), this is a three-character code beginning with the letter 'C' that indicates the information being changed.
Foreign bank type codesforeignBankSystemTypeWire Transfer, RTP Send PaymentFive-character global routing/clearing codes for payments in foreign countries.
ID type codesidTypeAccount ValidationOne-character code that indicates the type of ID used to verify account ownership.
Pay subtype codespaySubTypeWire InquiryA four-digit code that corresponds to a particular wire drawdown scenario.
Return reason codesreturnReasonCode, retReturnReasonCodeACH Inquiry, Webhooks (ACH alerts)In the case of a returned ACH payment, this is a three-character code beginning with the letter 'R' that identify a reason an ACH payment was returned.
Transaction codestransactionCode, retTranCode, tranCodeACH Inquiry, ACH Origination, Intraday Reporting, Webhooks (ACH alerts)A two-digit code identifying various types of debit and credit entries.
Wire and RTP alert statusestransBusnStatusCodeWebhooks (Wire/RTP alerts)The intermittent or final statuses possible for Wire and RTP webhook alerts.

A two-digit code that defines the specific interpretation and format for the addenda information contained in the addenda record.

Addenda type codes can be found in the following fields:

CodeDescription
02Point of Sale Entry (POS), Shared Network Transaction (SHR), or Machine Transfer Entry (MTE)
05Corporate Credit or Debit (CCD), Customer Initiated Entries (CIE), Corporate Trade Exchange (CTX), Prearranged Payment and Deposit (PPD), Internet Initiated/Mobile Entries (WEB)
10-161st-7th addenda records for International ACH Transaction (IAT)
17IAT Remittance Information addenda record
18IAT Foreign Correspondent Bank addenda record
98Used for Notification of Change (NOC) entries
99Used for Return entries

A BAI (Bank Administration Institute) code is a three-digit code identifying a banking transaction and are divided into balance codes and transaction codes.

BAI codes can be found in the following fields:

Balance codes

CodeDescription
010Opening Ledger
015Closing Ledger
040Opening Available
045Closing Available
072One Day Float
074Two or More Day Float
100Total Credits
109Current Day Total Lockbox Deposits
111Lockbox Deposit - Zero Day Float
112Lockbox Deposit - One Day Float
113Lockbox Deposit - Two Day Float
115Lockbox Deposit
140Total ACH Credits
190Total Incoming Money Transfers
400Total Debits
450Total ACH Debits
490Total Outgoing Money Transfers
580Total Controlled Disbursement Debits
584Total Disbursements Late Amount
585Disbursing Funding Requirement
602Total CDA Adjustments

Transaction codes

CodeDescription
158Real Time Payment Credit
165Pre-authorized ACH Credit
171Individual Loan Deposit
172Deposit Correction
195Incoming Money Transfer
201Individual Automatic Transfer Credit
206Book Transfer Credit
213Letter of Credit
214Foreign Exchange Credit
229Miscellaneous International Credit
237Individual Collection Credit
238Collection of Dividends
244Interest / Matured Principle Payment
252Debit Reversal
258ACH Reversal Credit
275ZBA Credit
295ATM Credit
301Commercial Deposit
306Fed Funds Sold
351Individual Investment Sold
354Interest Credit
357Credit Adjustment
359Interest Adjustment Credit
395Check Reversal
398Miscellaneous Fee Refund
399Miscellaneous Credit
451ACH Debit Received
455Pre-authorized ACH Debit
458Real Time Payment Debit
475Check Paid
481Individual Loan Payment
495Outgoing Money Transfer
501Individual Automatic Transfer Debit
506Book Transfer Debit
512Letter of Credit Debit
513Letter of Credit
514Foreign Exchange Debit
529Miscellaneous International Debit
544Interest / Matured Principle Payment
552Credit Reversal
555Deposited Item Returned
558ACH Reversal Debit
564Overdraft Fee
567Return Item Fee
575ZBA Debit
595ATM Debit
627Fed Funds Purchased
631Debit Adjustment
651Individual Investment Purchased
654Interest Debit
659Interest Adjustment Debit
661Account Analysis Fee
666Currency and Coin Shipped
690Miscellaneous Debit
694Deposit Reversal
695Deposit Correction Debit
698Miscellaneous Fees
699Miscellaneous Debit
760Commercial Loan Debit

In the case of a Notification of Change (NOC), this is a three-character code beginning with the letter 'C' that indicates the information being changed.

Change codes can be found in the following fields:

CodeDescription
C01Incorrect bank account number
C02Incorrect transit/routing number
C03Incorrect transit/routing number and bank account number
C04Bank account name change
C05Incorrect transaction code
C06Incorrect bank account number and transaction code
C07Incorrect transit/routing number, bank account number, and transaction code
C08Incorrect Receiving DFI Identification (IAT only)
C09Incorrect individual identification
C10Incorrect company name
C11Incorrect company identification
C12Incorrect company name and identification
C13Addenda format error

Five-character global routing/clearing codes for payments in foreign countries.

Foreign bank type codes can be found in the following field:

CodeDescription
ATBLZAustria
AUBSBAustralia
CACPACanada
CHSICSwitzerland
DEBLZGermany
ESNCCSpain
GBDSCGreat Britain
HKNCCHong Kong
IENCCIreland
INFSCIndia
ITNCCItaly
NZNCCNew Zealand
PTNCCPortugal
USABAUS FedWire
ZANCCSouth Africa

The idType indicated the type of identification used to verify the identification of an account owner.

ID type codes can be found in the Account Validation API.

CodeIdentification type
0Driver's license (USA)
1Military (USA)
2Passport
3Resident alien ID
4State identification
5Student identification
6Driver's license (intercontinental)
7Driver's license (Canada)
8Driver's license (Mexico)
9Other primary ID (intercontinental)
AMatricula Consular card
BSouth America Cedula No.

A four-digit code that corresponds to a particular wire drawdown scenario.

Pay subtype codes can be found in the following field:

CodeDescription
1031Request for customer drawdown
1032Transfer honoring customer drawdown request
1033Refusal of customer drawdown request
1631Request for bank-to-bank drawdown
1632Transfer honoring bank-to-bank drawdown request
1633Refusal of bank-to-bank drawdown request

In the case of a returned ACH payment, this is a three-character code beginning with the letter 'R' that identify a reason an ACH payment was returned.

Return reason codes can be found in the following fields:

CodeDescription
R01Insufficient funds - The available and/or cash reserve balance is not sufficient to cover the dollar value of the debit entry.
R02Account closed – A previously active account has been closed by action of the customer or the RDFI.
R03No account/unable to locate account – The account number structure is valid and it passes the check digit validation, but the account number does not correspond to the individual identified in the entry, or the account number designated is not an existing account.
R04Invalid account number structure – The account number structure is not valid.
R05Unauthorized debit to consumer account using corporate SEC code – CCD or CTX debit entry was transmitted to a Consumer Account of the receiver and was not authorized by the receiver.
R06Returned per ODFI’s request – The ODFI has requested that the RDFI return an erroneous entry.
R07Authorization revoked by customer – The RDFI’s customer (the receiver) revoked the authorization previously provided to the originator for this debit entry.
R08Payment stopped – The receiver has placed a stop payment order on this debit entry.
R09Uncollected funds – A sufficient ledger balance exists to satisfy the dollar value of the transaction, but the available balance is below the dollar value of the debit entry.
R10Customer advises unauthorized, improper, ineligible, or part of an incomplete transaction – The RDFI has been notified by the receiver that the entry is unauthorized, improper, ineligible, or part of an Incomplete Transaction.

A two-digit code identifying various types of debit and credit entries.

Transaction codes can be found in the following fields:

DDA credits

CodeDescription
20Reserved
21Return or Notification of Change for original transaction code 22, 23, or 24
22Demand credit (checking deposit)
23Prenotification for a demand credit; death notification (non-dollar); automated enrollment entry (non-dollar)
24Zero dollar with remittance data (for CCD, CTX, and IAT entries); acknowledgement entries (ACK and ATX entries)

DDA debits

CodeDescription
25Reserved
26Return or Notification of Change for original transaction code 27, 28, or 29
27Demand debit (checking withdrawal)
28Prenotification for a demand debit (non-dollar)
29Zero dollar with remittance data (for CCD, CTX, and IAT entries)

Savings credits

CodeDescription
30Reserved
31Return or Notification of Change for original transaction code 32, 33, or 34
32Savings credit (savings deposit)
33Prenotification for a savings credit; death notification (non-dollar); automated enrollment entry (non-dollar)
34Zero dollar with remittance data (for CCD, CTX, and IAT entries); acknowledgement entries (ACK and ATX entries)

Savings debits

CodeDescription
35Reserved
36Return or Notification of Change for original transaction code 37, 38, or 39
37Savings debit (savings withdrawal)
38Prenotification for a savings debit (non-dollar)
39Zero dollar with remittance data (for CCD, CTX, and IAT entries)

Loan credits

CodeDescription
51Return or Notification of Change for original transaction code 52, 53, or 54
52Loan account credit
53Prenotification for a loan account credit
54Zero dollar with remittance data (for CCD, CTX, and IAT entries)

Loan debits

CodeDescription
55Loan account debit (reversals only)
56Return or Notification of Change for original transaction code 55

Review the tranBusnStatusCode in the alertBody object in Webhooks. The status value identifies the payment event in an intermittent (payment under processing), final (completed payment processed), and success (payment successfully completed) status.

StatusDescriptionInterim StatusFinal StatusSuccess
Pre QualifyingPayment is being evaluated for errors by the Network.X  
Funds ReleasePayment is waiting for OLDS memo post response.X  
PaymentNotificationPayment stopped pending manual release for various reasons.X  
RepairPayment needs correction before it continues processing.X  
Duplicate ContentPayment matches criteria of another payment. Requires action to process further.X  
Regulatory FilterPayment is waiting for response from Fraud or OFAC check.X  
ClearingPayment is waiting for a response from the Payment Network.X  
Product SelectionEPP determines the product for the payment that drives which steps in the workflow will execute.X  
Limit checkChecks EPP for any applicable account or customer limits.X  
AdvisingMost of our customer advising is done outside of EPP, but this could be performing payment network advising of some sort as well.X  
PricingBilling codes and/or network channel fees are applied to the paymentX  
Held Requiring CoverThis payment requires an Operator to clear it out of the Direct and Cover Matching-in Payment Intervention.X  
Internal FilterScans EPP filters for alternate or special processing of the paymentX  
Future WarehouseThe payment is moved to a future business date because it missed the payment network cutoff time. When that future business date arrives and the payment network opens for business, the payment will re-enter the workflow to ultimately reach a FINAL status.X  
CancelledPayment was cancelled. X 
ReturnedPayment was returned by receiving bank. X 
FatalA serious error has occurred. Payment will not complete workflow. X 
RejectedPayment was rejected by Network. Payment will not complete workflow. X 
Future Warehouse CancelledPayment was cancelled from Future Warehouse Queue. X 
AbandonedPayment was manually forced to not complete in EPP. X 
CompletedPayment processed successfully through workflow.  X