Look up the status and details about a wire transaction What can you doEndpointHealth checkget /wireInquiry/v1/transactions/healthCheckSearch wire transferspost /wireInquiry/v1/transactions/listView transfer details with the transaction IDget /wireInquiry/v1/transactions/detail/{transactionId} Health check get /wireInquiry/v1/transactions/healthCheckRequestCheck the health of an API service and verify you can successfully connect. A bearer token is required.Request examplecurl "https://partner-api-qv.key.com/wireInquiry/v1/transactions/healthCheck" --header 'Bearer testZcKJDWnwDWmmf9qah6PJvPy8' Successful responseNAMETYPEDESCRIPTIONStatusoptionalstringStatus of the health check response.SourceoptionalstringSystem producing the health response. Genesis of the response could either be just from “gateway” or “roundtrip” from the farthest possible system involved in generating this response.TimestampoptionalstringTimestamp when the health response is being returned by this service.ClientIpoptionalstringIP of the client from which this request for health check is received by the gateway.X-Forwarded-ForoptionalstringSequence of all the Ips of the systems involved 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]" } Search wire transfers post /wireInquiry/v1/transactions/listBased on search criteria provided, get a list of wire transfers. The account number and date range are required for every request.RequestNAMETYPEDESCRIPTIONaccountNumberrequiredstringThe bank account number. This field cannot exceed 16 characters.fromDaterequiredstringStart 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-DDtoDaterequiredstringEnd 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-DDminimumAmountoptionalstringThe 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.maximumAmountoptionalstringThe 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.requestReferencestringA reference value for the original request that is useful for traceability and reporting. The ID cannot exceed 35 characters.pageNumberoptionalstringThe number of the page being viewed. This number must be greater than or equal to 1.pageSizeoptionalstringThe 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" }ResponsesSearch results match the criteriaNAMETYPEDESCRIPTIONtransactionsarrayWireListTransactionmetadataobjectMetadataResponse 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" }, "debtor": { "name": "Paul Wilson" }, "debtorAccount": { "accountNumber": "123456789" } }], "metadata": { "page": { "pageNumber": 1, "pageSize": 25, "totalPages": 3, "totalRecords": 75, "lastPage": true } } }Bad input parameterNAMETYPEDESCRIPTIONmessagesoptionalarrayMessagepageobjectPageResponse example (400){ "messages": { "code": "Wire-List-400-bad-input", "message": "Bad input parameter" } } View transfer details with the transaction ID get /wireInquiry/v1/transactions/detail/{transactionId}Provide the transaction ID to retrieve all available fields for that wire transfer.Requestpath FIELDTYPEDESCRIPTIONtransactionIdrequiredstringThe unique ID number associated with the original payment request.Request examplecurl --location: 'https://partner-api.key.com/wireInquiry/v1/transactions/detail/US99999000999999' --header 'EPPId: testwUhSQADUD4DwYyZz2hZkwLqsoFGK' --header 'Accept: application/json' --header 'Bearer testZcKJDWnwDWmmf9qah6PJvPy8'ResponsesA Wire transaction matches the provided transactionIdNAMETYPEDESCRIPTIONtransactionIdstringThe unique ID number associated with the original payment request.transactionDatestringDate the transfer occurred. Format: YYYY-MM-DDtransactionAmountnumberThe dollar amount of the transaction.requestReferencestringA reference value for the original request that is useful for traceability and reporting. The ID cannot exceed 35 characters.sendersReferencestringA reference value provided by the sender. For outbound payments, this value is the same as the transaction ID. The ID cannot exceed 35 characters.creditorObjectPartyListcreditorAccountObjectAccountListdebtorObjectPartyListdebtorAccountObjectAccountListoriginatorObjectPartyListoriginatorAccountObjectAccountListbeneficiaryObjectPartyListbeneficiaryAccountObjectAccountListultimateCreditorObjectPartyListultimateCreditorAccountObjectAccountListultimateDebtorObjectPartyListultimateDebtorAccountObjectAccountListremittanceInformationstringInformation 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.bankToBankInstructionsstringMessages 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 transactionIdNAMETYPEDESCRIPTIONmessagesoptionalarrayMessagepageObjectPageResponse example (404){ "messages": { "code": "Wire-Detail-404-no-records", "message": "Record Not Found", "X-Forwarded-For": "[156.77.111.28]" } } Schemas WireListTransaction NAMETYPEDESCRIPTIONtransactionIdstringThe unique ID number associated with the original payment requesttransactionDatestringDate the transfer occurred. Format: YYYY-MM-DDtransactionAmountnumberThe dollar amount of the transaction.requestReferencestringA reference value for the original request that is useful for traceability and reporting. The ID cannot exceed 35 characters.sendersReferencestringA reference value provided by the sender. For outbound payments, this value is the same as the transaction ID. The ID cannot exceed 35 characters.creditorObjectPartyList creditorAccountObjectAccountList debtorObjectPartyList debtorAccountObjectAccountList AccountList NAMETYPEDESCRIPTIONaccountNumberstringAccount number of the party.virtualAccountNumberstringAccount number for the virtual account (VAM). PartyList NAMETYPEDESCRIPTIONnamestringContains the customer identification number and the company name. Message NAMETYPEDESCRIPTIONcodestringStatic code assigned by the network or payment system.messagestringA human-readable message associated with the code. Page NAMETYPEDESCRIPTIONpageNumberintegerThe number of the page being viewed.pageSizeintegerThe number of records per page.totalPagesintegerThe total number of pages available.totalRecordsintegerThe total number of the transactions (records) available in the result set.lastPagebooleanIndicates the last page of the total pages. Metadata NAMETYPEDESCRIPTIONmessagesoptionalarrayMessage pageObjectPage responseHeader NAMETYPEDESCRIPTIONstatusrequiredstringIndicates whether the result was successfully retrieved.statusDescriptionrequiredstringDescription of the statusretreivedRowsstringTotal number of transactions retrievedtotalRowsstringTotal number of transactions matching the requested criteria Errors For more information about general errors, see Error handling. Changelog ReleaseAPI versionChange descriptionImpactSeptember 20251.3.2Added Api-Url to error responses for the endpoint - /wireInquiry/v1/transactions/details. This field shows which URL path triggered the response.> LOWJune 20251.3.1Added 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.LOWApril 20251.3.0To 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/listAdded /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.HIGHMay 20241.2.1Added 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.MIDMarch 20241.1.5Updated 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.LOWDecember 20231.1.4Added 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.HIGHSeptember 20231.1.3The 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.LOWJuly 20231.1.1Added 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.MIDMay 20231.1.0Changed 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.MIDDecember 20221.0.0Released on the Developer Portal. Impact levelsLOW: 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