Wire Inquiry

clock 2-minute read calender 1.2.1 | updated May. 29, 2024

Look up the status and details about a wire transaction

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.


get /wireInquiry/v1/healthCheck

Verify you can connect to the API service. A bearer token is required.

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)

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

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.

BODY FIELDTYPEDESCRIPTION
getWireInquiryRequestrequiredObjectgetWireInquiryRequest

Request example

copylink
{
    "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"
    }
}
NAMETYPEDESCRIPTION
getWireInquiryResponserequiredObjectgetWireInquiryResponse

Response example (200)

copylink
{
    "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"
            }
        ]
    }
}
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

Response example (400)

copylink
{
    "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"
}
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

Response example (401)

copylink
{
    "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"
}
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

Response example (403)

copylink
{
    "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"
}
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

Response example (404)

copylink
{
    "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"
}
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

Response example (405)

copylink
{
    "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"
}
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

Response example (415)

copylink
{
    "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"
}
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

Response example (429)

copylink
{
    "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"
}
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

Response example (500)

copylink
{
    "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"
}
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

Response example (502)

copylink
{
    "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"
    }
}
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

Response example (503)

copylink
{
    "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."
    }
}
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

Response example (504)

copylink
{
    "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."
    }
}
NAMETYPEDESCRIPTION
errorCodeoptionalstringBusiness error code
errorDescriptionoptionalstringA human-readable message that describes the type or source of the business error.
NAMETYPEDESCRIPTION
ConnectErroroptionalstringAPI connectivity error information, if available.
NAMETYPEDESCRIPTION
businessFaultoptionalarraybusinessFault
systemFaultoptionalarraysystemFault
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
StatusoptionalstringStatus of the health check response.
SourceoptionalstringOrigin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
TimestampoptionalstringDate (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIpoptionalstringClient IP address the gateway receives from the request.
X-Forwarded-ForoptionalstringSequence of IP addresses for systems between the client and the gateway.
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed 16 characters.
transactionTypeoptionalarrayIndicates the type of transaction. Valid values: INBOUND FED PAYMENT, OUTBOUND SWIFT PAYMENT, OUTBOUND FED PAYMENT, INBOUND SWIFT PAYMENT, INTERNAL, OTHER
paymentStatusoptionalarrayIndicates the status of payment. Valid values: Active, Returned, Cancelled, Success, PendingUserAction
fromDaterequiredstringThe 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
toDaterequiredstringThe 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
fromTransmitDateoptionalstringThe 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
toTransmitDateoptionalstringThe 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
fromAmountoptionalstringTransaction amount lower limit value to be searched.
toAmountoptionalstringTransaction amount upper limit value to be searched.
traceIDoptionalstringSource transaction identifier for a specific transaction.
keyBankTransactionReferenceoptionalstringUnique wire transaction identifier created by KeyBank.
sourceChanneloptionalarrayDenotes the channel that created the wire transaction. KTT INITIATED is used for RTP transaction and FRB INITIATED is used for Federal Reserve transactions.
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.
channelCodeoptionalstringAn optional three-character code for the wire channel. The field can only have one value and is not case sensitive.
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
WireInquiryResultoptionalarraygetWireInquiryResult
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successfully retrieved.
statusDescriptionrequiredstringDescription of the status
retreivedRowsoptionalstringTotal number of transactions retrieved
totalRowsoptionalstringTotal number of transactions matching the requested criteria
NAMETYPEDESCRIPTION
getWireInquiryResponseoptionalObjectgetWireInquiryResponse
NAMETYPEDESCRIPTION
errorCodeoptionalstringSystem error code
errorDescriptionoptionalstringA human-readable message that describes the type or source of the system error.
NAMETYPEDESCRIPTION
getWireInquiryRequestrequiredObjectgetWireInquiryRequest
NAMETYPEDESCRIPTION
getWireInquiryResponserequiredObjectgetWireInquiryResponse
NAMETYPEDESCRIPTION
amountoptionalstringTransaction amount
debitCurrencyCodeoptionalstringDebit currency code
transactionTypeoptionalstringIndicates the type of transaction. Valid values: INBOUND FED PAYMENT, OUTBOUND SWIFT PAYMENT, OUTBOUND FED PAYMENT, INBOUND SWIFT PAYMENT, INTERNAL, OTHER
debitAccountNumberoptionalstringDebit account number
creditAccountNumberoptionalstringCredit account number
wireEventNameoptionalstringInternal status of the intermediary stages a transaction goes through before being processed. Valid values: CancelledPayments, CompletedPayment, DrawndownPay, PaymentWaitForOFCResponse, RepairedPayments, ReturnedFEDPayment, Swift101
clearingBankNumberoptionalstringBank number of the clearing bank.
creditAccountBankBranchoptionalstringBank branch holding the credit account.
creditAccountCurrencyCodeoptionalstringTransaction currency code of the credit account.
creditAccountCustomerNumberoptionalstringCustomer number associated with the credit account.
creditAccountCustomerNameoptionalstringCustomer name associated with the credit account.
creditAccountCountryoptionalstringCountry of the credit account.
creditAccountCustomerTypeoptionalstringCustomer type associated with the credit account.
debitAccountTypeoptionalstringDebit account type. Valid values: DDA, GL
debitAccountBankNumberoptionalstringBank number holding the debit account.
debitAccountBankBranchoptionalstringBank branch holding the debit account.
debitAccountCurrencyCodeoptionalstringTransaction currency code associated with the debit account.
debitAccountCustomerNumberoptionalstringCustomer number associated with the debit account.
debitAccountCustomerNameoptionalstringCustomer name associated with the debit account.
cancelCommentoptionalstringMessage provided by the operator who canceled a transaction.
wireTransactionDirectionoptionalstringIndicates the direction of the transaction. Valid values: UNKNOWN, INBOUND, OUTBOUND, BOOK
transactionValueIdentifieroptionalstringIndicates the value of the transaction. Valid values: HVC, HVB, LVC
paymentClearingStateoptionalstringPayment clearing status of the wire transaction. Valid values: Cancelled, Complete, Cutoff Error, Pending Release, Ready to Send, Rejected, Returned, null
creditTransactionCurrencyoptionalstringCurrency of the amount credited.
settlementPaymentTypeoptionalstringThe mechanism or method by which settlement occurs. Valid values: FRB, CRD, BKP, NOS, FRD.
incomingReferenceNumberoptionalstringThe incoming reference number, which is provided by the sending bank.
executionDateoptionalstringDate (YYYY-MM-DD) and time (HH:MM:SS) the transaction is executed.
paymentEventTypeoptionalstringPayment type of PEN message. Valid Values: BKP, RTPCT
transactionTypeCodeoptionalstringType of wire transaction code. Valid values: FRB, PRE, FTR
sendingBankReferenceNumberoptionalstringReference number issued by the sending bank.
bankToBankMemooptionalstringFree-form text transmitted between the banks.
initiatingPartyNameoptionalstringInitiating party name
initiatingPartyAccountNumberoptionalstringInitiating party account number
initiatingPartyPostalAddressLine1optionalstringInitiating party address line 1
initiatingPartyPostalAddressLine2optionalstringInitiating party address line 2
initiatingParty2NameoptionalstringInitiating party 2 name
initiatingParty2AccountNumberoptionalstringInitiating party 2 account number
initiatingParty2PostalAddressLine1optionalstringInitiating party 2 address line 1
initiatingParty2PostalAddressLine2optionalstringInitiating party 2 address line 2
transactionDetailDocumentoptionalstringDetail document or related reference
traceIDoptionalstringSource transaction identifier
keybankTransactionReferenceoptionalstringUnique wire transaction identifier created by KeyBank.
transmittedDateoptionalstringTransaction settled date
federalClearingReferenceNumberoptionalstringFederal reference number
exchangeRateoptionalstringExchange rate
enteredDateoptionalstringEntered date
creditorAgentBankNameoptionalstringCreditor agent bank name
creditorAgentBankABAoptionalstringCreditor agent bank ABA
creditorAgentBICoptionalstringCreditor agent BIC (business identifier code)
creditorAgentBankPostalAddressLine1optionalstringCreditor agent bank postal address line 1
creditorAgentBankPostalAddressLine2optionalstringCreditor agent bank postal address line 2
beneficiaryNameoptionalstringBeneficiary name
beneficiaryAccountNumberoptionalstringBeneficiary account number
beneficiaryCreditorPostalAddressLine1optionalstringBeneficiary postal address line 1
beneficiaryCreditorPostalAddressLine2optionalstringBeneficiary postal address line 2
sourceChanneloptionalstringDenotes the channel that created the wire transaction. KTT is used for RTP transaction and FRB is used for Federal Reserve transactions.
paymentStatusoptionalstringIndicates the status of payment. Valid values: Active, Returned, Cancelled, Success, PendingUserAction
transactionBusinessStatusCodeoptionalstringTransaction 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
paySubTypeoptionalstringA 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
sourceSubTypeoptionalstringThree-character code that defines the source of the paySubType.
correlationIdoptionalstringA unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
channelCodeoptionalstringAn optional three-character code for the wire channel. The field can only have one value and is not case sensitive.
channelModeoptionalstringThe mode of the wire transfer.
relatedReferenceIdoptionalstringReference identification for the wire transaction.
creditVirtualAccountoptionalstringThe VAM credit account number. VAM account numbers are 15 digits and start with 953.
debitVirtualAccountoptionalstringThe VAM debit account number. VAM account numbers are 15 digits and start with 953.
transactionCreateDateoptionalstringThe date and time the transaction was created. Format: YYYY-MM-DDTHH:MM:SS.SSS-Z
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.
initiatingFailureReasonCodeoptionalstringCode indicates the reason the transaction payment was not successful.
initiatingFailureReasonTitleoptionalstringBrief title about the payment error associated with the code.
initiatingFailureReasonDescoptionalstringDetails about the reason the transaction payment was not successful.
networkFailureReasonCodeoptionalstringCode indicates the network reason that faulted the transaction payment.
networkFailureReasonTitleoptionalstringBrief title about the network error associated with the code.
networkFailureReasonDescoptionalstringDetails about the reason for a network failure.
remittanceInfooptionalstringInformation 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.
requestReferenceoptionalstringA reference value from the originating request that is useful for traceability and reporting.

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
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 download