Use the ACH Origination API to submit a payment. This API is more than a single action. With the ACH Origination API, you can submit a payment, check on its status, and undo a request.
Request a payment
The ACH Origination process starts with a payment request made by a financial institution or client. Request values are validated to make sure the input matches the correct schema for the SEC code. Effective date and other data, like the trace number, are automatically assigned. Records from the batch, detail, and addenda schemas are stored for the consolidation process.
This request generates a batch response that includes the status and payment details by SEC code. You can inquire on the status and progress of the request. If the request is successful, the payment request is accepted and processed. If the request is unsuccessful, an error message returns with additional details as to why there was an issue.
Addenda information
Each SEC code will include addenda information with the response, except for TEL. 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.
Prerequisites and best practices
KeyBank has some common prerequisites and best practices. All KeyBank APIs require certifications, user credentials, and certain permissions. Make sure to satisfy all prerequisites before building your API.
Follow these steps to prepare for operations:
-
Have valid certificates for a secure connection.
-
Make sure you have the API keys needed for basic authentication and API access.
-
Request a bearer token before you start.
-
Check the health of the API.
-
Create a UUID.
-
Have the required client information fields for calls using a SEC code, provided by KeyBank.
-
Know the SEC code.
-
Get a trace number.
Certificates
Certificates are a digital authentication method we use to encrypt the information exchanged between KeyBank and your app or service. To access KeyBank environments, you must exchange valid certificates with KeyBank. These certificates must be properly installed on your system before you start to send API calls.
API keys
You need API keys to get a bearer token and to grant access to the APIs and the Pre-Production or Production environments. These API keys are created only for authenticated users that have partnered with KeyBank. For more information, see API security or sign up to become a KeyBank API consumer.
Bearer token
Get a bearer token before you start. Only authenticated users with client credentials can request a bearer token. For more information, see API security or sign up to become a KeyBank API consumer.
Health check
Before you start building your API, perform a quick health check. A health check verifies that the API is operational and responding correctly with your system. A bearer token is required to perform a health check. For more information, see Health check.
Create a 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.
You create this value. The can be an alphanumeric value with a maximum length of 45 characters. For example, a random UUID value can be 5ea39056-49gb-4714-b941-e52b1bec7. The batch and the individual UUID can be the same. KeyBank recommends that you use different UUID values.
Client information
After you have completed the onboarding process with KeyBank, KeyBank provides the client (point
) and client account (colllectionApplicationId
, 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, IAT, PPD, TEL, WEB.
SEC CODE | DEFINITION | DESCRIPTION |
---|---|---|
CCD | Corporate Credit or Debit | A CCD entry can be either a buyer-initiated or seller-initiated transaction used to move funds between the buyer’s and seller’s financial institution accounts. It is also used by companies to move funds from outlying depository locations to a central bank account. A CCD entry is typically used when paying for one item, since there is no mechanism for transmitting addenda. |
CTX | Corporate Trade Exchange | A CTX entry is like a CCD entry, but it supports including multiple addenda. |
IAT | International ACH Transactions | An IAT entry is a debit or credit payment transaction involving a financial agency’s office that is not located in the territorial jurisdiction of the United States. |
PPD | Prearranged Payment and Deposit | A PPD entry is a credit or debit entry originated by an organization to a consumer’s account, based on a standing or single-entry authorization from that consumer. A PPD entry supports including one addendum. |
TEL | Telephone Initiated Entries | TEL entries are initiated in response to a receiver’s oral authorization that is spoken over the telephone. These entries can be debit only. |
WEB | Internet Initiated/Mobile Entries | WEB entries are entries transmitted to a consumer receiver’s account. These entries can be either debits or credits. WEB entries can be either recurring or non-recurring transactions. |
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.
Endpoints
Endpoint | Result | Description |
---|---|---|
post /ach/payments/v1/ccd | Send a payment | ACH payment origination for credit or debits. |
post /ach/payments/v1/ctx | Send a payment between two businesses | Submit a payment from one business/entity to another. |
post /ach/payments/v1/ppd | Send a payment from written authorization | Submit a payment based on terms of service, like a subscription or membership. |
post /ach/payments/v1/tel | Send a payment over the phone | Authorize and submit a payment by the phone. |
post /ach/payments/v1/web | Send a payment on a website | Authorize and submit a payment on a website. |
post /ach/payments/v1/undo | Undo a payment request | Reverse a payment request before it enters consolidation. |
post /ach/payments/v1/addenda | Send additional addenda information | Add records to an existing ACH transaction. |
post /ach/payments/v1/status | Check the status of a payment | Return status of one or more Detail Item(s). |
post /ach/payments/v1/status/addenda | Check the status of addenda records | Check the status for large addenda reports. |
Send a payment
post /ach/payments/v1/ccd
ACH payment origination for credit or debits.
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestCCDDetailRequest |
Request example

{ "batch": { "collectionApplicationId": "TESTING", "point": "APITEST", "secCode": "CCD", "uuid": "qas22517-4d3338-4c6f-bcd6fehdd0-11000", "collectionApplicationType": "", "effectiveDate": "220725", "companyDescriptiveDate": "220725", "details": [ { "DFIAccountNumber": "123456789", "accountType": "C", "amount": "0.01", "checkDigit": "9", "creditDebitCode": "C", "receivingCompanyName": "ProdTest001", "receivingDFIId": "04100103", "transactionType": "L", "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re11001", "identificationNumber": "517220101A", "discretionaryData": "AB" } ] } }
Responses
Successfully staged ACH file data into ACH Origination API.
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | acceptedBatchResponseAcceptedDetailResponse |
Response example (200)

{ "batch": { "collectionApplicationId": "TESTING", "point": "APITEST", "secCode": "CCD", "uuid": "qas22517-4d3338-4c6f-bcd6fehdd0-11000", "collectionApplicationType": "", "effectiveDate": "220725", "companyDescriptiveDate": "220725", "details": [ { "DFIAccountNumber": "123456789", "accountType": "C", "amount": "0.01", "checkDigit": "9", "creditDebitCode": "C", "receivingCompanyName": "ProdTest001", "receivingDFIId": "04100103", "transactionType": "L", "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re11001", "identificationNumber": "517220101A", "discretionaryData": "AB" } ] } }
Missing data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 between two businesses
post /ach/payments/v1/ctx
Submit a payment from one business/entity to another.
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestCTXDetailRequest |
Request example

{ "batch": { "collectionApplicationId": "TESTING", "point": "APITEST", "secCode": "CTX", "uuid": "qas22517-4d3338-4c6f-bcd6fehdd0-11000", "collectionApplicationType": "", "effectiveDate": "220411", "companyDescriptiveDate": "220411", "details": [ { "DFIAccountNumber": "123456789", "accountType": "C", "checkDigit": "7", "creditDebitCode": "D", "numberOfAddendaRecords": "1", "receivingCompanyNameIDNumber": "QASTest019", "receivingDFIId": "04100103", "totalAmount": "2100.00", "transactionType": "L", "uuid": "qas22523-A9db-b62-a503-5c51001", "identificationNumber": "517220102C", "discretionaryData": "AK", "addenda": [ { "paymentRelatedInformation": "QASTest05.01" } ] } ] } }
Responses
Successfully staged ACH file data into ACH Origination API.
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | acceptedBatchResponseAcceptedDetailResponse |
Response example (200)

{ "collectionApplicationId": "QASTEST01", "point": "APITEST", "secCode": "CTX", "uuid": "qas22523-A9db-4b6-3-5c551000", "collectionApplicationType": "", "effectiveDate": "220411", "companyDescriptiveDate": "220411", "details": [ { "DFIAccountNumber": "123456789", "accountType": "S", "checkDigit": "0", "creditDebitCode": "C", "numberOfAddendaRecords": "1", "receivingCompanyNameIDNumber": "QASTest019", "receivingDFIId": "04100103", "totalAmount": "2100.00", "transactionType": "L", "uuid": "qas22523-A9db-b62-a503-5c51001", "identificationNumber": "523220501", "discretionaryData": "AK", "addenda": { "paymentRelatedInformation": "QASTest05.01" } } ] }
Missing data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 from written authorization
post /ach/payments/v1/ppd
Submit a payment based on terms of service, like a subscription or membership.
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestPPDDetailRequest |
Request example

{ "batch": { "collectionApplicationId": "QASTest01", "point": "APITEST", "secCode": "PPD", "uuid": "qas22517-4d3338-4c6f-bcd6fehdd0-21000", "collectionApplicationType": "", "effectiveDate": "220411", "companyDescriptiveDate": "220411", "details": [ { "DFIAccountNumber": "123456789", "accountType": "C", "amount": "1994.88", "checkDigit": "9", "creditDebitCode": "C", "individualName": "QASTest005", "receivingDFIId": "04100103", "transactionType": "L", "uuid": "qas22517x-49eb-47664-b94rhd1-e52e2re21001", "individualIdentificationNumber": "517220201A", "discretionaryData": "AB" }, { "DFIAccountNumber": "123456789", "accountType": "C", "amount": "1794.91", "checkDigit": "2", "creditDebitCode": "D", "individualName": "QASTest006", "receivingDFIId": "04100103", "transactionType": "L", "uuid": "qas22517x-49eb-47664-b94rhd1-e52e2re21002", "individualIdentificationNumber": "517220201B", "discretionaryData": "BC" } ] } }
Responses
Successfully staged ACH file data into ACH Origination API.
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | acceptedBatchResponseAcceptedDetailResponse |
Response example (200)

{ "collectionApplicationId": "QASTest01", "point": "APITEST", "secCode": "PPD", "uuid": "qas22517-4d3338-4c6f-bcd6fehdd0-21000", "collectionApplicationType": "", "effectiveDate": "220411", "companyDescriptiveDate": "220411", "details": [ { "DFIAccountNumber": "123456789", "accountType": "C", "amount": "1994.88", "checkDigit": "9", "creditDebitCode": "C", "individualName": "QASTest005", "receivingDFIId": "04100103", "transactionType": "L", "uuid": "qas22517x-49eb-47664-b94rhd1-e52e2re21001", "individualIdentificationNumber": "517220201A", "discretionaryData": "AB" }, { "DFIAccountNumber": "123456789", "accountType": "C", "amount": "1794.91", "checkDigit": "2", "creditDebitCode": "D", "individualName": "QASTest006", "receivingDFIId": "04100103", "transactionType": "L", "uuid": "qas22517x-49eb-47664-b94rhd1-e52e2re21002", "individualIdentificationNumber": "517220201B", "discretionaryData": "BC" } ] }
Missing data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestTELDetailRequest |
Request example

{ "batch": { "collectionApplicationId": "QASTEST01", "point": "APITEST", "secCode": "TEL", "uuid": "qas22523-4d3338-4c6f-bcd6fehdd0-41000", "collectionApplicationType": "", "effectiveDate": "220411", "companyDescriptiveDate": "220411", "details": [ { "DFIAccountNumber": "123456789", "accountType": "C", "amount": "5963.88", "checkDigit": "0", "creditDebitCode": "D", "individualName": "QASTest014", "receivingDFIId": "04100103", "transactionType": "L", "uuid": "qas22523-f76-44eb-a7014041001", "individualIdentificationNumber": "317220401", "paymentTypeCode": "R" } ] } }
Responses
Successfully staged ACH file data into ACH Origination API.
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | acceptedBatchResponseAcceptedDetailResponse |
Response example (200)

{ "uuid": "qas22523-4d3338-4c6f-bcd6fehdd0-41000", "status": "accepted", "requestAcceptedUTCTime": "2022-05-23T18:25:08Z", "effectiveDate": "220411", "informationMessages": [ { "code": "1006040-65I", "moreInfo": "Effective date assigned 220411." } ], "errorMessages": [], "details": [ { "uuid": "qas22523-f76-44eb-a7014041001", "status": "accepted", "errorMessages": [], "informationMessages": [], "traceNumber": "041001030007503", "requestAcceptedUTCTime": "2022-05-23T18:25:08Z" } ] }
Missing data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 on a website
post /ach/payments/v1/web
Authorize and submit a payment on a website.
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestWEBDetailRequest |
Request example

{ "batch": { "collectionApplicationId": "QASTEST01", "point": "APITEST", "secCode": "WEB", "uuid": "qas22525-6fb5-438c-undo132000", "collectionApplicationType": "", "effectiveDate": "220411", "companyDescriptiveDate": "220411", "details": [ { "DFIAccountNumber": "123456789", "accountType": "S", "amount": "0.00", "checkDigit": "0", "creditDebitCode": "C", "individualName": "QASTest011", "receivingDFIId": "04100103", "transactionType": "P", "uuid": "qas22525-6fb5-undo0132001", "individualIdentificationNumber": "315221001", "paymentTypeCode": "R", "addenda": [ { "paymentRelatedInformation": "Undo WEB PAYMENT GOOD ITEM" } ] } ] } }
Responses
Successfully staged ACH file data into ACH Origination API.
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | acceptedBatchResponseAcceptedDetailResponse |
Response example (200)

{ "uuid": "qas22525-6fb5-438c-undo132000", "status": "accepted", "requestAcceptedUTCTime": "2022-05-25T17:30:32Z", "effectiveDate": "220411", "informationMessages": [ { "code": "1006040-65I", "moreInfo": "Effective date assigned 220411." } ], "errorMessages": [], "details": [ { "uuid": "qas22525-6fb5-undo0132001", "status": "accepted", "errorMessages": [], "informationMessages": [], "traceNumber": "041001030008013", "requestAcceptedUTCTime": "2022-05-25T17:30:32Z", "addenda": [ { "status": "accepted", "errorMessages": [], "informationMessages": [] } ] } ] }
Missing data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
Request example

{ "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001" }
Responses
Successfully deleted ACH file data from .
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusoptional | string | Status of the record. Status can be either accepted or rejected for batch record and can be deleted, accepted, rejected, notFound, waitingForAddenda for detail record. |
errorMessagesoptional | array | detailMessage |
informationMessagesoptional | array | detailMessage |
traceNumberoptional | string | Trace Number is a unique number assigned to the transaction. This value is important to save because it can be used in the ACH Inquiry API to get the transaction status. |
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 data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
addendarequired | array | addendaRequest |
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
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*BF*01234*BF*RMT*RMT*IV*01234**112345*112345* 0", "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 | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusoptional | string | Overall Status of the addenda. Can be either accepted or rejected. |
traceNumberoptional | string | Trace Number is a unique number assigned to the transaction. This value is important to save because it can be used in the ACH Inquiry API to get the transaction status. |
informationMessagesoptional | array | detailMessage |
errorMessagesoptional | array | detailMessage |
addendaoptional | array | addendaResponse |
requestAcceptedUTCTimeoptional | string | UTC time when request is accepted. |
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": [] }, "detailMessage": { "code": "1002040-50I", "moreInfo": "All addenda have been received." }, "requestAcceptedUTCTime": "2022-05-25T16:33:46Z" }
Missing data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 a payment
post /ach/payments/v1/status
Return status of one or more Detail Item(s).
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
detailStatusoptional | array | paymentInquiryDetailRequest |
Request example

{ "detailStatus": [ { "uuid": "qas220602x-49eb-47664-b94rhd1-e52e2re11001" }, { "uuid": "qas220602x-49eb-47664-b94rhd1-e52e2re11002" } ] }
Responses
Successfully staged ACH file data into ACH Origination API.
NAME | TYPE | DESCRIPTION |
---|---|---|
detailsoptional | array | detailStatusResponse |
Response example (200)

[ { "uuid": "qas220602x-49eb-47664-b94rhd1-e52e2re11001", "status": "accepted", "errorMessages": [], "informationMessages": [], "traceNumber": "041001030009002", "requestAcceptedUTCTime": "2022-06-02T17:38:28Z", "point": "APITEST", "collectionApplicationId": "QASTEST01", "collectionApplicationType": "", "secCode": "CCD", "effectiveDate": "220411", "companyDescriptiveDate": "220411", "companyName": "APITEST ", "companyDiscretionaryData": "", "companyIdentification": "1123456789", "companyEntryDescription": "API\/QAS ", "originatingDFIId": "04100103", "accountType": "C", "creditDebitCode": "C", "transactionType": "L", "transcationCode": "22", "receivingDFIId": "04100103", "checkDigit": "2", "dfiAccountNumber": "123456789", "amount": "555.54", "identificationNumber": "0602221101A", "receivingCompanyName": "QASTEST001", "discretionaryData": "AB", "numberOfAddendaRecords": "0", "numberOfAddendaReceived": "0", "addenda": null } ]
Missing data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 status for large addenda reports.
Request
HEADER FIELD | TYPE | DESCRIPTION |
---|---|---|
X-Pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
BODY FIELD | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
pageSizeoptional | string | The number of records to be returned in Pagination Search. |
startAddendaSequenceNumberoptional | string | Addenda Sequence number. |
Request example

{ "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001", "pageSize": "10", "startAddendaSequenceNumber": "0001" }
Responses
Successfully staged ACH file data into ACH Origination API.
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidoptional | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusoptional | string | Overall Status of the batch can be either accepted/rejected. |
errorMessagesoptional | array | detailMessage |
traceNumberoptional | string | Trace Number is a unique number assigned to the transaction. This value is important to save because it can be used in the ACH Inquiry API to get the transaction status. |
informationMessagesoptional | array | detailMessage |
addendaoptional | array | baseAddendaDetailResponse |
Response example (200)

{ "uuid": "qas220517x-49eb-47664-b94rhd1-e52e2re13001", "status": "accepted", "errorMessages": [], "traceNumber": "041001030009004", "informationMessages": [ { "code": "1002040-50I", "moreInfo": "All addenda have been received." } ], "addenda": [ { "addendaTypeCode": "05", "addendaSequenceNumber": "0001", "paymentRelatedInformation": "Undo WEB PAYMENT GOOD ITEM" } ] }
Missing data in the 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Received request is unauthorized
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Request is forbidden to access the resource
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested resource is 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 and resubmit the request", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested method is not allowed.
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Requested unsupported media 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Too many requests received
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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", "X-CorrelationId": "2ebd5c24-0e8d-5a70-0e91-ffd2727c1aab", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z" }
Internal server 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (500)

{ "ErrorMessage": "Runtime error occured in the service, please check with appplication support team before resubmitting the request", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (502)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Connectivity error occured with the downstream service(Unexpected EOF at target), please check with appplication support team before resubmitting the request" } }
Service Unavailable
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (503)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "TransactionTime": "2021-06-11T16:31:34.041Z", "ServiceError": { "ConnectError": "Service is currently unavailable(NoActiveTargets), please check with appplication support before resubmitting the request." } }
Gateway 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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
TransactionTimeoptional | string | Time of the occurrence of the error of the message. |
ServiceErroroptional | oneOf | detailMessage connectError |
Response example (504)

{ "ErrorMessage": "Error received from backend service", "X-CorrelationId": "abcgd133", "TransactionId": "rrt-7709400285867417207-b-gce-27587-2383364-1", "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
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 | Universal id to trace the transaction across all the systems involved.CorrelationId is unique per request. |
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 | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusoptional | string | Overall Status of the addenda. Can be either accepted or rejected. |
traceNumberoptional | string | Trace Number is a unique number assigned to the transaction. This value is important to save because it can be used in the ACH Inquiry API to get the transaction status. |
informationMessagesoptional | array | detailMessage |
errorMessagesoptional | array | detailMessage |
addendaoptional | array | addendaResponse |
requestAcceptedUTCTimeoptional | string | UTC time when request is accepted. |
acceptedBatchResponseAcceptedDetailResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusrequired | string | Overall Status of the batch can be either accepted/rejected. |
requestAcceptedUTCTimeoptional | string | UTC time when request is accepted. |
effectiveDateoptional | string | Effective Date in YYMMDD format. |
informationMessagesoptional | array | detailMessage |
errorMessagesoptional | array | detailMessage |
detailsoptional | array | acceptedDetailResponse |
acceptedDetailResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusoptional | string | Overall Status of the addenda. Can be either accepted or rejected. |
errorMessagesoptional | array | detailMessage |
informationMessagesoptional | array | detailMessage |
traceNumberoptional | string | Trace Number is a unique number assigned to the transaction. This value is important to save because it can be used in the ACH Inquiry API to get the transaction status. |
requestAcceptedUTCTimeoptional | string | Request accepted time in UTC format. |
addendaRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
paymentRelatedInformationrequired | string | Addendas payment related information. Its maximum size is 80 characters. |
addendaSequenceNumberrequired | string | Sequence number for Addenda. |
addendaRequestEnvelope
NAME | TYPE | DESCRIPTION |
---|---|---|
addendarequired | array | addendaRequest |
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
addendaResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
statusoptional | string | Status of addenda. |
errorMessagesoptional | array | detailMessage |
informationMessagesoptional | array | detailMessage |
addendaStatusRequestEnvelope
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
pageSizeoptional | string | The number of records to be returned in Pagination Search. |
startAddendaSequenceNumberoptional | string | Addenda Sequence number. |
addendaStatusResponseEnvelope
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidoptional | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusoptional | string | Overall Status of the batch can be either accepted/rejected. |
errorMessagesoptional | array | detailMessage |
traceNumberoptional | string | Trace Number is a unique number assigned to the transaction. This value is important to save because it can be used in the ACH Inquiry API to get the transaction status. |
informationMessagesoptional | array | detailMessage |
addendaoptional | array | baseAddendaDetailResponse |
baseAddendaDetailResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
addendaTypeCodeoptional | string | Type code for Addenda. Value remains "05". |
addendaSequenceNumberoptional | string | Sequence number for Addenda. It can be maximum of 4 digits. |
paymentRelatedInformationoptional | string | Addendas payment related information. Its maximum size is 80. |
baseAddendaRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
paymentRelatedInformationrequired | string | Payment Related Information can be a maximum of 80 characters. |
baseDataObject
NAME | TYPE | DESCRIPTION |
---|
baseDetailResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusoptional | string | Status of the record. Status can be either accepted or rejected for batch record and can be deleted, accepted, rejected, notFound, waitingForAddenda for detail record. |
errorMessagesoptional | array | detailMessage |
informationMessagesoptional | array | detailMessage |
traceNumberoptional | string | Trace Number is a unique number assigned to the transaction. This value is important to save because it can be used in the ACH Inquiry API to get the transaction status. |
batchRequestCCDDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
collectionApplicationIdrequired | string | This short name will be provided during API onboarding and is specific to your account. |
collectionApplicationTypeoptional | string | Collection Application Type can be a maximum of 6 characters. |
secCoderequired | string | Standard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules. |
effectiveDateoptional | string | Effective Date in YYMMDD format.(6 numeric characters). |
companyDescriptiveDateoptional | string | Company Descriptive Date in YYMMDD format. |
detailsoptional | array | cCDDetailRequest |
batchRequestCTXDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
collectionApplicationIdrequired | string | This short name will be provided during API onboarding and is specific to your account. |
collectionApplicationTypeoptional | string | Collection Application Type can be a maximum of 6 characters. |
secCoderequired | string | Standard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules. |
effectiveDateoptional | string | Effective Date in YYMMDD format.(6 numeric characters). |
companyDescriptiveDateoptional | string | Company Descriptive Date in YYMMDD format. |
detailsoptional | array | cTXDetailRequest |
batchRequestEnvelopeBatchRequestCCDDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestCCDDetailRequest |
batchRequestEnvelopeBatchRequestCTXDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestCTXDetailRequest |
batchRequestEnvelopeBatchRequestPPDDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestPPDDetailRequest |
batchRequestEnvelopeBatchRequestTELDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestTELDetailRequest |
batchRequestEnvelopeBatchRequestWEBDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | batchRequestWEBDetailRequest |
batchRequestPPDDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
collectionApplicationIdrequired | string | This short name will be provided during API onboarding and is specific to your account. |
collectionApplicationTypeoptional | string | Collection Application Type can be a maximum of 6 characters. |
secCoderequired | string | Standard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules. |
effectiveDateoptional | string | Effective Date in YYMMDD format.(6 numeric characters). |
companyDescriptiveDateoptional | string | Company Descriptive Date in YYMMDD format. |
detailsoptional | array | pPDDetailRequest |
batchRequestTELDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
collectionApplicationIdrequired | string | This short name will be provided during API onboarding and is specific to your account. |
collectionApplicationTypeoptional | string | Collection Application Type can be a maximum of 6 characters. |
secCoderequired | string | Standard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules. |
effectiveDateoptional | string | Effective Date in YYMMDD format.(6 numeric characters). |
companyDescriptiveDateoptional | string | Company Descriptive Date in YYMMDD format. |
detailsoptional | array | telDetailRequest |
batchRequestWEBDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
pointrequired | string | This short name will be provided during API onboarding and is specific to your Company Name. |
collectionApplicationIdrequired | string | This short name will be provided during API onboarding and is specific to your account. |
collectionApplicationTypeoptional | string | Collection Application Type can be maximum of 6 alphanumeric characters. For Add must not exist. |
secCoderequired | string | Standard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules. |
effectiveDateoptional | string | Effective Date in YYMMDD format. |
companyDescriptiveDateoptional | string | Company Descriptive Date in YYMMDD format. |
detailsoptional | array | webDetailRequest |
batchResponseEnvelopeAccepted
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | acceptedBatchResponseAcceptedDetailResponse |
batchResponseEnvelopeRejected
NAME | TYPE | DESCRIPTION |
---|---|---|
batchrequired | Object | rejectedBatchResponseBaseDetailResponse |
cCDDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
accountTyperequired | string | Transaction Type must be either Checking('C') or Savings('S') |
creditDebitCoderequired | string | Credit Debit Code must be either Credit('C') or Debit('D') |
transactionTyperequired | string | Transaction Type must be either Live('L') or Prenote('P') or Zero ('Z') |
receivingDFIIdrequired | string | Receiving DFI ID can be maximum of 8 digits. |
checkDigitrequired | string | Check digit is 1 numeric digit. |
DFIAccountNumberrequired | string | DFI Account Number can be maximum of 17 characters. |
amountrequired | string | Amount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal. |
identificationNumberoptional | string | Identification Number can be a maximum of 15 characters. |
receivingCompanyNamerequired | string | Receiving Company Name can be a maximum of 22 characters. |
discretionaryDataoptional | string | Discretionary Data can be of max 2 characters. |
addendaoptional | array | baseAddendaRequest |
cTXDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
accountTyperequired | string | Transaction Type must be either Checking('C') or Savings('S'). |
creditDebitCoderequired | string | Credit Debit Code must be either Credit('C') or Debit('D'). |
transactionTyperequired | string | Transaction Type must be either Live('L') or Prenote('P') or Zero ('Z'). |
receivingDFIIdrequired | string | Receiving DFI ID can be maximum of 8 digits. |
checkDigitrequired | string | Check digit is 1 numeric digit. |
DFIAccountNumberrequired | string | DFI Account Number can be maximum of 17 characters. |
totalAmountrequired | string | Amount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal. |
identificationNumberoptional | string | Identification Number with size maximum of 15 characters. |
numberOfAddendaRecordsrequired | string | 4 digit indicator for number of Addenda Records. |
receivingCompanyNameIDNumberrequired | string | Receiving Company Name/ID Number with size maximum of 16 characters. |
discretionaryDataoptional | string | Discretionary Data can be a maximum of 2 characters. |
addendaoptional | array | baseAddendaRequest |
detailMessage
NAME | TYPE | DESCRIPTION |
---|---|---|
codeoptional | string | The code for the message. |
moreInfooptional | string | Detailed descriptive message. |
detailStatusRequestEnvelopePaymentInquiryDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
detailStatusoptional | array | paymentInquiryDetailRequest |
detailStatusResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusoptional | string | Overall Status of the batch can be either accepted/rejected. |
errorMessagesoptional | array | detailMessage |
informationMessagesoptional | array | detailMessage |
traceNumberoptional | string | Trace Number is a unique number assigned to the transaction. This value is important to save because it can be used in the ACH Inquiry API to get the transaction status. |
requestAcceptedUTCTimeoptional | string | UTC time when request is accepted. |
requestDeletedUTCTimeoptional | string | UTC time of the request deleted. |
requestLastUpdatedUTCTimeoptional | string | Last updated UTC time of request. |
pointoptional | string | This short name will be provided during API onboarding and is specific to your Company Name. |
collectionApplicationIdoptional | string | This short name will be provided during API onboarding and is specific to your account. |
collectionApplicationTypeoptional | string | Collection Application Type can be maximum of 6 alphanumeric characters. For Add must not exist. |
secCodeoptional | string | Standard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules. |
effectiveDateoptional | string | Effective Date in YYMMDD format. |
companyDescriptiveDateoptional | string | Company Descriptive Date in YYMMDD format. |
batchNumberoptional | string | Batch Number is a numeric field and can be a maximum of 7 digits. |
companyNameoptional | string | Company Name is the name of the corporation or institution making the request. It is a requred field for Add. It is up to 16 characters in length and cannot be spaces. |
companyDiscretionaryDataoptional | string | Discretionary data for the company. |
companyIdentificationoptional | string | Identification Number with size maximum of 15 characters. |
companyEntryDescriptionoptional | string | Entry description for the company. |
originatingDFIIdoptional | string | Originating DFI ID can be a maximum of 8 digits. |
accountTypeoptional | string | Transaction Type must be either Checking('C') or Savings('S'). |
creditDebitCodeoptional | string | Credit Debit Code is a 1 character field. Indicates whether the ACH transaction being generated with this data is a Credit or Debit. VALUES are 'C' Credit. 'D' Debit. DEFAULT value is None. |
transactionTypeoptional | string | Transaction Type must be either Live('L') or Prenote('P') or Zero ('Z') |
transcationCodeoptional | string | Transaction Code is a 2 character field used specify the appropriate billing credit transaction code. |
receivingDFIIdoptional | string | Receiving DFI ID can be a maximum of 8 digits. |
checkDigitoptional | string | Check digit is 1 numeric digit. |
dfiAccountNumberoptional | string | DFI Account number. |
amountoptional | string | Amount of the detail record. |
identificationNumberoptional | string | Identifcation number for the detail record. |
receivingCompanyNameoptional | string | Receiving Company Name can be a maximum of 22 characters. |
discretionaryDataoptional | string | Discretionary Data is used to further identify the corporation or describe the type of entries being processed. Up to 20 characters in length. |
totalAmountoptional | string | Total amount of record. |
receivingCompanyNameIDNumberoptional | string | Receiving company name and Id Number. |
individualIdentificationNumberoptional | string | Identification number for an Individual. |
individualNameoptional | string | Individual name. |
paymentTypeCodeoptional | string | Payment type code with maximum of 2 characters. Filled with 2 spaces character in the generated ACH transaction if not provided by the client. |
numberOfAddendaRecordsoptional | string | Count of Addenda records in Detail record. |
numberOfAddendaReceivedoptional | string | Count of addenda records received. |
addendaoptional | array | baseAddendaDetailResponse |
fileCreationDateoptional | string | Creation date for File. |
fileCreationTimeoptional | string | Creation time of File. |
fileIdModifieroptional | string | File ID modifier for Control Totals. Alphanumeric values are allowed. Its maximum size is 1. |
detailStatusResponseEnvelopeDetailStatusResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
detailsoptional | array | detailStatusResponse |
detailUndoRequestEnvelope
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
messageResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
messageoptional | string | The short message for the request. |
detailsoptional | array | detailMessage |
notificationEventResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
pointoptional | string | This short name will be provided during API onboarding and is specific to your Company Name. |
collectionApplicationIdoptional | string | This short name will be provided during API onboarding and is specific to your account. |
collectionApplicationTypeoptional | string | Collection Application Type can be a maximum of 6 characters. |
eventIdoptional | string | Unique Id of an event. Contains up to 6 alphanumeric characters. |
eventMessageoptional | string | Description of the event generated. Contains up to 500 alphanumeric characters. |
pPDDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
accountTyperequired | string | Transaction Type must be either Checking('C') or Savings('S') |
creditDebitCoderequired | string | Credit Debit Code must be either Credit('C') or Debit('D') |
transactionTyperequired | string | Transaction Type must be either Live('L') or Prenote('P') or Zero ('Z') |
receivingDFIIdrequired | string | Receiving DFI ID can be maximum of 8 digits. |
checkDigitrequired | string | Check digit is 1 numeric digit. |
DFIAccountNumberrequired | string | DFI Account Number can be maximum of 17 characters. |
amountrequired | string | Amount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal. |
individualNamerequired | string | Individual Name field with maximum 22 characters. |
individualIdentificationNumberoptional | string | Individual Identification Number with a maximum of 15 characters. |
discretionaryDataoptional | string | Discretionary Data can be of max 2 characters. |
addendaoptional | array | baseAddendaRequest |
paymentInquiryDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
rejectedBatchResponseBaseDetailResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
statusrequired | string | Overall Status of the batch can be either accepted/rejected. |
errorsoptional | array | detailMessage |
detailsoptional | array | baseDetailResponse |
sortControl
NAME | TYPE | DESCRIPTION |
---|---|---|
sortByoptional | string | Contains fields on which sorting is done. |
sortOrderoptional | string | Order on which sorting is done. It can contain a value of asc or desc. |
successMetaResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
pageNumberoptional | integer | Page number retrieved in Pagination search. |
sizeUsedoptional | integer | Page size value used by server API. |
sizeRequestedoptional | integer | Page size value sent by client in request payload. |
totalRecordsoptional | integer | Total number of records available for Inquiry. |
sortoptional | array | sortControl |
successResponseString
NAME | TYPE | DESCRIPTION |
---|---|---|
dataoptional | array | List of data returned in success response. |
successSearchResponseNotificationEventResponse
NAME | TYPE | DESCRIPTION |
---|---|---|
dataoptional | array | notificationEventResponse |
metaoptional | Object | successMetaResponse |
telDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
accountTyperequired | string | Transaction Type must be either Checking('C') or Savings('S'). |
creditDebitCoderequired | string | Credit Debit Code must be either Credit('C') or Debit('D'). |
transactionTyperequired | string | Transaction Type must be either Live('L') or Prenote('P') or Zero ('Z'). |
receivingDFIIdrequired | string | Receiving DFI ID can be maximum of 8 digits. |
checkDigitrequired | string | Check digit is 1 numeric digit. |
DFIAccountNumberrequired | string | DFI Account Number can be maximum of 17 characters. |
amountrequired | string | Amount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal. |
individualIdentificationNumberoptional | string | Optional. Individual Identification Number with a maximum of 15 characters. |
individualNamerequired | string | Required. Individual Name field with a maximum of 22 characters. |
paymentTypeCodeoptional | string | Payment type code with maximum of 2 characters. Filled with 2 spaces character in the generated ACH transaction if not provided by the client. |
webDetailRequest
NAME | TYPE | DESCRIPTION |
---|---|---|
uuidrequired | string | UUID is customer-populated value to identify each transaction. It is required to delete a transaction using the Undo function. It is not maintained throughout the lifecycle of the transaction. |
accountTyperequired | string | Transaction Type must be either Checking('C') or Savings('S'). |
creditDebitCoderequired | string | Credit Debit Code must be either Credit('C') or Debit('D'). |
transactionTyperequired | string | Transaction Type must be either Live('L') or Prenote('P') or Zero ('Z'). |
receivingDFIIdrequired | string | Receiving DFI ID can be maximum of 8 digits. |
checkDigitrequired | string | Check digit is 1 numeric digit. |
DFIAccountNumberrequired | string | DFI Account Number can be maximum of 17 characters. |
amountrequired | string | Amount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal. |
individualIdentificationNumberoptional | string | Individual Identification Number with maximum 15 characters. |
individualNamerequired | string | Individual Name field with maximum of 22 characters. |
paymentTypeCodeoptional | string | Payment type code with maximum of 2 characters. Filled with 2 spaces character in the generated ACH transaction if not provided by the client. |
addendaoptional | array | baseAddendaRequest |
Error handling
An error can indicate a problem with the request, the network, or the API itself. Use the error handling information to get a better understanding of what went wrong and possible corrective actions.
Standard error message format
An erroneous response returns the HTTP code number with the content of the exception
schema. Additional information in this schema like the transaction ID and transaction time can help you diagnose the issue.
The schema includes the X-CorrelationId
field to help with traceability.
API-specific error messages
Custom messages are used for API-related functional business messages or faults. Each API can contain custom messages specific to KeyBank operations or the API. These messages can be part of the exception
schema or a separate object.
KeyBank uses the ServiceError
> detailsMessage
object for errors specific to the API.
Error codes and messages
Standard errors use the typical HTTP status codes. Messages specific to KeyBank have an asterisk (*) after the message code number. Look at errorMessages
in the response payload or the detailMessage
object for additional information specific to the API.
HTTP STATUS CODE | DESCRIPTION |
---|---|
400 | Missing data in the request.
|
401 | Received request is unauthorized.
|
403 | Request is forbidden to access the resource.
|
404 | Request resource is not found.
|
405 | Request method is not allowed.
|
415 | Requested unsupported media type.
|
429 | Too many request received.
|
500 | Internal server error.
|
502 | Bad Gateway.
|
503 | Service Unavailable.
|
504 | Gateway timeout.
|
YAML file
