Look up the status and details about a wire transaction
Wire Inquiry Endpoints
Summary | Endpoint |
---|---|
Health check | get /wireInquiry/v1/healthCheck |
Get wire transaction details | post /wireInquiry/v1/transactions/details |
Before you begin
All KeyBank APIs require certificates, user credentials, and certain permissions. Check out our Getting Started Guide to learn more.
Health check
get /wireInquiry/v1/healthCheck
Verify you can connect to the API service. A bearer token is required.
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
Statusoptional | string | Status of the health check response. |
Sourceoptional | string | Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved. |
Timestampoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service. |
ClientIpoptional | string | Client IP address the gateway receives from the request. |
X-Forwarded-Foroptional | string | Sequence of IP addresses for systems between the client and the gateway. |
Response example (200)
{ "Status": "Ok", "Source": "Roundtrip", "Timestamp": "2022-09-15T04:49:03", "ClientIp": "156.77.111.28", "X-Forwarded-For": "[156.77.111.28]" }
Get wire transaction details
post /wireInquiry/v1/transactions/details
Get the details about a wire transaction and its status. Wire transaction data can be recalled from the previous 24 months. When setting the date range (fromDate and toDate), the date range specified cannot exceed more than one year.
Request
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
getWireInquiryRequestrequired | Object | getWireInquiryRequest |
Request example
{ "getWireInquiryRequest": { "accountNumber": [ "123456789" ], "transactionType": null, "paymentStatus": null, "fromDate": 1669852800, "toDate": 1669852800, "fromTransmitDate": null, "toTransmitDate": null, "fromAmount": null, "toAmount": null, "traceID": null, "keyBankTransactionReference": null, "sourceChannel": null, "startRowIndex": "1", "endRowIndex": "1000", "channelCode": "OLB" } }
Responses
Successful response
NAME | TYPE | DESCRIPTION |
---|---|---|
getWireInquiryResponserequired | Object | getWireInquiryResponse |
Response example (200)
{ "getWireInquiryResponse": { "responseHeader": { "status": "Success", "statusDescription": "Successfully returned results for the requested range 1 to 1", "retreivedRows": "1", "totalRows": "1" }, "WireInquiryResult": [ { "amount": "6400", "debitCurrencyCode": "USD", "transactionType": "INBOUND FED PAYMENT", "creditAccountNumber": "987654321", "wireEventName": "PaymentWaitForOFCResponse", "clearingBankNumber": "21300077", "creditAccountBankBranch": "US", "creditAccountCurrencyCode": "USD", "creditAccountCustomerNumber": "987654321", "creditAccountCustomerName": "TEST COMPANY 1, LLC", "creditAccountCountry": "US", "creditAccountCustomerType": "CORP", "wireTransactionDirection": "INBOUND", "transactionValueIdentifier": "HVC", "creditTransactionCurrency": "USD", "settlementPaymentType": "CRD", "incomingReferenceNumber": "INVC0012345", "paymentEventType": "BKP", "sendingBankReferenceNumber": "KTT00049210303842R", "initiatingPartyName": "TEST BANK, USA", "initiatingPartyPostalAddressLine1": "127 Public Sq, Cleveland", "initiatingPartyPostalAddressLine2": "OH 44114", "initiatingParty2Name": "TEST COMPANY 2, LLC", "initiatingParty2AccountNumber": "123456789", "initiatingParty2PostalAddressLine1": "726 Exchange Street,Suite 900,", "initiatingParty2PostalAddressLine2": "Buffalo, NY 14210", "transactionDetailDocument": "Receivers Reference Information", "traceID": "01239240303842R", "keybankTransactionReference": "US2201100012345", "transmittedDate": "2022-01-10T00:00:00.000-0500", "federalClearingReferenceNumber": "20220110B1QDRCQR012345", "enteredDate": "2022-01-10T11:38:05.000-0500", "creditorAgentBankName": "KeyBank National Association", "creditorAgentBankPostalAddressLine1": "250 Delaware Ave Ste", "creditorAgentBankPostalAddressLine2": "Buffalo,NY 14202", "beneficiaryName": "TEST COMPANY 1, LLC", "beneficiaryAccountNumber": "987654321", "beneficiaryCreditorPostalAddressLine1": "726 Exchange Street,Suite 900,", "beneficiaryCreditorPostalAddressLine2": "Buffalo, NY 14210", "sourceChannel": "FRB INITIATED", "paymentStatus": "Active", "transactionBusinessStatusCode": "Regulatory Filter", "initiatingFailureReasonCode": "string", "initiatingFailureReasonTitle": "string", "initiatingFailureReasonDesc": "string", "networkFailureReasonCode": "string", "networkFailureReasonTitle": "string", "networkFailureReasonDesc": "string", "remittanceInfo": "string" } ] } }
Missing mandatory information
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (400)
{ "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Unauthorized request
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (401)
{ "ErrorMessage": "Received request is unauthorized, please provide valid credentials", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (403)
{ "ErrorMessage": "Access to requested resource is forbidden", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Resource not found
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (404)
{ "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method denied
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (405)
{ "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Media type not supported
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (415)
{ "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (429)
{ "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server error
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (500)
{ "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Bad gateway
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (502)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "ServiceError": { "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request" } }
Service unavailable
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (503)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request." } }
Gateway timeout
NAME | TYPE | DESCRIPTION |
---|---|---|
ErrorMessageoptional | string | A human-readable message that describes the type or source of the error. |
TransactionIdoptional | string | A unique transaction ID returned with the response, useful for traceability. |
TransactionTimeoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred. |
ServiceErroroptional | oneOf | serviceErrorData connectError |
Response example (504)
{ "ErrorMessage": "Error received from backend", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request." } }
Schemas
businessFault
NAME | TYPE | DESCRIPTION |
---|---|---|
errorCodeoptional | string | Business error code |
errorDescriptionoptional | string | A human-readable message that describes the type or source of the business error. |
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 |
healthResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
Statusoptional | string | Status of the health check response. |
Sourceoptional | string | Origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved. |
Timestampoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service. |
ClientIpoptional | string | Client IP address the gateway receives from the request. |
X-Forwarded-Foroptional | string | Sequence of IP addresses for systems between the client and the gateway. |
getWireInquiryRequest
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 16 characters. |
transactionTypeoptional | array | Indicates the type of transaction. Valid values: INBOUND FED PAYMENT, OUTBOUND SWIFT PAYMENT, OUTBOUND FED PAYMENT, INBOUND SWIFT PAYMENT, INTERNAL, OTHER |
paymentStatusoptional | array | Indicates the status of payment. Valid values: Active, Returned, Cancelled, Success, PendingUserAction |
fromDaterequired | string | The start date to search a range of wire origination transactions by date. The date range must be less than or equal to the current date and cannot exceed more than one year. Format: YYYY-MM-DD |
toDaterequired | string | The end date to search a range of wire origination transactions by date. The date range must be less than or equal to the current date and cannot exceed more than one year. Format: YYYY-MM-DD |
fromTransmitDateoptional | string | The start date to search a range of wire origination transactions by the transmission or settled date. The date range must be less than or equal to the current date and cannot exceed more than one year. Format: YYYY-MM-DD |
toTransmitDateoptional | string | The end date to search a range of wire origination transactions by the transmission or settled date. The date range must be less than or equal to the current date and cannot exceed more than one year. Format: YYYY-MM-DD |
fromAmountoptional | string | Transaction amount lower limit value to be searched. |
toAmountoptional | string | Transaction amount upper limit value to be searched. |
traceIDoptional | string | Source transaction identifier for a specific transaction. |
keyBankTransactionReferenceoptional | string | Unique wire transaction identifier created by KeyBank. |
sourceChanneloptional | array | Denotes the channel that created the wire transaction. KTT INITIATED is used for RTP transaction and FRB INITIATED is used for Federal Reserve transactions. |
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. |
channelCodeoptional | string | An optional three-character code for the wire channel. The field can only have one value and is not case sensitive. |
getWireInquiryResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
responseHeaderrequired | Object | responseHeader |
WireInquiryResultoptional | array | getWireInquiryResult |
errorResponseoptional | Object | errorResponse |
responseHeader
NAME | TYPE | DESCRIPTION |
---|---|---|
statusrequired | string | Indicates whether the result was successfully retrieved. |
statusDescriptionrequired | string | Description of the status |
retreivedRowsoptional | string | Total number of transactions retrieved |
totalRowsoptional | string | Total number of transactions matching the requested criteria |
serviceErrorData
NAME | TYPE | DESCRIPTION |
---|---|---|
getWireInquiryResponseoptional | Object | getWireInquiryResponse |
systemFault
NAME | TYPE | DESCRIPTION |
---|---|---|
errorCodeoptional | string | System error code |
errorDescriptionoptional | string | A human-readable message that describes the type or source of the system error. |
transactionDetailsRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
getWireInquiryRequestrequired | Object | getWireInquiryRequest |
transactionDetailsResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
getWireInquiryResponserequired | Object | getWireInquiryResponse |
getWireInquiryResult
NAME | TYPE | DESCRIPTION |
---|---|---|
amountoptional | string | Transaction amount |
debitCurrencyCodeoptional | string | Debit currency code |
transactionTypeoptional | string | Indicates the type of transaction. Valid values: INBOUND FED PAYMENT, OUTBOUND SWIFT PAYMENT, OUTBOUND FED PAYMENT, INBOUND SWIFT PAYMENT, INTERNAL, OTHER |
debitAccountNumberoptional | string | Debit account number |
creditAccountNumberoptional | string | Credit account number |
wireEventNameoptional | string | Internal status of the intermediary stages a transaction goes through before being processed. Valid values: CancelledPayments, CompletedPayment, DrawndownPay, PaymentWaitForOFCResponse, RepairedPayments, ReturnedFEDPayment, Swift101 |
clearingBankNumberoptional | string | Bank number of the clearing bank. |
creditAccountBankBranchoptional | string | Bank branch holding the credit account. |
creditAccountCurrencyCodeoptional | string | Transaction currency code of the credit account. |
creditAccountCustomerNumberoptional | string | Customer number associated with the credit account. |
creditAccountCustomerNameoptional | string | Customer name associated with the credit account. |
creditAccountCountryoptional | string | Country of the credit account. |
creditAccountCustomerTypeoptional | string | Customer type associated with the credit account. |
debitAccountTypeoptional | string | Debit account type. Valid values: DDA, GL |
debitAccountBankNumberoptional | string | Bank number holding the debit account. |
debitAccountBankBranchoptional | string | Bank branch holding the debit account. |
debitAccountCurrencyCodeoptional | string | Transaction currency code associated with the debit account. |
debitAccountCustomerNumberoptional | string | Customer number associated with the debit account. |
debitAccountCustomerNameoptional | string | Customer name associated with the debit account. |
cancelCommentoptional | string | Message provided by the operator who canceled a transaction. |
wireTransactionDirectionoptional | string | Indicates the direction of the transaction. Valid values: UNKNOWN, INBOUND, OUTBOUND, BOOK |
transactionValueIdentifieroptional | string | Indicates the value of the transaction. Valid values: HVC, HVB, LVC |
paymentClearingStateoptional | string | Payment clearing status of the wire transaction. Valid values: Cancelled, Complete, Cutoff Error, Pending Release, Ready to Send, Rejected, Returned, null |
creditTransactionCurrencyoptional | string | Currency of the amount credited. |
settlementPaymentTypeoptional | string | The mechanism or method by which settlement occurs. Valid values: FRB, CRD, BKP, NOS, FRD. |
incomingReferenceNumberoptional | string | The incoming reference number, which is provided by the sending bank. |
executionDateoptional | string | Date (YYYY-MM-DD) and time (HH:MM:SS) the transaction is executed. |
paymentEventTypeoptional | string | Payment type of PEN message. Valid Values: BKP, RTPCT |
transactionTypeCodeoptional | string | Type of wire transaction code. Valid values: FRB, PRE, FTR |
sendingBankReferenceNumberoptional | string | Reference number issued by the sending bank. |
bankToBankMemooptional | string | Free-form text transmitted between the banks. |
initiatingPartyNameoptional | string | Initiating party name |
initiatingPartyAccountNumberoptional | string | Initiating party account number |
initiatingPartyPostalAddressLine1optional | string | Initiating party address line 1 |
initiatingPartyPostalAddressLine2optional | string | Initiating party address line 2 |
initiatingParty2Nameoptional | string | Initiating party 2 name |
initiatingParty2AccountNumberoptional | string | Initiating party 2 account number |
initiatingParty2PostalAddressLine1optional | string | Initiating party 2 address line 1 |
initiatingParty2PostalAddressLine2optional | string | Initiating party 2 address line 2 |
transactionDetailDocumentoptional | string | Detail document or related reference |
traceIDoptional | string | Source transaction identifier |
keybankTransactionReferenceoptional | string | Unique wire transaction identifier created by KeyBank. |
transmittedDateoptional | string | Transaction settled date |
federalClearingReferenceNumberoptional | string | Federal reference number |
exchangeRateoptional | string | Exchange rate |
enteredDateoptional | string | Entered date |
creditorAgentBankNameoptional | string | Creditor agent bank name |
creditorAgentBankABAoptional | string | Creditor agent bank ABA |
creditorAgentBICoptional | string | Creditor agent BIC (business identifier code) |
creditorAgentBankPostalAddressLine1optional | string | Creditor agent bank postal address line 1 |
creditorAgentBankPostalAddressLine2optional | string | Creditor agent bank postal address line 2 |
beneficiaryNameoptional | string | Beneficiary name |
beneficiaryAccountNumberoptional | string | Beneficiary account number |
beneficiaryCreditorPostalAddressLine1optional | string | Beneficiary postal address line 1 |
beneficiaryCreditorPostalAddressLine2optional | string | Beneficiary postal address line 2 |
sourceChanneloptional | string | Denotes the channel that created the wire transaction. KTT is used for RTP transaction and FRB is used for Federal Reserve transactions. |
paymentStatusoptional | string | Indicates the status of payment. Valid values: Active, Returned, Cancelled, Success, PendingUserAction |
transactionBusinessStatusCodeoptional | string | Transaction business status code. Valid values: Completed, Pricing, Cancelled, Future Warehouse, PaymentNotification, Held Requiring Cover, Awaiting Approval, Internal Filter, Advising, Funds Release, Product Selection, Regulatory Filter, Clearing, Limit Check, Pre-Qualifying, Abandoned, Repair |
paySubTypeoptional | string | A four-digit code that identifies the type of the wire transaction and if it is a drawdown request (1031), drawdown funds (1032) or drawdown refusal (1033). Valid values: 1031, 1032, 1033 |
sourceSubTypeoptional | string | Three-character code that defines the source of the paySubType. |
correlationIdoptional | string | A unique identifier generated for each transaction that remains with the transaction through the chain of API operations. |
channelCodeoptional | string | An optional three-character code for the wire channel. The field can only have one value and is not case sensitive. |
channelModeoptional | string | The mode of the wire transfer. |
relatedReferenceIdoptional | string | Reference identification for the wire transaction. |
creditVirtualAccountoptional | string | The VAM credit account number. VAM account numbers are 15 digits and start with 953. |
debitVirtualAccountoptional | string | The VAM debit account number. VAM account numbers are 15 digits and start with 953. |
transactionCreateDateoptional | string | The date and time the transaction was created. Format: YYYY-MM-DDTHH:MM:SS.SSS-Z |
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. |
initiatingFailureReasonCodeoptional | string | Code indicates the reason the transaction payment was not successful. |
initiatingFailureReasonTitleoptional | string | Brief title about the payment error associated with the code. |
initiatingFailureReasonDescoptional | string | Details about the reason the transaction payment was not successful. |
networkFailureReasonCodeoptional | string | Code indicates the network reason that faulted the transaction payment. |
networkFailureReasonTitleoptional | string | Brief title about the network error associated with the code. |
networkFailureReasonDescoptional | string | Details about the reason for a network failure. |
remittanceInfooptional | string | Information that stays with a payment as it is transferred from one party to another. This field only displays if there is remittance information for the transaction. |
requestReferenceoptional | string | A reference value from the originating request that is useful for traceability and reporting. |
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 |
---|---|---|
200 | S | ECA-W-001 Transaction not found.
The request was received, but there is no result for the requested criteria. |
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