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}

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 180 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
minimumAmountoptional	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.
maximumAmountoptional	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.
pageNumberoptional	string	The number of the page being viewed. This number must be greater than or equal to 1.
pageSizeoptional	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
messagesoptional	array	Message
page	object	Page

Response example (400)

{
  "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
messagesoptional	array	Message
page	Object	Page

Response example (404)

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

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
transactionStatus	enum	The status of the wire transfer. Valid values: CANCELLED, COMPLETED, FAILED, IN PROCESS, IN REVIEW, RETURNED
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
transactionStatus	enum	The status of the wire transfer. Valid values: CANCELLED, COMPLETED, FAILED, IN PROCESS, IN REVIEW, RETURNED
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

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.

Errors

For more information about general errors, see Error handling or get help with a specific issue looking at Troubleshooting help.

Changelog

1.3.3

January 2026 | LOW impact

Deprecated /wireInquiry/v1/transactions/details and related schemas. This is still in Production as a legacy product.

1.3.2

September 2025 | LOW impact

Added Api-Url to error responses for the endpoint - /wireInquiry/v1/transactions/details. This field shows which URL path triggered the response.

1.3.1

June 2025 | LOW impact

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.

1.3.0

April 2025 | HIGH impact

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.

1.2.1

May 2024 | MID impact

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.

1.1.5

March 2024 | LOW impact

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.

1.1.4

December 2023 | HIGH impact

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.

1.1.3

September 2023 | LOW impact

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.

1.1.1

July 2023 | MID impact

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.

1.1.0

May 2023 | MID impact

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.

1.0.0

December 2022

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)

Schemas

WireDetailTransaction

WireListTransaction

healthResponse

AccountList

PartyList

Message

Page

Metadata

getWireInquiryRequest

Errors

Changelog

1.3.3

1.3.2

1.3.1

1.3.0

1.2.1

1.1.5

1.1.4

1.1.3

1.1.1

1.1.0

1.0.0

Impact levels

We value your feedback