ACH Origination | API Documentation

Send or collect an ACH transaction, report on the status, or undo a payment

ACH Origination Endpoints

What you can do	Endpoint
Health check	get /ach/payments/v1/healthCheck
Check the status of a payment request	post /ach/payments/v1/status
Check the status of addenda records	post /ach/payments/v1/status/addenda
Send or collect a payment	post /ach/payments/v1/ccd
Make or collect payments to or from a corporate account with attached records	post /ach/payments/v1/ctx
Make deposits and withdrawals to or from consumer accounts	post /ach/payments/v1/ppd
Authorize a payment over the phone	post /ach/payments/v1/tel
Send an online payment	post /ach/payments/v1/web
Undo a payment request	post /ach/payments/v1/undo
Send additional addenda information	post /ach/payments/v1/addenda

Before you begin

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

Sometimes it's the details

You can add details to your transaction. Use custom data feature when you send or validate a payment. Define the customData in the request payload. Learn more about our custom data feature here.

Overview

ACH stands for Automated Clearing House. ACH payments are electronic funds transfers (EFTs), a type of electronic payment that transfers funds between bank accounts within the United States. ACH payments are often less expensive than wire transfers, with lower or no transaction fees. Most commonly, ACH payments are used for direct deposit of payroll, recurring bill payments, online purchases, and person-to-person transfers.

How does it work?

The ACH Origination process starts with a payment or collection request made by a financial institution or client (business or individual). In the request, the payment method (SEC code) and transaction type (credit or debit) must be defined. The API automatically assigns the effective date and other data, like the trace number.

You get a trace number after you initiate an ACH transaction. The trace number is a unique identifier for an ACH transaction generated by the API. The trace number is useful for transaction inquiries and traceability. Save this trace number if you intend to check on the progress of the ACH transaction. For multiple payment requests, the trace number may not be in sequential order.

A request generates a batch response that includes the status and payment details by SEC code. For the consolidation, we store records from the batch, detail, and addenda schemas. You can include up to ten accounts with each request. For each submitted request, you can check on the status and progress of the payment or addenda report.

Except for TEL type transaction, all the SEC code types can include addenda information with the response. If an addenda item returns a large set of records (common with CTX), it initiates the addenda request. This request adds additional addenda records to a detail item. Currently, only details that are associated to a batch having a CTX SEC code can have additional addenda records added.

API requirements

UUID: UUID stands for Universally Unique Identifier. This is a useful attribute to recall a transaction before the next batch cycle runs. Since the UUID field is required to undo an ACH payment request, KeyBank strongly encourages the UUID is included with all ACH Origination calls.

The batch and the individual UUID can be the same, but KeyBank recommends that you use different UUID values.

Client information values: After you have completed the onboarding process with KeyBank, KeyBank provides the client (point) and client account (collectionApplicationId, collectionApplicationType) information via secure email. These fields are required for any ACH Origination call with a SEC code.

SEC code: In the request payload, you must specify the Standard Entry Class (SEC) code for the transaction. The ACH Origination API supports these SEC codes: CCD, CTX, PPD, TEL, WEB. Review the details on SEC codes in our user guide.

Health check

get /ach/payments/v1/healthCheck

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

Responses

Successful response

NAME	TYPE	DESCRIPTION
Statusoptional	string	The status of the health check response.
Sourceoptional	string	The origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
Timestampoptional	string	The date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIpoptional	string	The client IP address the gateway receives from the request.
X-Forwarded-Foroptional	string	The sequence of the IP addresses for systems 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]"
}

Check the status of a payment request

post /ach/payments/v1/status

Check the return status of one or more transactions. Use this request to see if the originated item failed, was accepted, is waiting for one or more addenda items, or is being processed.

Request

BODY FIELD	TYPE	DESCRIPTION
detailStatusoptional	array	paymentInquiryDetailRequest

Request example

{
    "detailStatus": [
        {
            "uuid": "qas220602x-49eb-47664-b94rhd1-e52e2re11001"
        }
    ]
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
detailsoptional	array	detailStatusResponse

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Check the status of addenda records

post /ach/payments/v1/status/addenda

Check the return status of one or more addenda records

Request

BODY FIELD	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
pageSizeoptional	string	The number of records to be returned in the pagination search.
startAddendaSequenceNumberoptional	string	The starting number for the addenda record sequence.

Request example

{
    "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001",
    "pageSize": "10",
    "startAddendaSequenceNumber": "0001"
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
uuidoptional	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusoptional	string	The status of the batch can be accepted or rejected.
errorMessagesoptional	array	detailMessage
traceNumberoptional	string	The unique number for the ACH transaction. Record this number for possible ACH inquiry requests.
informationMessagesoptional	array	detailMessage
addendaoptional	array	baseAddendaDetailResponse

Response example (200)

{
    "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001",
    "status": "accepted",
    "traceNumber": "041001030009004",
    "informationMessages": [
        {
            "code": "1002040-50I",
            "moreInfo": "All addenda have been received."
        }
    ],
    "errorMessages": [],
    "addenda": [
        {
            "addendaTypeCode": "05",
            "addendaSequenceNumber": "0001",
            "paymentRelatedInformation": "Undo WEB PAYMENT GOOD ITEM"
        }
    ]
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Send or collect a payment

post /ach/payments/v1/ccd

Make or collect payments to a corporate account. This call originates an ACH transaction for SEC code CCD (Corporate Credit or Debit). Use this request to send or collect cash, debit, or credit transactions between the buyer and seller financial institution accounts. This can also be used by companies to move funds and deposit to a central bank account.

Request

BODY FIELD	TYPE	DESCRIPTION
batchrequired	Object	batchRequestCCDDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

Request example

{
    "batch": {
        "collectionApplicationId": "TEST",
        "point": "APITEST1",
        "secCode": "CCD",
        "uuid": "daily001-qas230109-010300-005",
        "collectionApplicationType": "",
        "effectiveDate": "230211",
        "companyDescriptiveDate": "230211",
        "companyEntryDescription": "Payroll",
        "details": [
            {
                "DFIAccountNumber": "123456",
                "accountType": "C",
                "amount": "0.01",
                "checkDigit": "9",
                "creditDebitCode": "C",
                "receivingCompanyName": "ProdTest001",
                "receivingDFIId": "04100103",
                "transactionType": "L",
                "uuid": "daily001-qas230109-010301-0026",
                "identificationNumber": "099999999a",
                "discretionaryData": "AB",
                "addenda": [
                    {
                        "paymentRelatedInformation": "DAILYTEST0103A"
                    }
                ]
            }
        ]
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
batchrequired	Object	acceptedBatchResponseAcceptedDetailResponse

Response example (200)

{
    "batch": {
        "uuid": "daily001-qas230109-010300-005",
        "status": "accepted",
        "requestAcceptedUTCTime": "2023-05-03T17:04:03Z",
        "effectiveDate": "230211",
        "informationMessages": [
            {
                "code": "1006040-65I",
                "moreInfo": "Effective date assigned 230211."
            }
        ],
        "errorMessages": [],
        "details": [
            {
                "uuid": "daily001-qas230109-010301-0026",
                "status": "accepted",
                "errorMessages": [],
                "informationMessages": [],
                "traceNumber": "041001030013025",
                "requestAcceptedUTCTime": "2023-05-03T17:04:03Z"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Make or collect payments to or from a corporate account with attached records

post /ach/payments/v1/ctx

Submit or collect a payment from one business/entity to another. This call originates an ACH transaction for SEC code CTX (Corporate Trade Exchange). Use this request to send or collect an electronic payment with remittance information.

Request

BODY FIELD	TYPE	DESCRIPTION
batchrequired	Object	batchRequestCTXDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

Request example

{
    "batch": {
        "collectionApplicationId": "TEST2",
        "point": "APITEST1",
        "secCode": "CTX",
        "uuid": "test3c377-bat338-ctxf-bcd6fehdd0-031103",
        "collectionApplicationType": "",
        "effectiveDate": "230411",
        "companyDescriptiveDate": "230411",
        "companyEntryDescription": "Payroll",
        "details": [
            {
                "DFIAccountNumber": "111011",
                "accountType": "S",
                "checkDigit": "0",
                "creditDebitCode": "C",
                "numberOfAddendaRecords": "1",
                "receivingCompanyNameIDNumber": "YourTest301",
                "receivingDFIId": "06100001",
                "totalAmount": "1.31",
                "transactionType": "L",
                "uuid": "test3c377-det338-ctxf-dcd6fehdd0-030104",
                "identificationNumber": "099999999",
                "discretionaryData": "AK",
                "addenda": [
                    {
                        "paymentRelatedInformation": "YourTest03.01"
                    }
                ]
            }
        ]
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
batchrequired	Object	acceptedBatchResponseAcceptedDetailResponse

Response example (200)

{
    "batch": {
        "uuid": "test3c377-bat338-ctxf-bcd6fehdd0-031103",
        "status": "accepted",
        "requestAcceptedUTCTime": "2023-05-03T17:06:02Z",
        "effectiveDate": "230411",
        "informationMessages": [
            {
                "code": "1006040-65I",
                "moreInfo": "Effective date assigned 230411."
            }
        ],
        "errorMessages": [],
        "details": [
            {
                "uuid": "test3c377-det338-ctxf-dcd6fehdd0-030104",
                "status": "accepted",
                "errorMessages": [],
                "informationMessages": [],
                "traceNumber": "041001030013026",
                "requestAcceptedUTCTime": "2023-05-03T17:06:02Z"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Make deposits and withdrawals to or from consumer accounts

post /ach/payments/v1/ppd

Submit or collect a payment based on consumer authorization and terms of service. This call originates an ACH transaction for SEC code PPD (Prearranged Payments and Debits). Use this request to send or collect a routine electronic payment, like a subscription or monthly payment plan.

Request

BODY FIELD	TYPE	DESCRIPTION
batchrequired	Object	batchRequestPPDDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

Request example

{
    "batch": {
        "collectionApplicationId": "TEST",
        "point": "APITEST1",
        "secCode": "PPD",
        "uuid": "qas22517-4d3338-4c6f-bcd6fehdd0-1234360",
        "collectionApplicationType": "",
        "effectiveDate": "230211",
        "companyDescriptiveDate": "230211",
        "companyEntryDescription": "Payroll",
        "details": [
            {
                "DFIAccountNumber": "123456789",
                "accountType": "S",
                "amount": "520.25",
                "checkDigit": "9",
                "creditDebitCode": "C",
                "individualName": "QASTest005",
                "receivingDFIId": "04100103",
                "transactionType": "L",
                "uuid": "qas220330A-49eb-47664-b94rhd1-12361",
                "individualIdentificationNumber": "099999999a",
                "discretionaryData": "AB",
                "addenda": [
                    {
                        "paymentRelatedInformation": "QASTest02.02A"
                    }
                ]
            },
            {
                "DFIAccountNumber": "234567891",
                "accountType": "S",
                "amount": "0.00",
                "checkDigit": "2",
                "creditDebitCode": "C",
                "individualName": "QASTest006",
                "receivingDFIId": "24107121",
                "transactionType": "P",
                "uuid": "qas220330A-49eb-47664-b94rhd1-12362",
                "individualIdentificationNumber": "099999999b",
                "discretionaryData": "BC"
            },
            {
                "DFIAccountNumber": "345678912",
                "accountType": "S",
                "amount": "1794.91",
                "checkDigit": "2",
                "creditDebitCode": "D",
                "individualName": "QASTest006",
                "receivingDFIId": "24107121",
                "transactionType": "L",
                "uuid": "qas220330A-49eb-47664-b94rhd1-12363",
                "individualIdentificationNumber": "099999999c",
                "discretionaryData": "BC",
                "addenda": [
                    {
                        "paymentRelatedInformation": "QASTest02.02C"
                    }
                ]
            }
        ]
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
batchrequired	Object	acceptedBatchResponseAcceptedDetailResponse

Response example (200)

{
    "batch": {
        "uuid": "qas22517-4d3338-4c6f-bcd6fehdd0-1234360",
        "status": "accepted",
        "requestAcceptedUTCTime": "2023-05-03T17:08:45Z",
        "effectiveDate": "230211",
        "informationMessages": [
            {
                "code": "1006040-65I",
                "moreInfo": "Effective date assigned 230211."
            }
        ],
        "errorMessages": [],
        "details": [
            {
                "uuid": "qas220330A-49eb-47664-b94rhd1-12361",
                "status": "accepted",
                "errorMessages": [],
                "informationMessages": [],
                "traceNumber": "041001030012784",
                "requestAcceptedUTCTime": "2023-05-03T17:08:45Z"
            },
            {
                "uuid": "qas220330A-49eb-47664-b94rhd1-12362",
                "status": "accepted",
                "errorMessages": [],
                "informationMessages": [],
                "traceNumber": "041001030012785",
                "requestAcceptedUTCTime": "2023-05-03T17:08:45Z"
            },
            {
                "uuid": "qas220330A-49eb-47664-b94rhd1-12363",
                "status": "accepted",
                "errorMessages": [],
                "informationMessages": [],
                "traceNumber": "041001030012786",
                "requestAcceptedUTCTime": "2023-05-03T17:08:45Z"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Send a payment over the phone

post /ach/payments/v1/tel

Authorize and submit a payment by the phone.

Request

BODY FIELD	TYPE	DESCRIPTION
batchrequired	Object	batchRequestTELDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

Request example

{
    "batch": {
        "collectionApplicationId": "TEST",
        "point": "APITEST1",
        "secCode": "TEL",
        "uuid": "qas22523-4d3338-4c6f-bcd6fehdd0-12349",
        "collectionApplicationType": "",
        "effectiveDate": "230211",
        "companyDescriptiveDate": "230211",
        "companyEntryDescription": "Payroll",
        "details": [
            {
                "DFIAccountNumber": "1234567890123452",
                "accountType": "C",
                "amount": "5963.88",
                "checkDigit": "0",
                "creditDebitCode": "D",
                "individualName": "QASTest014",
                "receivingDFIId": "06100001",
                "transactionType": "L",
                "uuid": "qas22523-f76-44eb-a7014041047",
                "individualIdentificationNumber": "099999999",
                "paymentTypeCode": "R"
            }
        ]
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
batchrequired	Object	acceptedBatchResponseAcceptedDetailResponse

Response example (200)

{
    "batch": {
        "uuid": "qas22523-4d3338-4c6f-bcd6fehdd0-12349",
        "status": "accepted",
        "requestAcceptedUTCTime": "2023-05-03T17:10:58Z",
        "effectiveDate": "230211",
        "informationMessages": [
            {
                "code": "1006040-65I",
                "moreInfo": "Effective date assigned 230211."
            }
        ],
        "errorMessages": [],
        "details": [
            {
                "uuid": "qas22523-f76-44eb-a7014041047",
                "status": "accepted",
                "errorMessages": [],
                "informationMessages": [],
                "traceNumber": "041001030013030",
                "requestAcceptedUTCTime": "2023-05-03T17:10:58Z"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Send an online payment

post /ach/payments/v1/web

Authorize and submit a payment on a website.

Request

BODY FIELD	TYPE	DESCRIPTION
batchrequired	Object	batchRequestWEBDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

Request example

{
    "batch": {
        "collectionApplicationId": "TEST",
        "point": "APITEST1",
        "secCode": "WEB",
        "uuid": "qas22523-4d3338-4c6f-bcd6fehdd0-41033",
        "collectionApplicationType": "",
        "effectiveDate": "230211",
        "companyDescriptiveDate": "",
        "companyEntryDescription": "Payroll",
        "details": [
            {
                "DFIAccountNumber": "123546789",
                "accountType": "C",
                "amount": "0.00",
                "checkDigit": "0",
                "creditDebitCode": "D",
                "individualName": "QASTest014",
                "receivingDFIId": "06100001",
                "transactionType": "P",
                "uuid": "qas22523-f76-44eb-a7014041034",
                "individualIdentificationNumber": "099999999",
                "paymentTypeCode": "R",
                "addenda": [
                    {
                        "paymentRelatedInformation": "DAILYTEST0103A"
                    }
                ]
            }
        ]
    }
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
batchrequired	Object	acceptedBatchResponseAcceptedDetailResponse

Response example (200)

{
    "batch": {
        "uuid": "qas22523-4d3338-4c6f-bcd6fehdd0-41033",
        "status": "accepted",
        "requestAcceptedUTCTime": "2023-05-03T17:13:45Z",
        "effectiveDate": "230211",
        "informationMessages": [
            {
                "code": "1006040-65I",
                "moreInfo": "Effective date assigned 230211."
            }
        ],
        "errorMessages": [],
        "details": [
            {
                "uuid": "qas22523-f76-44eb-a7014041034",
                "status": "accepted",
                "errorMessages": [],
                "informationMessages": [],
                "traceNumber": "041001030012787",
                "requestAcceptedUTCTime": "2023-05-03T17:13:45Z"
            }
        ]
    }
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Undo a payment request

post /ach/payments/v1/undo

Reverse a payment request before it enters consolidation.

Request

BODY FIELD	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.

Request example

{
    "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001"
}

Responses

Successful response

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusoptional	string	The status of a batch record can be accepted or rejected. The status of a detailed record can be deleted, accepted, rejected, notFound, or waitingForAddenda.
errorMessagesoptional	array	detailMessage
informationMessagesoptional	array	detailMessage
traceNumberoptional	string	The unique number for the ACH transaction. Record this number for possible ACH inquiry requests.

Response example (200)

{
    "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001",
    "status": "accepted",
    "errorMessages": [
        {
            "code": "1006040-651"
        },
        {
            "moreInfo": "Effective date assigned 220411"
        }
    ],
    "informationMessages": [
        {
            "code": "1006040-651"
        },
        {
            "moreInfo": "Effective date assigned 220411"
        }
    ],
    "traceNumber": "041001030008013"
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Send additional addenda information

post /ach/payments/v1/addenda

Add records to an existing ACH transaction.

Request

BODY FIELD	TYPE	DESCRIPTION
addendarequired	array	addendaRequest
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.

Request example

{
    "addenda": [
        {
            "paymentRelatedInformation": "0410*820412***PER*AP*QAS TESTING*IT*N1*PR*THE QAS COMPANY*         0",
            "addendaSequenceNumber": "002"
        },
        {
            "paymentRelatedInformation": "3*ROUTE 1234*BOX 1234\\N5*TESTING*",
            "addendaSequenceNumber": "003"
        },
        {
            "paymentRelatedInformation": "TM*003*820311\\RMT*IV*0302892**252640\\DTM*003*820315\\RMT*IV*0302960**593835\\",
            "addendaSequenceNumber": "004"
        }
    ],
    "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001"
}

Responses

Successfully staged ACH file data into ACH Origination API.

NAME	TYPE	DESCRIPTION
uuidoptional	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusoptional	string	The overall status of the addenda request can be accepted or rejected.
traceNumberoptional	string	The unique number for the ACH transaction. Record this number for possible ACH inquiry requests.
informationMessagesoptional	array	detailMessage
errorMessagesoptional	array	detailMessage
addendaoptional	array	addendaResponse
requestAcceptedUTCTimeoptional	string	The date and time the request was accepted in UTC time. Format: YYYY-MM-DDTHH:MM:SSZ

Response example (200)

{
    "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001",
    "status": "accepted",
    "traceNumber": "41001030008011",
    "informationMessages": [
        {
            "code": "1002040-50II",
            "moreInfo": "All addenda have been received."
        }
    ],
    "errorMessages": [],
    "addenda": [
        {
            "status": "accepted",
            "errorMessages": [],
            "informationMessages": []
        }
    ],
    "requestAcceptedUTCTime": "2022-05-25T16:33:46Z"
}

Missing mandatory information

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (400)

{
    "ErrorMessage": "Mandatory data not provided, please verify the data and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unauthorized request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (401)

{
    "ErrorMessage": "Received request is unauthorized, please provide valid credentials",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Forbidden request access

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (403)

{
    "ErrorMessage": "Access to requested resource is forbidden",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Resource not found

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (404)

{
    "ErrorMessage": "Requested resource is not found, please verify the resource then resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request method

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (405)

{
    "ErrorMessage": "Requested method is not allowed, please verify the method and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Invalid request type

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (415)

{
    "ErrorMessage": "Requested media type is not allowed, please verify the media type and resubmit the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Request timeout

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (429)

{
    "ErrorMessage": "Number requests threshold reached, please resubmit the request after sometime",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Unknown error

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (500)

{
    "ErrorMessage": "Runtime error occurred in the service, please check with application support team before resubmitting the request",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z"
}

Bad gateway

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (502)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "ServiceError": {
        "ConnectError": "Connectivity error occurred with the downstream service (Unexpected EOF at target), please check with application support team before resubmitting the request"
    }
}

Unavailable service

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (503)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Service is currently unavailable (NoActiveTargets), please check with application support before resubmitting the request."
    }
}

Unable to process request

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

Response example (504)

{
    "ErrorMessage": "Error received from backend",
    "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1",
    "X-CorrelationId": "929618f2-6163-bf73-51b0-6c54a8533c74",
    "TransactionTime": "2021-06-11T16:31:34.041Z",
    "ServiceError": {
        "ConnectError": "Request could not be processed on time (GatewayTimeout), please wait a moment and resubmit the request."
    }
}

Schemas

healthResponse

NAME	TYPE	DESCRIPTION
Statusoptional	string	The status of the health check response.
Sourceoptional	string	The origin of the system response can be 'Gateway' or 'Roundtrip'. Roundtrip returns a response from the farthest system involved.
Timestampoptional	string	The date (YYYY-MM-DD) and time (HH:MM:SS) of response from the API service.
ClientIpoptional	string	The client IP address the gateway receives from the request.
X-Forwarded-Foroptional	string	The sequence of the IP addresses for systems between the client and the gateway.

exception

NAME	TYPE	DESCRIPTION
ErrorMessageoptional	string	Error message related to system generating this error.
TransactionIdoptional	string	Unique functional identifier from the data to identify a message.
X-CorrelationIdoptional	string	A unique identifier generated for each transaction that remains with the transaction through the chain of API operations.
TransactionTimeoptional	string	Time of the occurrence of the error of the message.
ServiceErroroptional	oneOf	detailMessage connectError

connectError

NAME	TYPE	DESCRIPTION
ConnectErroroptional	string	Error information of the connectivity with downstream service.

acceptedAddendaResponseEnvelope

NAME	TYPE	DESCRIPTION
uuidoptional	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusoptional	string	The overall status of the addenda request can be accepted or rejected.
traceNumberoptional	string	The unique number for the ACH transaction. Record this number for possible ACH inquiry requests.
informationMessagesoptional	array	detailMessage
errorMessagesoptional	array	detailMessage
addendaoptional	array	addendaResponse
requestAcceptedUTCTimeoptional	string	The date and time the request was accepted in UTC time. Format: YYYY-MM-DDTHH:MM:SSZ

acceptedBatchResponseAcceptedDetailResponse

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusrequired	string	The status of the batch can be accepted or rejected.
requestAcceptedUTCTimeoptional	string	The date and time the request was accepted in UTC time. Format: YYYY-MM-DDTHH:MM:SSZ
effectiveDateoptional	string	The date the transaction is posted. This date must be within 31 days of the current date. Format: YYMMDD
informationMessagesoptional	array	detailMessage
errorMessagesoptional	array	detailMessage
detailsoptional	array	acceptedDetailResponse

acceptedDetailResponse

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusoptional	string	The overall status of the addenda can be accepted or rejected.
errorMessagesoptional	array	detailMessage
informationMessagesoptional	array	detailMessage
traceNumberoptional	string	The unique number for the ACH transaction. Record this number for possible ACH inquiry requests.
requestAcceptedUTCTimeoptional	string	The date and time the request was accepted in UTC time. Format: YYYY-MM-DDTHH:MM:SSZ

addendaRequest

NAME	TYPE	DESCRIPTION
paymentRelatedInformationrequired	string	The related payment information for the addenda records. The limit is 80 characters.
addendaSequenceNumberrequired	string	The sequence number of the addenda. The number cannot exceed 4 digits.

addendaRequestEnvelope

NAME	TYPE	DESCRIPTION
addendarequired	array	addendaRequest
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.

addendaResponse

NAME	TYPE	DESCRIPTION
statusoptional	string	The overall status of the addenda request can be accepted or rejected.
errorMessagesoptional	array	detailMessage
informationMessagesoptional	array	detailMessage

addendaStatusRequestEnvelope

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
pageSizeoptional	string	The number of records to be returned in the pagination search.
startAddendaSequenceNumberoptional	string	The starting number for the addenda record sequence.

addendaStatusResponseEnvelope

NAME	TYPE	DESCRIPTION
uuidoptional	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusoptional	string	The status of the batch can be accepted or rejected.
errorMessagesoptional	array	detailMessage
traceNumberoptional	string	The unique number for the ACH transaction. Record this number for possible ACH inquiry requests.
informationMessagesoptional	array	detailMessage
addendaoptional	array	baseAddendaDetailResponse

baseAddendaDetailResponse

NAME	TYPE	DESCRIPTION
addendaTypeCodeoptional	string	The type code for the addenda. The value is '05'.
addendaSequenceNumberoptional	string	The sequence number of the addenda. The number cannot exceed 4 digits.
paymentRelatedInformationoptional	string	The related payment information from the addenda records. The maximum character limit is 80.

baseAddendaRequest

NAME	TYPE	DESCRIPTION
paymentRelatedInformationrequired	string	The related payment information for the addenda records. The limit is 80 characters.

baseDetailResponse

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusoptional	string	The status of a batch record can be accepted or rejected. The status of a detailed record can be deleted, accepted, rejected, notFound, or waitingForAddenda.
errorMessagesoptional	array	detailMessage
informationMessagesoptional	array	detailMessage
traceNumberoptional	string	The unique number for the ACH transaction. Record this number for possible ACH inquiry requests.

batchRequestCCDDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
pointrequired	string	A short name specific to your company provided by KeyBank. This is included in the file name and improves security for file transfers.
collectionApplicationIdrequired	string	This ID is provided by KeyBank and cannot exceed the maximum of 9 alphanumeric characters.
collectionApplicationTypeoptional	string	A subset of the collection application parameters. This is not commonly used and by default, left blank. If there is a collection application type, the value is provided by KeyBank during onboarding and cannot exceed 6 characters.
secCoderequired	string	The three-digit Standard Entry Class code based on Nacha rules. Valid values: CCD, CTX, PPD, TEL, WEB.
effectiveDateoptional	string	The date the transaction is posted. This date must be within 31 days of the current date. Format: YYMMDD
companyDescriptiveDateoptional	string	Company descriptive date. Format: YYMMDD
companyEntryDescriptionrequired	string	Provides the receiver a description of the payment purpose. The value cannot exceed 10 characters and cannot be blank. Possible values: 'REVERSAL', 'RETURN FEE', 'RECLAIM', 'REDEPCHECK' for RCK entries, 'HCCLAIMPMT' for Health Care EFTs, or 'ACCTVERIFY' for clients sending in a micro-entry as a type of ACH entry.
detailsoptional	array	cCDDetailRequest

batchRequestCTXDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
pointrequired	string	A short name specific to your company provided by KeyBank. This is included in the file name and improves security for file transfers.
collectionApplicationIdrequired	string	This ID is provided by KeyBank and cannot exceed the maximum of 9 alphanumeric characters.
collectionApplicationTypeoptional	string	A subset of the collection application parameters. This is not commonly used and by default, left blank. If there is a collection application type, the value is provided by KeyBank during onboarding and cannot exceed 6 characters.
secCoderequired	string	The three-digit Standard Entry Class code based on Nacha rules. Valid values: CCD, CTX, PPD, TEL, WEB.
effectiveDateoptional	string	The date the transaction is posted. This date must be within 31 days of the current date. Format: YYMMDD
companyDescriptiveDateoptional	string	Company descriptive date. Format: YYMMDD
companyEntryDescriptionrequired	string	Provides the receiver a description of the payment purpose. The value cannot exceed 10 characters and cannot be blank. Possible values: 'REVERSAL', 'RETURN FEE', 'RECLAIM', 'REDEPCHECK' for RCK entries, 'HCCLAIMPMT' for Health Care EFTs, or 'ACCTVERIFY' for clients sending in a micro-entry as a type of ACH entry.
detailsoptional	array	cTXDetailRequest

batchRequestEnvelopeBatchRequestCCDDetailRequest

NAME	TYPE	DESCRIPTION
batchrequired	Object	batchRequestCCDDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

batchRequestEnvelopeBatchRequestCTXDetailRequest

NAME	TYPE	DESCRIPTION
batchrequired	Object	batchRequestCTXDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

batchRequestEnvelopeBatchRequestPPDDetailRequest

NAME	TYPE	DESCRIPTION
batchrequired	Object	batchRequestPPDDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

batchRequestEnvelopeBatchRequestTELDetailRequest

NAME	TYPE	DESCRIPTION
batchrequired	Object	batchRequestTELDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

batchRequestEnvelopeBatchRequestWEBDetailRequest

NAME	TYPE	DESCRIPTION
batchrequired	Object	batchRequestWEBDetailRequest
customDataoptional	string	The values for custom data is defined by the client. This free-form text field can contain up to 500 alphanumeric characters. Custom information stays with the transaction through its lifecycle.

batchRequestPPDDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
pointrequired	string	A short name specific to your company provided by KeyBank. This is included in the file name and improves security for file transfers.
collectionApplicationIdrequired	string	This ID is provided by KeyBank and cannot exceed the maximum of 9 alphanumeric characters.
collectionApplicationTypeoptional	string	A subset of the collection application parameters. This is not commonly used and by default, left blank. If there is a collection application type, the value is provided by KeyBank during onboarding and cannot exceed 6 characters.
secCoderequired	string	The three-digit Standard Entry Class code based on Nacha rules. Valid values: CCD, CTX, PPD, TEL, WEB.
effectiveDateoptional	string	The date the transaction is posted. This date must be within 31 days of the current date. Format: YYMMDD
companyDescriptiveDateoptional	string	Company descriptive date. Format: YYMMDD
companyEntryDescriptionrequired	string	Provides the receiver a description of the payment purpose. The value cannot exceed 10 characters and cannot be blank. Possible values: 'REVERSAL', 'RETURN FEE', 'RECLAIM', 'REDEPCHECK' for RCK entries, 'HCCLAIMPMT' for Health Care EFTs, or 'ACCTVERIFY' for clients sending in a micro-entry as a type of ACH entry.
detailsoptional	array	pPDDetailRequest

batchRequestTELDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
pointrequired	string	A short name specific to your company provided by KeyBank. This is included in the file name and improves security for file transfers.
collectionApplicationIdrequired	string	This ID is provided by KeyBank and cannot exceed the maximum of 9 alphanumeric characters.
collectionApplicationTypeoptional	string	A subset of the collection application parameters. This is not commonly used and by default, left blank. If there is a collection application type, the value is provided by KeyBank during onboarding and cannot exceed 6 characters.
secCoderequired	string	Standard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules.
effectiveDateoptional	string	The date the transaction is posted. This date must be within 31 days of the current date. Format: YYMMDD
companyDescriptiveDateoptional	string	Company descriptive date. Format: YYMMDD
companyEntryDescriptionrequired	string	Provides the receiver a description of the payment purpose. The value cannot exceed 10 characters and cannot be blank. Possible values: 'REVERSAL', 'RETURN FEE', 'RECLAIM', 'REDEPCHECK' for RCK entries, 'HCCLAIMPMT' for Health Care EFTs, or 'ACCTVERIFY' for clients sending in a micro-entry as a type of ACH entry.
detailsoptional	array	telDetailRequest

batchRequestWEBDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
pointrequired	string	A short name specific to your company provided by KeyBank. This is included in the file name and improves security for file transfers.
collectionApplicationIdrequired	string	This ID is provided by KeyBank and cannot exceed the maximum of 9 alphanumeric characters.
collectionApplicationTypeoptional	string	A subset of the collection application parameters. This is not commonly used and by default, left blank. If there is a collection application type, the value is provided by KeyBank during onboarding and cannot exceed 6 characters.
secCoderequired	string	The three-digit Standard Entry Class code based on Nacha rules. Valid values: CCD, CTX, PPD, TEL, WEB.
effectiveDateoptional	string	The date the transaction is posted. This date must be within 31 days of the current date. Format: YYMMDD
companyDescriptiveDateoptional	string	Company descriptive date. Format: YYMMDD
companyEntryDescriptionrequired	string	Provides the receiver a description of the payment purpose. The value cannot exceed 10 characters and cannot be blank. Possible values: 'REVERSAL', 'RETURN FEE', 'RECLAIM', 'REDEPCHECK' for RCK entries, 'HCCLAIMPMT' for Health Care EFTs, or 'ACCTVERIFY' for clients sending in a micro-entry as a type of ACH entry.
detailsoptional	array	webDetailRequest

batchResponseEnvelopeAccepted

NAME	TYPE	DESCRIPTION
batchrequired	Object	acceptedBatchResponseAcceptedDetailResponse

cCDDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
accountTyperequired	string	The account type can be checking (C) or savings (S). Valid values: C, S.
creditDebitCoderequired	string	One-character field indicates if the ACH transaction is a credit (C) or debit (D). Valid values: C, D.
transactionTyperequired	string	Nacha-defined transaction types can be live (L), prenote (P), or zero (Z). Valid values: L, P, Z.
receivingDFIIdrequired	string	The bank routing number (ABA number) of the receiving designated financial institution. The number can be a maximum of 8 digits.
checkDigitrequired	string	The final character of a routing number that can be used to validate a specific routing number. This is a single digit.
DFIAccountNumberrequired	string	The recipient account number at the designated financial institution. The account number can be a maximum of 17 characters.
amountrequired	string	The transaction amount in valid currency format. The amount can have up to 8 digits before the decimal and 2 digits after the decimal.
identificationNumberoptional	string	Identification number for the detail record. The number cannot exceed 15 characters.
receivingCompanyNamerequired	string	The name of the receiving company. The name cannot exceed a maximum of 22 characters.
discretionaryDataoptional	string	Further identification of the company or used to describe the type of entries being processed. The ID can be a maximum of 2 characters.
addendaoptional	array	baseAddendaRequest

cTXDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
accountTyperequired	string	The account type can be checking (C) or savings (S). Valid values: C, S.
creditDebitCoderequired	string	One-character field indicates if the ACH transaction is a credit (C) or debit (D). Valid values: C, D
transactionTyperequired	string	Nacha-defined transaction types can be live (L), prenote (P), or zero (Z). Valid values: L, P, Z
receivingDFIIdrequired	string	The bank routing number (ABA number) of the receiving designated financial institution. The number can be a maximum of 8 digits.
checkDigitrequired	string	The final character of a routing number that can be used to validate a specific routing number. This is a single digit.
DFIAccountNumberrequired	string	The recipient account number at the designated financial institution. The account number can be a maximum of 17 characters.
totalAmountrequired	string	The total amount of the transactions in valid currency format. The amount can have up to 8 digits before the decimal and 2 digits after the decimal.
identificationNumberoptional	string	Identification number for the detail record. The number cannot exceed 15 characters.
numberOfAddendaRecordsrequired	string	Count of addenda records. This cannot exceed 4 digits.
receivingCompanyNameIDNumberrequired	string	The name and ID of the receiving company. This field cannot exceed 16 characters.
discretionaryDataoptional	string	Further identification of the company or used to describe the type of entries being processed. The ID can be a maximum of 2 characters.
addendaoptional	array	baseAddendaRequest

detailMessage

NAME	TYPE	DESCRIPTION
codeoptional	string	A static status code assigned by the network or payment system.
moreInfooptional	string	Detailed descriptive message.

detailStatusRequestEnvelopePaymentInquiryDetailRequest

NAME	TYPE	DESCRIPTION
detailStatusoptional	array	paymentInquiryDetailRequest

detailStatusResponse

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
statusoptional	string	The status of the batch tells if data is valid, contains errors, or has been received by the ACH core processing system. Valid values: accepted, rejected, extracted
errorMessagesoptional	array	detailMessage
informationMessagesoptional	array	detailMessage
traceNumberoptional	string	The unique number for the ACH transaction. Record this number for possible ACH inquiry requests.
requestAcceptedUTCTimeoptional	string	The date and time the request was accepted in UTC time. Format: YYYY-MM-DDTHH:MM:SSZ
requestDeletedUTCTimeoptional	string	The date and time the request was deleted in UTC time. Format: YYYY-MM-DDTHH:MM:SSZ
requestLastUpdatedUTCTimeoptional	string	The date and time the request was updated in UTC time. Format: YYYY-MM-DDTHH:MM:SSZ
pointoptional	string	A short name specific to your company provided by KeyBank. This is included in the file name and improves security for file transfers.
collectionApplicationIdoptional	string	This ID is provided by KeyBank and cannot exceed the maximum of 9 alphanumeric characters.
collectionApplicationTypeoptional	string	A subset of the collection application parameters. This is not commonly used and by default, left blank. If there is a collection application type, the value is provided by KeyBank during onboarding and cannot exceed 6 characters.
secCodeoptional	string	The three-digit Standard Entry Class code based on Nacha rules. Valid values: CCD, CTX, PPD, TEL, WEB.
effectiveDateoptional	string	The date the transaction is posted. This date must be within 31 days of the current date. Format: YYMMDD
companyDescriptiveDateoptional	string	Company descriptive date. Format: YYMMDD
batchNumberoptional	string	The number associated with the batch. It can be a maximum of 7 digits.
companyNameoptional	string	The name of the corporation or institution making the request. The name cannot exceed 16 characters or have spaces.
companyDiscretionaryDataoptional	string	Discretionary data for the company.
companyIdentificationoptional	string	The identification number of the company. This cannot exceed 15 digits.
companyEntryDescriptionoptional	string	Provides the receiver a description of the payment purpose. The value cannot exceed 10 characters and cannot be blank. Possible values: 'REVERSAL', 'RETURN FEE', 'RECLAIM', 'REDEPCHECK' for RCK entries, 'HCCLAIMPMT' for Health Care EFTs, or 'ACCTVERIFY' for clients sending in a micro-entry as a type of ACH entry.
originatingDFIIdoptional	string	The bank routing number (ABA number) of the originating designated financial institution. The number can be a maximum of 8 digits.
accountTypeoptional	string	The account type can be checking (C) or savings (S). Valid values: C, S.
creditDebitCodeoptional	string	One-character field indicates if the ACH transaction is a credit (C) or debit (D). Valid values: C, D.
transactionTypeoptional	string	Nacha-defined transaction types can be live (L), prenote (P), or zero (Z). Valid values: L, P, Z
transactionCodeoptional	string	A two-character field that specifies the billing credit transaction code.
receivingDFIIdoptional	string	The bank routing number (ABA number) of the receiving designated financial institution. The number can be a maximum of 8 digits.
checkDigitoptional	string	The final character of a routing number that can be used to validate a specific routing number. This is a single digit.
dfiAccountNumberoptional	string	The recipient account number at the recipient's bank.
amountoptional	string	The transaction amount in valid currency format. The amount can have up to 8 digits before the decimal and 2 digits after the decimal.
identificationNumberoptional	string	Identification number for the detail record. The number cannot exceed 15 characters.
receivingCompanyNameoptional	string	The name of the receiving company. The name cannot exceed a maximum of 22 characters.
discretionaryDataoptional	string	Further identification of the company or used to describe the type of entries being processed. The ID cannot exceed the maximum of 20 characters.
totalAmountoptional	string	The total amount of the transactions in valid currency format. The amount can have up to 8 digits before the decimal and 2 digits after the decimal.
receivingCompanyNameIDNumberoptional	string	The name and ID of the receiving company. This field cannot exceed 16 characters.
individualIdentificationNumberoptional	string	The ID number for the individual. This cannot exceed 15 characters.
individualNameoptional	string	The name of the individual. This cannot exceed 22 characters.
paymentTypeCodeoptional	string	The code is a maximum of four characters. This field returns two empty spaces if the code is not provided by the client.
numberOfAddendaRecordsoptional	string	Count of addenda records. This cannot exceed 4 digits.
numberOfAddendaReceivedoptional	string	Count of addenda records received.
addendaoptional	array	baseAddendaDetailResponse
fileCreationDateoptional	string	The date the file was created. Format: YYMMDD
fileCreationTimeoptional	string	The time the file was created.
fileIdModifieroptional	string	The file ID modifier to control the totals with a single alphanumeric value.

detailStatusResponseEnvelopeDetailStatusResponse

NAME	TYPE	DESCRIPTION
detailsoptional	array	detailStatusResponse

detailUndoRequestEnvelope

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.

pPDDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
accountTyperequired	string	The account type can be checking (C) or savings (S). Valid values: C, S.
creditDebitCoderequired	string	One-character field indicates if the ACH transaction is a credit (C) or debit (D). Valid values: C, D.
transactionTyperequired	string	Nacha-defined transaction types can be live (L), prenote (P), or zero (Z). Valid values: L, P, Z.
receivingDFIIdrequired	string	The bank routing number (ABA number) of the receiving designated financial institution. The number can be a maximum of 8 digits.
checkDigitrequired	string	The final character of a routing number that can be used to validate a specific routing number. This is a single digit.
DFIAccountNumberrequired	string	The recipient account number at the designated financial institution. The account number can be a maximum of 17 characters.
amountrequired	string	The transaction amount in valid currency format. The amount can have up to 8 digits before the decimal and 2 digits after the decimal.
individualNamerequired	string	The name of the individual. This cannot exceed 22 characters.
individualIdentificationNumberoptional	string	The ID number for the individual. This cannot exceed 15 characters.
discretionaryDataoptional	string	Further identification of the company or used to describe the type of entries being processed. The ID can be a maximum of 2 characters.
addendaoptional	array	baseAddendaRequest

paymentInquiryDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.

telDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
accountTyperequired	string	The account type can be checking (C) or savings (S). Valid values: C, S.
creditDebitCoderequired	string	One-character field indicates if the ACH transaction is a credit (C) or debit (D). Valid values: C, D.
transactionTyperequired	string	Nacha-defined transaction types can be live (L), prenote (P), or zero (Z). Valid values: L, P, Z.
receivingDFIIdrequired	string	The bank routing number (ABA number) of the receiving designated financial institution. The number can be a maximum of 8 digits.
checkDigitrequired	string	The final character of a routing number that can be used to validate a specific routing number. This is a single digit.
DFIAccountNumberrequired	string	The recipient account number at the designated financial institution. The account number can be a maximum of 17 characters.
amountrequired	string	The transaction amount in valid currency format. The amount can have up to 8 digits before the decimal and 2 digits after the decimal.
individualIdentificationNumberoptional	string	The ID number for the individual. This cannot exceed 15 characters.
individualNamerequired	string	The name of the individual. This cannot exceed 22 characters.
paymentTypeCodeoptional	string	The code is a maximum of two characters. The code is two empty spaces if the code is not provided by the client.

webDetailRequest

NAME	TYPE	DESCRIPTION
uuidrequired	string	A custom value used to identify each transaction. It is required to undo a payment. The ID must not exceed 45 alphanumeric characters.
accountTyperequired	string	The account type can be checking (C) or savings (S). Valid values: C, S
creditDebitCoderequired	string	One-character field indicates if the ACH transaction is a credit (C) or debit (D). Valid values: C, D
transactionTyperequired	string	Nacha-defined transaction types can be live (L), prenote (P), or zero (Z). Valid values: L, P, Z
receivingDFIIdrequired	string	The bank routing number (ABA number) of the receiving designated financial institution. The number can be a maximum of 8 digits.
checkDigitrequired	string	The final character of a routing number that can be used to validate a specific routing number. This is a single digit.
DFIAccountNumberrequired	string	The recipient account number at the designated financial institution. The account number can be a maximum of 17 characters.
amountrequired	string	The transaction amount in valid currency format. The amount can have up to 8 digits before the decimal and 2 digits after the decimal.
individualIdentificationNumberoptional	string	The ID number for the individual. This cannot exceed 15 characters.
individualNamerequired	string	The name of the individual. This cannot exceed 22 characters.
paymentTypeCodeoptional	string	The code is a maximum of two characters. The code is two empty spaces if the code is not provided by the client.
addendaoptional	array	baseAddendaRequest

Errors

For more information about errors, see Error handling.

Changelog

Release	API version	Change description	Impact
October 2024	1.3.2	Updated `companyEntryDescription` to include possible values like 'REVERSAL', 'RETURN FEE', 'RECLAIM', 'REDEPCHECK' for RCK entries, and 'HCCLAIMPMT' for health care EFTs, or 'ACCTVERIFY' for clients sending in micro-entry as a type of ACH entry.	LOW
May 2024	1.3.1	Changed the `effectiveDate` range for ACH payments from 90 days to 31 days. `X-CorrelationId` has been removed as a request header field for all endpoints. The parameter is no longer in the request body, but still remains in the code. The system assigns a unique ID when you submit a request and returns the value in the response.	MID
April 2024	1.3.0	Removed `X-Point` from all endpoints. This is an internal field and is not required for API requests.	LOW
September 2023	1.2.0	Added `customData` field to each of the SEC payment endpoints. You can enter up to 500 alphanumeric characters that will stay with the transaction through its lifecycle. Removed unused objects: `batchResponseEnvelopeRejected` `successSearchResponseNotificationEventResponse` `successResponseString` `successMetaResponse` `sortControl` `notifcationEventResponse` `messageResponse` `baseDataObject` `rejectedBatchResponseBaseDetailResponse` The `traceNumber` was updated to remove a reference to an internal database table, TBDACHDETAIL. `DFIAccountNumber` was updated to clarify that this is the recipient account number at the recipient’s bank. `receivingDFIID` was updated to clarify that this is the ABA of the recipient’s bank.	MID
May 2023	1.1.6	Added the require `companyEntryDescription` for each of the SEC payment endpoints. ACH requests will no longer have a default description. You can set the description for each transaction. This field returns in the ACH status response payload.	MID
December 2022	1.1.5	Released on the Developer Portal.

Impact levels

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

YAML file