Wire Inquiry

Look up the status and details about a wire transaction

Wire Inquiry endpoints

What can you do	Endpoint
Health check	get /wireInquiry/v1/transactions/healthCheck
Get a list of wire transfers	post /wireInquiry/v1/transactions/list
View the details of a wire transfer by the transaction ID	get /wireInquiry/v1/transactions/detail/{transactionId}
Retrieve wire details by account number and date	post /wireInquiry/v1/transactions/details

Key notes

Before you begin

All KeyBank APIs require certificates, user credentials, and certain permissions. Details about what is required to become an API partner with KeyBank are in the Getting Started Guide to learn more.

Requirements

Before using any endpoint, make sure you understand the required parameters and conditions for a valid request.

Account number

When retrieving a list of wire transactions, you need a valid (16-character) accountNumber. This account number pulls all related transactions within the specified date range of the request.

Date range

Use the fromDate and toDate in the request to specify the date range for settled transactions for the account number provided.

The start date (fromDate) must be within 100 days of the current day. This date has to occur before the end date (toDate). The end date cannot be a future date. Date formats are in YYYY-MM-DD.

Transaction ID

If you are looking for details about a specific transaction, you must specify the transactionId in the detail request. The transactionId is the unique ID number associated with the original payment request. The maximum amount of characters for a transactionId is 100, but typically they are around 16 characters in length.

How do I get the transaction ID?

The transactionId is returned in the response for the List API. Use this ID returned in your detail request to return additional information about a wire transaction.

Get a list of wire transfers

post /wireInquiry/v1/transactions/list

Based on search criteria provided, get a list of wire transfers. The account number and date range are required for every request.

Request

NAME	TYPE	DESCRIPTION
accountNumberrequired	string	The bank account number. This field cannot exceed 16 characters.
fromDaterequired	string	Start date for the date range. This date can be the current day or within 100 days prior to the current date. To search for a single date, this value will be the same as the toDate. Format: YYYY-MM-DD
toDaterequired	string	End date for the date range. This date must be the same or later than the start date (fromDate). To search for a single date, this value will be the same as the fromDate. To search for a range of dates, make sure the date range does not exceed 31 days. Format: YYYY-MM-DD
minimumAmount	string	The minimum dollar amount of the transaction. This amount must be less than or equal to the maximum amount. Leave blank or enter zero for no minimum amount.
maximumAmount	string	The maximum dollar amount of the transaction. This amount must be greater than or equal to the minimum amount. Leave blank to retrieve all amounts. This amount cannot exceed one billion dollars.
requestReference	string	A reference value for the original request that is useful for traceability and reporting. The ID cannot exceed 35 characters.
pageNumber	string	The number of the page being viewed. This number must be greater than or equal to 1.
pageSize	string	The total number of pages returned. This number must be greater than or equal to 1 and cannot exceed 1000.

Request example

{
  "accountNumber": "3123456789",
  "fromDate": "2024-02-01",
  "toDate": "2024-02-01",
  "minimumAmount": "100.00",
  "maximumAmount": "75020.5",
  "requestReference": "USt41001030ii016002",
  "pageNumber": "1",
  "pageSize": "500"
}

Responses

Search results match the criteria

NAME	TYPE	DESCRIPTION
transactions	array	WireListTransaction
metadata	object	Metadata

Response example (200)

{
  "transactions": [
    {
      "transactionId": "US99999000999999",
      "transactionStatus": "COMPLETED",
      "transactionDate": "2024-02-01",
      "transactionAmount": 32772.63,
      "requestReference": "1122334455",
      "sendersReference": "US99999000999999",
      "creditor": {
        "name": "Global Markets LLC"
      },
      "creditorAccount": {
        "accountNumber": "987654321",
        "virtualAccountNumber": "98765432100015"
      },
      "debtor": {
        "name": "Paul Wilson"
      },
      "debtorAccount": {
        "accountNumber": "123456789",
        "virtualAccountNumber": "98765432100000"
      },
      "beneficiary": {
        "name": "MARKET CAPITAL"
      },
      "beneficiaryAccount": {
        "accountNumber": "102030405060"
      },
      "metadata": {
        "page": {
          "pageNumber": 1,
          "pageSize": 25,
          "totalPages": 3,
          "totalRecords": 75,
          "lastPage": true
        }
      }
    }
  ]
}

Bad input parameter

NAME	TYPE	DESCRIPTION
metadata	object	Metadata

Response example (400)

{
    "metadata": {
        "messages": [
            {
                "code": "Wire-List-400-bad-input",
                "message": "Bad input parameter"
            }
        ]
    }
}

Get wire details with a transaction ID

get /wireInquiry/v1/transactions/detail/{transactionId}

Provide the transaction ID to retrieve all available fields for that wire transfer.

Request

path FIELD	TYPE	DESCRIPTION
transactionIdrequired	string	The unique ID number associated with the original payment request.

Responses

A Wire transaction matches the provided transactionId

NAME	TYPE	DESCRIPTION
transactionId	string	The unique ID number associated with the original payment request.
transactionDate	string	Date the transfer occurred. Format: YYYY-MM-DD
transactionAmount	number	The dollar amount of the transaction.
requestReference	string	A reference value for the original request that is useful for traceability and reporting. The ID cannot exceed 35 characters.
sendersReference	string	A reference value provided by the sender. For outbound payments, this value is the same as the transaction ID. The ID cannot exceed 35 characters.
creditor	Object	PartyList
creditorAccount	Object	AccountList
debtor	Object	PartyList
debtorAccount	Object	AccountList
originator	Object	PartyList
originatorAccount	Object	AccountList
beneficiary	Object	PartyList
beneficiaryAccount	Object	AccountList
ultimateCreditor	Object	PartyList
ultimateCreditorAccount	Object	AccountList
ultimateDebtor	Object	PartyList
ultimateDebtorAccount	Object	AccountList
remittanceInformation	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. Message length cannot exceed 256 characters.
bankToBankInstructions	string	Messages or instructions shared from one bank to another. Data retrieved if part of the original wire transfer.

Response example (200)

{
    "transactionId": "US99999000999999",
    "transactionStatus": "COMPLETED",
    "transactionDate": "2024-02-01",
    "transactionAmount": 32772.63,
    "requestReference": "1122334455",
    "sendersReference": "US99999000999999",
    "creditor": {
        "name": "Global Markets LLC"
    },
    "creditorAccount": {
        "accountNumber": "987654321"
    },
    "debtor": {
        "name": "Paul Wilson"
    },
    "debtorAccount": {
        "accountNumber": "123456789"
    },
    "remittanceInformation": "Payment 02\/01\/2024_Invoice - 123456789 Cust"
}

No Wire transaction was found with the provided transactionId

NAME	TYPE	DESCRIPTION
metadata	object	Metadata

Response example (404)

{
    "metadata": {
        "messages": [
            {
                "code": "Wire-Detail-404-no-records",
                "message": "Record Not Found"
                "X-Forwarded-For": "[156.77.111.28]"
           }
        ]
    }
}

Get wire details by account and date

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

NAME	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": "SERVICES AND ADMIN FEE"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details"
}

Request is forbidden to access the resource

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details"
}

Requested method denied

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details"
}

Media type not supported

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details"
}

Too many requests

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details"
}

Internal server error

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	oneOf	serviceErrorData connectError

Response example (502)

{
    "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",
    "Api-Url": "/wireInquiry/v1/transactions/details",
    "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
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Gateway timeout

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	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",
    "Api-Url": "/wireInquiry/v1/transactions/details",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Schemas

WireDetailTransaction

NAME	TYPE	DESCRIPTION
transactionId	string	The unique ID number associated with the original payment request.
transactionDate	string	Date the transfer occurred. Format: YYYY-MM-DD
transactionAmount	number	The dollar amount of the transaction.
requestReference	string	A reference value for the original request that is useful for traceability and reporting. The ID cannot exceed 35 characters.
sendersReference	string	A reference value provided by the sender. For outbound payments, this value is the same as the transaction ID. The ID cannot exceed 35 characters.
creditor	Object	PartyList
creditorAccount	Object	AccountList
debtor	Object	PartyList
debtorAccount	Object	AccountList
originator	Object	PartyList
originatorAccount	Object	AccountList
beneficiary	Object	PartyList
beneficiaryAccount	Object	AccountList
ultimateCreditor	Object	PartyList
ultimateCreditorAccount	Object	AccountList
ultimateDebtor	Object	PartyList
ultimateDebtorAccount	Object	AccountList
remittanceInformation	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. Message length cannot exceed 256 characters.
bankToBankInstructions	string	Messages or instructions shared from one bank to another. Data retrieved if part of the original wire transfer.

WireListTransaction

NAME	TYPE	DESCRIPTION
transactionId	string	The unique ID number associated with the original payment request
transactionDate	string	Date the transfer occurred. Format: YYYY-MM-DD
transactionAmount	number	The dollar amount of the transaction.
requestReference	string	A reference value for the original request that is useful for traceability and reporting. The ID cannot exceed 35 characters.
sendersReference	string	A reference value provided by the sender. For outbound payments, this value is the same as the transaction ID. The ID cannot exceed 35 characters.
creditor	Object	PartyList
creditorAccount	Object	AccountList
debtor	Object	PartyList
debtorAccount	Object	AccountList

healthResponse

NAME	TYPE	DESCRIPTION
Status	string	Status of the health check response.
Source	string	The origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
Timestamp	string	The date (YYYY-MM-DD) and time (HH:MM:SS) of the response from the API service.
ClientIp	string	The client IP address the gateway gets from the request.
X-Forwarded-For	string	The sequence of all the IP addresses for systems involved between the client and the gateway.

AccountList

NAME	TYPE	DESCRIPTION
accountNumber	string	Account number of the party.
virtualAccountNumber	string	Account number for the virtual account (VAM).

PartyList

NAME	TYPE	DESCRIPTION
name	string	Contains the customer identification number and the company name.

Message

NAME	TYPE	DESCRIPTION
code	string	Static code assigned by the network or payment system.
message	string	A human-readable message associated with the code.

Page

NAME	TYPE	DESCRIPTION
pageNumber	integer	The number of the page being viewed.
pageSize	integer	The number of records per page.
totalPages	integer	The total number of pages available.
totalRecords	integer	The total number of the transactions (records) available in the result set.
lastPage	boolean	Indicates the last page of the total pages.

Metadata

NAME	TYPE	DESCRIPTION
messagesoptional	array	Message
page	Object	Page

exception

NAME	TYPE	DESCRIPTION
ErrorMessage	string	A human-readable message that describes the type or source of the error.
TransactionId	string	A unique transaction ID returned with the response, useful for traceability.
TransactionTime	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the error occurred.
Api-Url	string	The API URL path of the call that generated the response.
ServiceError	oneOf	serviceErrorData connectError

serviceErrorData

NAME	TYPE	DESCRIPTION
getWireInquiryResponse	Object	getWireInquiryResponse

connectError

NAME	TYPE	DESCRIPTION
ConnectError	string	API connectivity error information, if available.

getWireInquiryResponse

NAME	TYPE	DESCRIPTION
responseHeaderrequired	Object	responseHeader
WireInquiryResultoptional	array	getWireInquiryResult
errorResponse	Object	errorResponse

getWireInquiryResult

NAME	TYPE	DESCRIPTION
amount	string	Transaction amount
debitCurrencyCode	string	Debit currency code
transactionType	string	Indicates the type of transaction. Valid values: INBOUND FED PAYMENT, OUTBOUND SWIFT PAYMENT, OUTBOUND FED PAYMENT, INBOUND SWIFT PAYMENT, INTERNAL, OTHER
debitAccountNumber	string	Debit account number
creditAccountNumber	string	Credit account number
wireEventName	string	Internal status of the intermediary stages a transaction goes through before being processed. Valid values: CancelledPayments, CompletedPayment, DrawndownPay, PaymentWaitForOFCResponse, RepairedPayments, ReturnedFEDPayment, Swift101
clearingBankNumber	string	Bank number of the clearing bank.
creditAccountBankBranch	string	Bank branch holding the credit account.
creditAccountCurrencyCode	string	Transaction currency code of the credit account.
creditAccountCustomerNumber	string	Customer number associated with the credit account.
creditAccountCustomerName	string	Customer name associated with the credit account.
creditAccountCountry	string	Country of the credit account.
creditAccountCustomerType	string	Customer type associated with the credit account.
debitAccountType	string	Debit account type. Valid values: DDA, GL
debitAccountBankNumber	string	Bank number holding the debit account.
debitAccountBankBranch	string	Bank branch holding the debit account.
debitAccountCurrencyCode	string	Transaction currency code associated with the debit account.
debitAccountCustomerNumber	string	Customer number associated with the debit account.
debitAccountCustomerName	string	Customer name associated with the debit account.
cancelComment	string	Message provided by the operator who canceled a transaction.
wireTransactionDirection	string	Indicates the direction of the transaction. Valid values: UNKNOWN, INBOUND, OUTBOUND, BOOK
transactionValueIdentifier	string	Indicates the value of the transaction. Valid values: HVC, HVB, LVC
paymentClearingState	string	Payment clearing status of the wire transaction. Valid values: Cancelled, Complete, Cutoff Error, Pending Release, Ready to Send, Rejected, Returned, null
creditTransactionCurrency	string	Currency of the amount credited.
settlementPaymentType	string	The mechanism or method by which settlement occurs. Valid values: FRB, CRD, BKP, NOS, FRD.
incomingReferenceNumber	string	The incoming reference number, which is provided by the sending bank.
executionDate	string	Date (YYYY-MM-DD) and time (HH:MM:SS) the transaction is executed.
paymentEventType	string	Payment type of PEN message. Valid Values: BKP, RTPCT
transactionTypeCode	string	Type of wire transaction code. Valid values: FRB, PRE, FTR
sendingBankReferenceNumber	string	Reference number issued by the sending bank.
bankToBankMemo	string	Free-form text transmitted between the banks.
initiatingPartyName	string	Initiating party name
initiatingPartyAccountNumber	string	Initiating party account number
initiatingPartyPostalAddressLine1	string	Initiating party address line 1
initiatingPartyPostalAddressLine2	string	Initiating party address line 2
initiatingParty2Name	string	Initiating party 2 name
initiatingParty2AccountNumber	string	Initiating party 2 account number
initiatingParty2PostalAddressLine1	string	Initiating party 2 address line 1
initiatingParty2PostalAddressLine2	string	Initiating party 2 address line 2
transactionDetailDocument	string	Detail document or related reference
traceID	string	Source transaction identifier
keybankTransactionReference	string	Unique wire transaction identifier created by KeyBank.
transmittedDate	string	Transaction settled date
federalClearingReferenceNumber	string	Federal reference number
exchangeRate	string	Exchange rate
enteredDate	string	Entered date
creditorAgentBankName	string	Creditor agent bank name
creditorAgentBankABA	string	Creditor agent bank ABA
creditorAgentBIC	string	Creditor agent BIC (business identifier code)
creditorAgentBankPostalAddressLine1	string	Creditor agent bank postal address line 1
creditorAgentBankPostalAddressLine2	string	Creditor agent bank postal address line 2
beneficiaryName	string	Beneficiary name
beneficiaryAccountNumber	string	Beneficiary account number
beneficiaryCreditorPostalAddressLine1	string	Beneficiary postal address line 1
beneficiaryCreditorPostalAddressLine2	string	Beneficiary postal address line 2
sourceChannel	string	Denotes the channel that created the wire transaction. KTT is used for RTP transaction and FRB is used for Federal Reserve transactions.
paymentStatus	string	Indicates the status of payment. Valid values: Active, Returned, Cancelled, Success, PendingUserAction
transactionBusinessStatusCode	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
paySubType	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
sourceSubType	string	Three-character code that defines the source of the paySubType.
correlationId	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
channelCode	string	An optional three-character code for the wire channel. The field can only have one value and is not case sensitive.
channelMode	string	The mode of the wire transfer.
relatedReferenceId	string	Reference identification for the wire transaction.
creditVirtualAccount	string	The VAM credit account number. VAM account numbers are 15 digits and start with 953.
debitVirtualAccount	string	The VAM debit account number. VAM account numbers are 15 digits and start with 953.
transactionCreateDate	string	The date and time the transaction was created. Format: YYYY-MM-DDTHH:MM:SS.SSS-Z
customData	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.
initiatingFailureReasonCode	string	Code indicates the reason the transaction payment was not successful.
initiatingFailureReasonTitle	string	Brief title about the payment error associated with the code.
initiatingFailureReasonDesc	string	Details about the reason the transaction payment was not successful.
networkFailureReasonCode	string	Code indicates the network reason that faulted the transaction payment.
networkFailureReasonTitle	string	Brief title about the network error associated with the code.
networkFailureReasonDesc	string	Details about the reason for a network failure.
remittanceInformation	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. Message length cannot exceed 256 characters.
requestReference	string	A reference value from the originating request that is useful for traceability and reporting.

transactionDetailsResponse

NAME	TYPE	DESCRIPTION
getWireInquiryResponserequired	Object	getWireInquiryResponse

businessFault

NAME	TYPE	DESCRIPTION
errorCode	string	Business error code
errorDescription	string	A human-readable message that describes the type or source of the business error.

transactionDetailsRequest

NAME	TYPE	DESCRIPTION
getWireInquiryRequestrequired	Object	getWireInquiryRequest

systemFault

NAME	TYPE	DESCRIPTION
errorCode	string	System error code
errorDescription	string	A human-readable message that describes the type or source of the system error.

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
fromTransmitDate	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
toTransmitDate	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
fromAmount	string	Transaction amount lower limit value to be searched.
toAmount	string	Transaction amount upper limit value to be searched.
traceID	string	Source transaction identifier for a specific transaction.
keyBankTransactionReference	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.
startRowIndex	string	Pagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndex	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.
channelCode	string	An optional three-character code for the wire channel. The field can only have one value and is not case sensitive.

responseHeader

NAME	TYPE	DESCRIPTION
statusrequired	string	Indicates whether the result was successfully retrieved.
statusDescriptionrequired	string	Description of the status
retreivedRows	string	Total number of transactions retrieved
totalRows	string	Total number of transactions matching the requested criteria

errorResponse

NAME	TYPE	DESCRIPTION
businessFaultoptional	array	businessFault
systemFaultoptional	array	systemFault

Errors

For more information about general errors, see Error handling.

Changelog

Release	API version	Change description	Impact
September 2025	1.3.2	Added `Api-Url` to error responses for the endpoint - /wireInquiry/v1/transactions/details. This field shows which URL path triggered the response.	> LOW
June 2025	1.3.1	Added a new field, `bankToBankInstructions`, to the `WireDetailTransaction` object. With detail inquiry requests, if there is a message between banks, it is now returned as part of the response. Clarified and corrected the descriptions for `transactionStatus` and `remittanceInformation`.	LOW
April 2025	1.3.0	To inquire about a wire transfer, use the two new endpoints to search for a list or by transaction ID. Added the following endpoints: `Added wireInquiry/v1/transactions/list` `Added /wireInquiry/v1/transactions/detail/{transactionId}.` Endpoint `/wireInquiry/v1/transactions/details` and related schemas hidden from Developer Portal. This is still live in Production; however, we encourage you to migrate to the new and more dynamic inquiry paths.	HIGH
May 2024	1.2.1	Added the `requestReference` parameter. In the request, enter a short note, keyword, or descriptor that you can use in the future to trace or verify the transaction. The `requestReference` value returns in the `WireInquiryResult` object. Add `remittanceInfo` to the `WireInquiryResult` response body. You can enter a line of concatenated values that detail the purpose of wire or a message to the recipients. Added beneficiary party information to the `WireInquiryResult` response body. Parameters added include: `beneficiaryName`, `beneficiaryAccountNumber`, `beneficiaryCreditorPostalAddressLine1`, `beneficiaryCreditorPostalAddressLine2`. `X-CorrelationId` has been removed as a request header field for all endpoints. The parameter is no longer in the request body, but still remains in the code. The system assigns a unique ID when you submit a request and returns the value in the response.	MID
March 2024	1.1.5	Updated pattern format for the `channelCode` parameter. This field is no longer case sensitive. You can input a mix of uppercase and/or lowercase letters and still generate a successful return.	LOW
December 2023	1.1.4	Added `channelCode` (optional) parameter to `WireInquiryRequest` and `WireInquiryResult` objects. Add `transactionCreateDate` parameter to the `WireInquiryResult` object. Deprecated the `mdmId` field. Backend services and processes have been enhanced to authenticate client API calls without the need for an MDM ID.	HIGH
September 2023	1.1.3	The `mdmId` description has been updated to communicate that this field will soon deprecate in an upcoming release. Added VAM parameters `creditVirtualAccount` and `debitVirtualAccount` to the response object, `WireInquiryResult`. You can now reconcile funds based on virtual account numbers.	LOW
July 2023	1.1.1	Added the `customData` parameter. You can append up to 500 characters of free-form text that stays with the transaction through its lifecycle. Removed `properties`. The addition of the `customData` parameter rendered the `properties` object redundant. Added the `paySubType` parameter on a transaction type response. You can now receive status information about a Fed Drawdown request and if it was successful (1032) or not successful (1033). MDM ID (`mdmId`) is no longer a required parameter, it is now optional.	MID
May 2023	1.1.0	Changed parameter `fromEnteredDate` to `fromDate.` Changed `toEnteredDate` to `toDate`. Modified the format for the date parameters to match with KeyBank API standard date format of YYYY-MM-DD. The optional `source` parameter has been deprecated and removed.	MID
December 2022	1.0.0	Released on the Developer Portal.

Impact levels

LOW: This is a minor change or enhancement that does not alter the operations of the API. Upgrading to the latest specifications is preferable but not required.
MID: The previous API version is valid and operates, but does not contain latest enhancements. You need to update your specifications to get these enhancements.
HIGH: The previous API version is no longer operable. You must upgrade to the latest specifications to access and use this API product.

YAML file

Wire Inquiry endpoints

Key notes

Before you begin

Requirements

Account number

Date range

Transaction ID

How do I get the transaction ID?

Get a list of wire transfers

Request

Request example

Responses

Search results match the criteria

Response example (200)

Bad input parameter

Response example (400)

Get wire details with a transaction ID

Request

Responses

A Wire transaction matches the provided transactionId

Response example (200)

No Wire transaction was found with the provided transactionId

Response example (404)

Get wire details by account and date

Request

Request example

Responses

Successful response

Response example (200)

Missing mandatory information

Response example (400)

Unauthorized request

Response example (401)

Request is forbidden to access the resource

Response example (403)

Resource not found

Response example (404)

Requested method denied

Response example (405)

Media type not supported

Response example (415)

Too many requests

Response example (429)

Internal server error

Response example (500)

Bad gateway

Response example (502)

Service unavailable

Response example (503)

Gateway timeout

Response example (504)

Schemas

WireDetailTransaction

WireListTransaction

healthResponse

AccountList

PartyList

Message

Page

Metadata

exception

serviceErrorData

connectError

getWireInquiryResponse

getWireInquiryResult

transactionDetailsResponse

businessFault

transactionDetailsRequest

systemFault

getWireInquiryRequest

responseHeader

errorResponse

Errors

Changelog

Impact levels

We value your feedback