ACH Inquiry

clock 4-minute read calender 1.1.6 | updated Apr. 24, 2024

Get the status for your ACH transactions

What you can do Endpoint
Health check get /accounts/transactions/v1/healthCheck
Get the status of ACH transactions post /accounts/transactions/v1/ACHStatusInquiry/list
Get detailed information about a collected transaction post /accounts/transactions/v1/collectedACHtransactions/list
Get the status of posted ACH transactions post /accounts/transactions/v1/postedACHtransactions/list
Get the status of a returned ACH transaction post /accounts/transactions/v1/returnACHtransactions/list

Before you begin

All KeyBank APIs require certificates, user credentials, and certain permissions. Check out our Getting Started Guide to learn more.

You can use the ACH Inquiry API to get the status for ACH transactions as they are received and processed by KeyBank.

The consolidation settlement type affect what information is returned. The ACHStatus field defines the status of the transaction as in progress (COLLECTED), processed (POSTED), or returned (RETURNED).

  • For clients with a non-consolidated settlement, you can receive information about collected, posted, and returned transactions.

  • For clients with a consolidated settlement, you will only receive collected and returned transactions. POSTED is not an available status for consolidated settlement.

 

PAR-don me

ACH inquiries require a parNumber or traceNumber for inquiries. Learn more in our ACH APIs User Guide.


get /accounts/transactions/v1/healthCheck

Verify you can connect to the API service.

header FIELD TYPE DESCRIPTION
X-CorrelationIdoptional string A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
 
NAME TYPE DESCRIPTION
Statusoptional string Status of the health check response.
Sourceoptional string System 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.
Timestampoptional string Timestamp when the health response is being returned by this service.
ClientIpoptional string IP of the client from which this request for health check is received by the gateway.
X-Forwarded-Foroptional string Sequence of all the Ips of the systems involved 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 /accounts/transactions/v1/ACHStatusInquiry/list

Inquire about the status of an ACH transaction with a trace number or PAR number. Use the trace number or PAR number from the response of the originating transaction request. You cannot use both the trace number and PAR number for a query. You can look up multiple transactions with either number. When you submit an inquiry for multiple numbers, separate the values with a comma.

header FIELDTYPEDESCRIPTION
X-CorrelationIdoptionalstringA unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
BODY FIELDTYPEDESCRIPTION
Get the status of ACH transactionsoptionaloneOfachStatusInquiryParRequest
achStatusInquiryTraceNumberRequest

Request example

copylink
{
    "getACHStatusInquiryRequest": {
        "accountNumber": [
            "987654321",
            "123456789"
        ],
        "parNumber": [
            "22018007665985"
        ],
        "traceNumber": [],
        "startRowIndex": "1",
        "endRowIndex": ""
    }
}
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
errorResponseoptionalObjecterrorResponse

Response example (200)

copylink
{
    "responseHeader": {
        "status": "S",
        "statusDescription": "Successfully returned results for the requested range 1 to 1",
        "retrivedRows": "1",
        "totalRows": "1",
        "dataLoadDate": "2022-07-13"
    },
    "ACHTransactionStatus": [
        {
            "ACHStatus": "COLLECTED"
        },
        {
            "ACHCollectedTransaction": {
                "transactionParNumber": "1234567891113",
                "sourceBankNumber": "1234",
                "sourceAccountNumber": "123456789",
                "transactionCode": "22",
                "transactionAmount": "10.01",
                "creditOrDebitCode": "C",
                "sourceTransactionProcessDate": "2021-03-08",
                "sourceTransactionProcessTime": "060011",
                "sourceTransactionProcessTimestamp": "2021-03-08 06:00:11",
                "sourceTransactionPostDate": "2021-03-08",
                "receivingCustomerName": "TEST COMPANY 1, LLC",
                "receivingCompanyName": "TEST COMPANY 2, LLC",
                "receivingCustIdentificationNumber": "TESTCOMPANY",
                "originatingCompanyName": "TESTCOMPANY VRU",
                "originatingCustomerName": "TEST CORP DEP",
                "nachaSecCode": "ABC",
                "traceNumber": "000000000000000",
                "transactionDescription": "VALIDATION"
            }
        }
    ]
}
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 appplication 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."
    }
}

post /accounts/transactions/v1/collectedACHtransactions/list

Look up a list of collected ACH transactions by account number and date.

header FIELDTYPEDESCRIPTION
X-CorrelationIdoptionalstringA unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
BODY FIELDTYPEDESCRIPTION
getACHCollectedTransactionsRequestoptionalObjectgetACHCollectedTransactionsRequest

Request example

copylink
{
    "getACHCollectedTransactionsRequest": {
        "accountNumber": [
            "123456789"
        ],
        "fromDate": "2022-03-12",
        "toDate": "2022-04-12",
        "creditOrDebitCode": "C",
        "fromAmount": "01.00",
        "toAmount": "180.00",
        "addendaFlag": "N",
        "secCode": "",
        "traceNumber": "0612123100888473",
        "parNumber": "",
        "detailsFlag": "N",
        "startRowIndex": "1",
        "endRowIndex": "1"
    }
}
NAMETYPEDESCRIPTION
getACHCollectedTransactionsResponserequiredObjectgetACHCollectedTransactionsResponse

Response example (200)

copylink
{
    "getACHCollectedTransactionsResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully returned results for the requested range 1 to 1",
            "retrivedRows": "1",
            "totalRows": "1",
            "dataLoadDate": "2022-04-07"
        },
        "ACHCollectedTransaction": [
            {
                "transactionParNumber": "22081003123797",
                "sourceBankNumber": "1000",
                "sourceAccountNumber": "123456789",
                "origAcctSuffix": "XX",
                "sourceSysCode": "DDA",
                "sourceSysOfRecordCode": "ACH",
                "snapshotDate": "2022-03-22",
                "transactionCode": "22",
                "transactionCodeDescription": "Automated Deposit",
                "transactionFlowTypeCode": "INTRA",
                "transactionFlowTypeDescription": "Intrabank",
                "originatingReceiverCode": "OI",
                "transactionAmount": "31.05",
                "transactionDescription": "DEPOSIT",
                "creditOrDebitCode": "C",
                "inboundCollectionWindow": "0500",
                "sourceTransactionProcessDate": "2022-03-22",
                "sourceTransactionProcessTime": "050022",
                "sourceTransactionProcessTimestamp": "2022-03-22 05:00:22",
                "sourceTransactionSettledDate": 1647907200,
                "sourceTransactionSettledTime": "1715",
                "sourceTransactionSettledTimestamp": "2022-03-22 17:15:42",
                "sourceTransactionPostDate": "2022-03-22",
                "sourceTransactionPostTime": "1716",
                "sourceTransactionPostTimestamp": "2022-03-22 17:16:02",
                "deliveryStatusCode": "DEL",
                "deliveryStatusDescription": "DELIVERED",
                "receivingAccountNumber": "987654321",
                "receivingFIBankNumber": "0001",
                "receivingFIRoutingNumber": "123456789",
                "receivingCustIdentificationNumber": "1234567",
                "receivingCustomerName": "CUSTOMER NAME 1",
                "receivingCompanyName": "COMPANY NAME 1",
                "originatingAccountNumber": "123456789012",
                "originatingFIBankNumber": "0000",
                "originatingFIRoutingNumber": "1234567890",
                "originatingCustIdentificationNumber": "099999999",
                "originatingCompanyName": "MERCHANT",
                "originatingCustomerName": "TEST MERCHANT",
                "checkSerialNumber": "4345",
                "nachaBatchNumber": "0000006",
                "nachaFileHeadRefererenceNumber": "22081000015",
                "nachaSecCode": "CCD",
                "nachaSecDescription": "Cash Concentration or Disbursement",
                "traceNumber": "061000100888473",
                "addendaPresentFlag": "0",
                "addendaRecordNumber": "0000000000",
                "originatingReceiverDescription": "Originating Item",
                "goRoutingNumber": "222370040",
                "authorizedCustomerName": "TEST CUSTOMER1",
                "iatFlag": "N",
                "collectionPoint": "TESTPOINT",
                "batchId": "26052",
                "transactionTraceId": "041001032851213",
                "addendaInformation": {
                    "nonIatAddendum": {
                        "addendaParNumber": "21063004069232",
                        "payInformation": "TXP51662854201101210305T*0004081318",
                        "addendaTypeCode": "05",
                        "addendaTypeDescription": "Addenda Record (Applies to CCD, CIE, CTX, PPD, TRX, and WEB entries)",
                        "entryDetailSequenceNumber": "986756",
                        "keyBankTransactionReferenceNumber": "0"
                    }
                },
                "customData": "merchant:status"
            }
        ]
    }
}
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 appplication 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."
    }
}

post /accounts/transactions/v1/postedACHtransactions/list

Retrieves a list of posted ACH transactions for queried accounts.

header FIELDTYPEDESCRIPTION
X-CorrelationIdoptionalstringA unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
BODY FIELDTYPEDESCRIPTION
getACHPostedTransactionsRequestoptionalObjectgetACHPostedTransactionsRequest

Request example

copylink
{
    "getACHPostedTransactionsRequest": {
        "accountNumber": [
            "123456789"
        ],
        "fromDate": "2022-01-12",
        "toDate": "2022-04-12",
        "creditOrDebitCode": "",
        "fromAmount": "01.00",
        "toAmount": "180.00",
        "parNumber": "",
        "startRowIndex": "1",
        "endRowIndex": "1"
    }
}
NAMETYPEDESCRIPTION
getACHPostedTransactionsResponserequiredObjectgetACHPostedTransactionsResponse

Response example (200)

copylink
{
    "getACHPostedTransactionsResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully returned results for the requested range 1 to 1",
            "retrivedRows": "1",
            "totalRows": "1",
            "dataLoadDate": "2022-03-04"
        },
        "ACHPostedTransaction": [
            {
                "snapshotDate": "2022-02-04",
                "processDate": "2022-02-04",
                "sourceBankNumber": "0000",
                "sourceAccountNumber": "987654321",
                "transactionParNumber": "22023411528113",
                "transactionAmount": "10.0",
                "creditOrDebitCode": "C",
                "hoganTransactionCode": "1007",
                "baiCode": "169",
                "transactionCode": "22",
                "regulationDescription1": "TEST CORP DEP",
                "regulationDescription2": "TEST*527042600*01101*2",
                "regulationDescription3": "20201**04324",
                "postingWindow": "0600",
                "batchID": "18102"
            }
        ]
    }
}
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 appplication 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."
    }
}

post /accounts/transactions/v1/returnACHtransactions/list

Retrieve a list of returned ACH transactions for queried accounts.

header FIELDTYPEDESCRIPTION
X-CorrelationIdoptionalstringA unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
BODY FIELDTYPEDESCRIPTION
getACHReturnTransactionsRequestoptionalObjectgetACHReturnTransactionsRequest

Request example

copylink
{
    "getACHReturnTransactionsRequest": {
        "accountNumber": [
            "123456789"
        ],
        "fromDate": "2021-06-12",
        "toDate": "2021-07-12",
        "creditOrDebitCode": "C",
        "fromAmount": "01.00",
        "toAmount": "180.00",
        "parNumber": "",
        "detailsFlag": "Y",
        "startRowIndex": "1",
        "endRowIndex": "10"
    }
}
NAMETYPEDESCRIPTION
getACHReturnTransactionsResponseoptionalObjectachReturnTransactionsResponse

Response example (200)

copylink
{
    "getACHReturnTransactionsResponse": {
        "responseHeader": {
            "status": "S",
            "statusDescription": "Successfully returned results for the requested range 1 to 1",
            "retrivedRows": "1",
            "totalRows": "1",
            "dataLoadDate": "2022-07-16"
        },
        "ACHReturnTransaction": [
            {
                "returnTransactionParNumber": "21181233817881",
                "sourceBankNumber": "1234",
                "sourceAccountNumber": "123456789",
                "sourceTransactionRecordNumber": "2118123373937",
                "sourceSysCode": "DDA",
                "sourceSysOfRecordCode": "ACH",
                "snapshotDate": "2021-07-22",
                "originalACHTransactionParNumber": "21176003985391",
                "originalTransactionProcessDate": "2021-06-25",
                "originalTransactionProcessTime": "153644",
                "originalTransactionProcessTimestamp": "2021-06-25 15:36:44",
                "originatingReceiverCode": "OR",
                "originatingReceiverDescription": "Originating Return",
                "transactionCode": "21",
                "transactionCodeDescription": "Automated Return or Notification of Change for original transaction code 22, 23, or 24",
                "transactionFlowTypeCode": "INTRA",
                "transactionFlowTypeDescription": "Intrabank",
                "transactionAmount": "128.7",
                "transactionDescription1": "RETURN NOTE",
                "creditOrDebitCode": "C",
                "sourceTransactionCreatedDate": "2021-06-25",
                "sourceTransactionCreatedTime": "1406",
                "sourceTransactionCreatedTimestamp": "2021-06-25 14:06:00",
                "sourceTransactionProcessDate": "2021-06-25",
                "sourceTransactionProcessTime": "153644",
                "sourceTransactionProcessTimestamp": "2021-06-25 15:36:44",
                "inboundCollectionWindow": "1600",
                "outboundCollectionWindow": "2000",
                "sourceTransactionSettledDate": "2021-06-28",
                "receivingAccountNumber": "12345123234",
                "receivingCustIdentificationNumber": "34344",
                "receivingCustomerName": "Test receiveCustomer Name",
                "receivingCompanyName": "Test receiveCompany Name",
                "receivingFIBankNumber": "1234",
                "receivingFIRoutingNumber": "256071234",
                "originatingAccountNumber": "123456789",
                "originatingCustIdentificationNumber": "146013200U",
                "originatingCustomerName": "Test origCustomerName",
                "originatingCompanyName": "Test origCompanyName",
                "originatingFIBankNumber": "5556",
                "originatingFIRoutingNumber": "454646334",
                "authorizedCustomerName": "Test authCustName",
                "immediateDestinationID": "021300077",
                "returnReleaseDate": "2021-06-29",
                "returnReasonCode": "R02",
                "returnReasonDescription": "Account Closed",
                "nachaBatchNumber": "0000013",
                "nachaFileHeadRefererenceNumber": "21176000442",
                "nachaSecCode": "PPD",
                "nachaSecDescription": "Prearranged Payment & Deposit Entry",
                "traceId": "041001012851361",
                "collectionPoint": "TESTPOINT",
                "batchID": "1125"
            }
        ]
    }
}
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 appplication 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
getACHCollectedTransactionsRequestoptionalObjectgetACHCollectedTransactionsRequest
NAMETYPEDESCRIPTION
getACHCollectedTransactionsResponserequiredObjectgetACHCollectedTransactionsResponse
NAMETYPEDESCRIPTION
transactionParNumberoptionalstringThe unique PAR number assigned to the transaction by the ACH product processor.
sourceBankNumberoptionalstringOriginating entry bank number
sourceAccountNumberoptionalstringOriginating account number.
origAcctSuffixoptionalstringDo not use. This field is for internal purpose only.
sourceSysCodeoptionalstringDo not use. This field is for internal purpose only.
sourceSysOfRecordCodeoptionalstringDo not use. This field is for internal purpose only.
snapshotDateoptionalstringThis field is for internal purpose only.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionFlowTypeCodeoptionalstringIdentifies if transaction is intrabank (within a single financial institution) or interbank (between two or more banks). Valid values: INTRA, INTER
transactionFlowTypeDescriptionoptionalstringDescription for the transaction flow type code.
originatingReceiverCodeoptionalstringTwo-character code that identifies the transaction type as originating (O) or receiving (R) and if the transaction is incoming (I) or outgoing (O). Codes can be OI, OO, RI, or RO.
transactionAmountoptionalstringThe dollar amount of the transaction.
transactionDescriptionoptionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
inboundCollectionWindowoptionalstringThe time window when the transaction collection is processed. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionProcessDateoptionalstringDate when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptionalstringTime when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptionalstringThe date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionSettledDateoptionalstringDate when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptionalstringThe time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptionalstringThe date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionPostDateoptionalstringDate the ACH transaction is posted. Format: YYYY-MM-DD
sourceTransactionPostTimeoptionalstringTime the ACH transaction is posted. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionPostTimestampoptionalstringThe date and time the transaction is posted. Format: YYYY-MM-DD HH:MM:SS
deliveryStatusCodeoptionalstringThe code abbreviation for the delivery status of the ACH transaction.
deliveryStatusDescriptionoptionalstringThe delivery status description for the abbreviated code.
receivingAccountNumberoptionalstringAccount number of the person or institution receiving the funds.
receivingFIBankNumberoptionalstringBank number for the financial institution receiving the funds.
receivingFIRoutingNumberoptionalstringRouting number for the receiving financial institution.
receivingCustIdentificationNumberoptionalstringThe customer identification number for the person receiving the transaction.
receivingCustomerNameoptionalstringCustomer name of the person receiving the funds.
receivingCompanyNameoptionalstringCompany name of the institution getting the funds.
originatingAccountNumberoptionalstringAccount number of the ACH transaction originator.
originatingFIBankNumberoptionalstringOriginating financial institution bank number
originatingFIRoutingNumberoptionalstringOriginating financial institution routing number
originatingCustIdentificationNumberoptionalstringOriginating customer identification number
originatingCompanyNameoptionalstringOriginating company name
originatingCustomerNameoptionalstringOriginating customer name
checkSerialNumberoptionalstringSerial number for the check converted to an ACH transaction.
nachaBatchNumberoptionalstringThe sequential number of the Nacha batch job.
nachaFileHeadRefererenceNumberoptionalstringThe Nacha transaction file reference number.
nachaSecCodeoptionalstringThe Nacha standard entry class (SEC) code for the transaction. Valid values: CCD, CTX, PPD, TEL WEB
nachaSecDescriptionoptionalstringThe description for the Nacha SEC code.
traceNumberoptionalstringThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
postCompanyCostcontrolNumberoptionalstringDo not use. This field is for internal purpose only.
glAccountNumberoptionalstringDo not use. This field is for internal purpose only.
addendaPresentFlagoptionalstringIndicates if there are addenda records or not.
addendaRecordNumberoptionalstringNumber of addenda records.
originatingReceiverDescriptionoptionalstringDescription for the collected originating receiver code.
goRoutingNumberoptionalstringGateway operator routing number for international transactions.
authorizedCustomerNameoptionalstringAuthorized customer name
iatFlagoptionalstringInternational transaction identifier
collectionPointoptionalstringTransaction collection point
batchIdoptionalstringThe identification number for the batch job.
transactionTraceIdoptionalstringThe trace ID number from the source application.
addendaInformationoptionalObjectaddendaInformation
customDataoptionalstringCustom data from the originating payment request.
NAMETYPEDESCRIPTION
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
sourceBankNumberoptionalstringOriginating entry bank number
sourceAccountNumberoptionalstringOriginating account number.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionAmountoptionalstringThe dollar amount of the transaction.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
sourceTransactionProcessDateoptionalstringDate when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptionalstringTime when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptionalstringThe date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionSettledDateoptionalstringDate when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptionalstringThe time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptionalstringThe date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionPostDateoptionalstringDate the ACH transaction is posted. Format: YYYY-MM-DD
sourceTransactionPostTimeoptionalstringTime the ACH transaction is posted. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionPostTimestampoptionalstringThe date and time the transaction is posted. Format: YYYY-MM-DD HH:MM:SS
receivingCustomerNameoptionalstringCustomer name of the person receiving the funds.
receivingCompanyNameoptionalstringCompany name of the institution getting the funds.
originatingCompanyNameoptionalstringOriginating company name
originatingCustomerNameoptionalstringOriginating customer name
nachaSecCodeoptionalstringThe Nacha standard entry class (SEC) code for the transaction. Valid values: CCD, CTX, PPD, TEL, WEB
traceNumberoptionalstringThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
transactionDescriptionoptionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
receivingCustIdentificationNumberrequiredstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
NAMETYPEDESCRIPTION
getACHPostedTransactionsResponserequiredObjectgetACHPostedTransactionsResponse
NAMETYPEDESCRIPTION
snapshotDateoptionalstringDo not use. This field is for internal purpose only.
processDateoptionalstringDate the transaction was processed. Format: YYYY-MM-DD
sourceBankNumberoptionalstringOriginating entry bank number
sourceAccountNumberoptionalstringOriginating account number
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionAmountoptionalstringThe dollar amount of the transaction.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
hoganTransactionCodeoptionalstringThe KeyBank Hogan code for the transaction.
baiCodeoptionalstringThe three-digit BAI (Bank Administration Institute) code for the transaction.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
regulationDescription1optionalstringRegulation description for the transaction.
regulationDescription2optionalstringAdditional regulation information for the transaction.
regulationDescription3optionalstringAdditional regulation information for the transaction.
regulationDescription4optionalstringAdditional regulation information for the transaction.
postingWindowoptionalstringThe time window when the transaction collection is posted. The time format uses the 24-hour clock. Format: HHMM
batchIDoptionalstringThe identification number for the batch job.
customDataoptionalstringCustom data from the originating payment request.
NAMETYPEDESCRIPTION
getACHPostedTransactionsRequestoptionalObjectgetACHPostedTransactionsRequest
NAMETYPEDESCRIPTION
returnTransactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
sourceBankNumberoptionalstringOriginating entry bank number
sourceAccountNumberoptionalstringOriginating account number
sourceTransactionRecordNumberoptionalstringOriginating record number for the transaction
sourceSysCodeoptionalstringDo not use. This field is for internal purpose only.
sourceSysOfRecordCodeoptionalstringDo not use. This field is for internal purpose only.
snapshotDateoptionalstringThis field is for internal purpose only.
originalACHTransactionParNumberoptionalstringThe assigned PAR number for the original ACH transaction.
originalTransactionProcessDateoptionalstringDate the transaction is processed. Format: YYYY-MM-DD
originalTransactionProcessTimeoptionalstringTime the transaction is processed in 24-hour time. Format: HHMMSS
originalTransactionProcessTimestampoptionalstringThe date and time the transaction is processed. Format: YYYY-MM-DD HH:MM:SS
originatingReceiverCodeoptionalstringTwo-character code that identifies the transaction type as originating (O) or receiving (R) and if the transaction is incoming (I) or outgoing (O). Codes can be OI, OO, RI, or RO.
originatingReceiverDescriptionoptionalstringDescription for the returned originating receiver code.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionFlowTypeCodeoptionalstringIdentifies if transaction is intrabank (within a single financial institution) or interbank (between two or more banks). Valid values: INTRA, INTER
transactionFlowTypeDescriptionoptionalstringDescription for the transaction flow type code.
transactionAmountoptionalstringThe dollar amount of the transaction.
transactionDescription1optionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
transactionDescription2optionalstringAdditional transaction description information.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
sourceTransactionCreatedDateoptionalstringDate when the user created the ACH transaction. Format: YYYY-MM-DD
sourceTransactionCreatedTimeoptionalstringTime when the user created the ACH transaction. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionCreatedTimestampoptionalstringThe date and time that the ACH transaction was created. Format: YYYY-MM-DD HH:MM:SS
sourceTransactionProcessDateoptionalstringDate when the transaction was collected by the ACH product processor. Format: YYYY-MM-DD
sourceTransactionProcessTimeoptionalstringTime when the transaction was collected by the ACH product processor. The time format uses the 24-hour clock. Format: HHMMSS
sourceTransactionProcessTimestampoptionalstringThe date and time the ACH transaction was collected by the ACH product processor. Format: YYYY-MM-DD HH:MM:SS
inboundCollectionWindowoptionalstringThe time window when the transaction collection is processed. The time format uses the 24-hour clock. Format: HHMM
outboundCollectionWindowoptionalstringThe outbound processing window for the transaction collection. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledDateoptionalstringDate when the transaction is settled. Format: YYYY-MM-DD
sourceTransactionSettledTimeoptionalstringThe time window when the transaction is settled. The time format uses the 24-hour clock. Format: HHMM
sourceTransactionSettledTimestampoptionalstringThe date and time the ACH transaction is settled. Format: YYYY-MM-DD HH:MM:SS
receivingAccountNumberoptionalstringAccount number of the person or institution receiving the funds.
receivingCustIdentificationNumberoptionalstringThe customer identification number for the person receiving the transaction.
receivingCustomerNameoptionalstringCustomer name of the person receiving the funds.
receivingCompanyNameoptionalstringCompany name of the institution getting the funds.
receivingFIBankNumberoptionalstringBank number for the financial institution receiving the funds.
receivingFIRoutingNumberoptionalstringRouting number for the receiving financial institution.
originatingAccountNumberoptionalstringAccount number of the ACH transaction originator.
originatingCustIdentificationNumberoptionalstringOriginating customer identification number
originatingCustomerNameoptionalstringOriginating customer name
originatingCompanyNameoptionalstringOriginating company name
originatingFIBankNumberoptionalstringOriginating financial institution bank number
originatingFIRoutingNumberoptionalstringOriginating financial institution routing number
authorizedCustomerNameoptionalstringAuthorized customer name
immediateDestinationIDoptionalstringThe ID indicates the next location of the file once it leaves KeyBank.
returnReleaseDateoptionalstringRelease date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptionalstringThe code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00
returnReasonDescriptionoptionalstringDescription as to why the ACH transaction is returned.
checkSerialNumberoptionalstringSerial number for the check converted to an ACH transaction.
nachaBatchNumberoptionalstringThe sequential number of the Nacha batch job.
nachaFileHeadRefererenceNumberoptionalstringThe Nacha transaction file reference number.
nachaSecondarySecCodeoptionalstringThe secondary Nacha standard entry class (SEC) code for the transaction, if applicable. Valid values: CCD, CTX, PPD, TEL, WEB.
nachaSecondarySecDescriptionoptionalstringThe description for the secondary Nacha SEC code.
traceIdoptionalstringThe trace ID number from the source application.
postCompanyCostcontrolNumberoptionalstringDo not use. This field is for internal purpose only.
glAccountNumberoptionalstringDo not use. This field is for internal purpose only.
collectionPointoptionalstringTransaction collection point
collectionApplicationTypeCodeoptionalstringDo not use. This field is for internal purpose only.
collectionApplicationTypeDescriptionoptionalstringDo not use. This field is for internal purpose only.
batchIDoptionalstringThe identification number for the batch job.
customDataoptionalstringCustom data from the originating payment request.
NAMETYPEDESCRIPTION
processDateoptionalstringDate the transaction was processed. Format: YYYY-MM-DD
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionAmountoptionalstringThe dollar amount of the transaction.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
baiCodeoptionalstringThe three-digit BAI (Bank Administration Institute) code for the transaction.
transactionCodeoptionalstringTwo-digit code identifying the account type at the receiving financial institution.
regulationDescription1optionalstringRegulation description for the transaction.
regulationDescription2optionalstringAdditional regulation information for the transaction.
regulationDescription3optionalstringAdditional regulation information for the transaction.
regulationDescription4optionalstringAdditional regulation information for the transaction.
postingWindowoptionalstringThe time window when the transaction collection is posted. The time format uses the 24-hour clock. Format: HHMM
NAMETYPEDESCRIPTION
getACHReturnTransactionsRequestoptionalObjectgetACHReturnTransactionsRequest
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
ACHReturnTransactionoptionalarrayACHReturnTransaction
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
transactionParNumberoptionalstringThe unique PAR number assigned to the transaction by the ACH product processor.
transactionCodeoptionalstringTwo digit code identifying the account type at the receiving financial institution.
transactionCodeDescriptionoptionalstringDescription for the transaction code.
transactionAmountoptionalstringThe dollar amount of the transaction.
transactionDescription1optionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
transactionDescription2optionalstringAdditional transaction description information.
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
returnReleaseDateoptionalstringRelease date of the returned transaction to the ACH system. Format: YYYY-MM-DD
returnReasonCodeoptionalstringThe code associated with the reason for returning the ACH transaction. The code is the letter 'R' for reason followed by a two-digit numeric code. Format: R00
returnReasonDescriptionoptionalstringDescription as to why the ACH transaction is returned.
NAMETYPEDESCRIPTION
getACHStatusInquiryRequestoptionalObjectgetACHStatusInquiryParRequest
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
ACHTransactionStatusoptionalarrayachStatusInquiryResult
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
ACHStatusoptionalstringThe status informs you if the ACH transaction has been collected or returned. Valid values: COLLECTED or RETURNED
ACHCollectedTransactionoptionalObjectachCollectedTransactionsStatusResult
ACHPostedTransactionoptionalObjectachPostedTransactionsStatusResult
ACHReturnTransactionoptionalObjectachReturnTransactionsStatusResult
NAMETYPEDESCRIPTION
getACHStatusInquiryRequestoptionalObjectgetACHStatusInquiryTraceNumberRequest
NAMETYPEDESCRIPTION
iatAddendumoptionalObjectiatAddendum
nonIatAddendumoptionalObjectnonIatAddendum
nocAddendumoptionalObjectnocAddendum
NAMETYPEDESCRIPTION
errorCodeoptionalstringBusiness error code
errorDescriptionoptionalstringBusiness error description
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
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequiredstringThe starting date range for the transaction. The date must be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequiredstringThe ending date range for the transaction. The date must be be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD
sourceTransactionSettledDateoptionalstringDate when the transaction is settled. Format: YYYY-MM-DD
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptionalstringTransaction amount lower limit value to be searched.
toAmountoptionalstringTransaction amount upper limit value to be searched.
addendaFlagrequiredstringRetrieves addenda information if set to Y for yes. Valid values: Y, N.
secCodeoptionalstringThe three-digit Standard Entry Class code based on Nacha rules. Valid values: CCD, CTX, PPD, TEL, WEB.
traceNumberoptionalstringThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
parNumberoptionalstringThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
detailsFlagrequiredstringReturn a detailed response (Y) or a brief response (N). Valid values: Y, N
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
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.
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
ACHCollectedTransactionoptionalarrayachCollectedTransactionsResult
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequiredstringThe starting date range for the transaction. The date must be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequiredstringThe ending date range for the transaction. The date must be be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptionalstringTransaction amount lower limit value to be searched.
toAmountoptionalstringTransaction amount upper limit value to be searched.
parNumberoptionalstringThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
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.
NAMETYPEDESCRIPTION
responseHeaderrequiredObjectresponseHeader
ACHPostedTransactionoptionalarrayachPostedTransactionsResult
errorResponseoptionalObjecterrorResponse
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
fromDaterequiredstringThe starting date range for the transaction. The date must be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD
toDaterequiredstringThe ending date range for the transaction. The date must be be less than or equal to the current date. Transaction data can be recalled from the previous 24 months. Date range cannot exceed more than one year. Format: YYYY-MM-DD
creditOrDebitCodeoptionalstringIdentifies the transaction type as credit or debit. To get both credit and debit transactions, leave this parameter blank. Valid values: C, D.
fromAmountoptionalstringTransaction amount lower limit value to be searched.
toAmountoptionalstringTransaction amount upper limit value to be searched.
parNumberoptionalstringThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
detailsFlagrequiredstringReturn a detailed response (Y) or a brief response (N). Valid values: Y, N
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
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.
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
parNumberrequiredarrayThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
traceNumberoptionalarrayThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
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.
NAMETYPEDESCRIPTION
accountNumberrequiredarrayOne or more bank account numbers. To look up multiple accounts, separate the account numbers with a comma. This field cannot exceed than 16 characters.
traceNumberrequiredarrayThe unique number for the transaction provided by the originator. Multiple trace numbers can be comma separated.
parNumberoptionalarrayThe PAR (Payment Assigned Reference) number is a unique identifier assigned by the ACH Product Processor. Use a comma to separate multiple PAR numbers.
receivingCustIdentificationNumberoptionalstringThe unique ID number associated with the payment recipient. This number is defined in the originating payment request.
startRowIndexoptionalstringPagination parameter that indicates the starting count available for the records. If this parameter is not provided, value will default to 1.
endRowIndexoptionalstringThis is a pagination field. It indicates the last count available for the records. If the field is not provided, value will default to 1000. The request can't exceed more than 1000 records from the startRowIndex.
NAMETYPEDESCRIPTION
StatusoptionalstringStatus 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.
NAMETYPEDESCRIPTION
addendaParNumberoptionalstringThe unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptionalstringDo not use. This field is for internal purpose only.
transactionParNumberoptionalstringThe unique PAR number assigned to the transaction by the ACH product processor.
payInformationoptionalstringAdditional information about the remittance payment.
addendaTypeCodeoptionalstringTwo-digit code identifying the type of information.
addendaTypeDescriptionoptionalstringDescription of the addenda type associated with the code.
transactionTypeCodeoptionalstringThis field contains a three-character code used to identify the type of transaction.
transactionTypeDescroptionalstringThis field contains description of the the transaction type code
originatingFiIdentificationNumberCodeoptionalstringOriginating financial institution code
originatingFiNameoptionalstringOriginating financial institution name
originatingFiIdentificationNumberoptionalstringOriginating financial institution identification number
originatingFiBranchCountryCodeoptionalstringOriginating company country branch code
originatingCompanyNameoptionalstringOriginating company name
originatingCompanyAddress1optionalstringOriginating bank physical street address, line 1
originatingCompanyAddress2optionalstringOriginating bank physical street address, line 2
originatingCompanyCityStateProvinceoptionalstringOriginator city and state
originatingCompanyCountryPostalCodeoptionalstringOriginator country and postal code
receivingFiNameoptionalstringReceiving financial institution name
receivingFiIdentificationNumberoptionalstringReceiving financial institution identification number
receivingFiIdentificationNumberCodeoptionalstringReceiving financial institution code
receivingFiBranchCountryCodeoptionalstringReceiving company country branch code
receivingCustomerNameoptionalstringReceiving customer name
receivingCompanyNameoptionalstringReceiving company name
receivingCompanyNumberoptionalstringReceiving company number
receivingCompanyAddress1optionalstringReceiving company physical address, line 1
receivingCompanyAddress2optionalstringReceiving company physical address, line 2
receivingCompanyCityStateProvinceoptionalstringReceiving company city and state
receivingCompanyCountryPostalCodeoptionalstringReceiving company country and postal code
foreignCorrespondentFiIdNumberCodeoptionalstringForeign correspondent bank identification number qualifier
foreignCorrespondentFiNameoptionalstringCorrespondent bank name
foreignCorrespondentFiBRCountryCodeoptionalstringCorrespondent bank country code
foreignCorrespondentBankIdNumberoptionalstringCorrespondent bank identifier
foreignOriginatingAmountoptionalstringForeign payment amount
foreignOriginatingCurrencyCodeoptionalstringForeign currency code
foreignTraceNumberoptionalstringIdentifier number of the foreign transaction.
addendaSequenceNumberoptionalstringThe sequence number of the addenda. The number cannot exceed 4 digits.
entryDetailSequenceNumberoptionalstringSequence number of the entry detail
operatorCommandFlagoptionalstringOperator command flag
NAMETYPEDESCRIPTION
addendaParNumberoptionalstringThe unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptionalstringDo not use. This field is for internal purpose only.
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
addendaTypeCodeoptionalstringTwo-digit code identifying the type of information.
addendaTypeDescriptionoptionalstringDescription of the addenda type associated with the code.
changeCodeoptionalstringThe three-character change code begins with the letter 'C'. This code is applied to all NOCs to indicate the information that is being changed.
changeDescriptionoptionalstringThe description associated with the change code.
receivingFiIdentificationNumberoptionalstringReceiving financial institution identification number
correctedDataoptionalstringThe corrected data per the correction change code.
externalFiTransactionIdentificationNumberoptionalstringThe number used by an external financial institution to identify the transaction.
keyBankTransactionReferenceNumberoptionalstringUnique ACH transaction identifier created by KeyBank.
operatorCommandFlagoptionalstringOperator command flag
NAMETYPEDESCRIPTION
addendaParNumberoptionalstringThe unique PAR number assigned to the addendum by the ACH product processor.
snapshotDateoptionalstringDo not use. This field is for internal purpose only.
transactionParNumberoptionalstringThe unique PAR number assigned to the the transaction by the ACH product processor.
transactionSerialNumberoptionalstringSerial number for the transaction
transactionDescriptionoptionalstringA free form text field that provides the receiver with a description about the purpose of the transaction.
sourceTransactionCreatedDateoptionalstringDate when the user created the ACH transaction. Format: YYYY-MM-DD
sourceTransactionCreatedTimeoptionalstringTime when the user created the ACH transaction. The time format uses the 24-hour clock. Format: HHMM
payInformationoptionalstringAdditional information associated with the payment transaction.
addendaTypeCodeoptionalstringTwo-digit code identifying the type of information.
addendaTypeDescriptionoptionalstringDescription of the addenda type associated with the code.
entryDetailSequenceNumberoptionalstringSequence number of the entry detail
referenceInformation1optionalstringFree form text field with additional reference information.
referenceInformtion2optionalstringFree form text field with additional reference information.
networkIdentificationCodeoptionalstringNetwork identification code (NIC)
terminalIdentificationCodeoptionalstringTerminal identification code
terminalCityoptionalstringCity location of the terminal
terminalStateoptionalstringState location of the terminal
keyBankTransactionReferenceNumberoptionalstringUnique ACH transaction identifier created by KeyBank.
operatorCommandFlagoptionalstringOperator command flag
NAMETYPEDESCRIPTION
statusrequiredstringIndicates whether the result was successful or not. Valid values: accepted, failure
statusDescriptionrequiredstringDescription of the status
retrivedRowsoptionalstringTotal number of transactions retrieved.
totalRowsoptionalstringTotal number of transactions matching the requested criteria.
dataLoadDateoptionalstringIndicates the date that the requested data was loaded. Format: YYYY-MM-DD
NAMETYPEDESCRIPTION
getACHReturnTransactionsResponseoptionalObjectachReturnTransactionsResponse
NAMETYPEDESCRIPTION
errorCodeoptionalstringSystem error code
errorDescriptionoptionalstringSystem error description

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