ACH Origination

67 minute read 1.1.6 | updated Feb. 14, 2023

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.

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:

  1. Have valid certificates for a secure connection.

  2. Make sure you have the API keys needed for basic authentication and API access.

  3. Request a bearer token before you start.

  4. Check the health of the API.

  5. Create a UUID.

  6. Have the required client information fields for calls using a SEC code, provided by KeyBank.

  7. Know the SEC code.

  8. Get a trace number.

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.

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.

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.

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.

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.

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.

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.

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.

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.

post /ach/payments/v1/ccd

ACH payment origination for credit or debits.

HEADER FIELDTYPEDESCRIPTION
X-PointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
BODY FIELDTYPEDESCRIPTION
batchrequiredObjectbatchRequestCCDDetailRequest

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"
            }
        ]
    }
}
NAMETYPEDESCRIPTION
batchrequiredObjectacceptedBatchResponseAcceptedDetailResponse

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"
            }
        ]
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}

post /ach/payments/v1/ctx

Submit a payment from one business/entity to another.

HEADER FIELDTYPEDESCRIPTION
X-PointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
BODY FIELDTYPEDESCRIPTION
batchrequiredObjectbatchRequestCTXDetailRequest

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"
                    }
                ]
            }
        ]
    }
}
NAMETYPEDESCRIPTION
batchrequiredObjectacceptedBatchResponseAcceptedDetailResponse

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"
            }
        }
    ]
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}

post /ach/payments/v1/ppd

Submit a payment based on terms of service, like a subscription or membership.

HEADER FIELDTYPEDESCRIPTION
X-PointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
BODY FIELDTYPEDESCRIPTION
batchrequiredObjectbatchRequestPPDDetailRequest

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"
            }
        ]
    }
}
NAMETYPEDESCRIPTION
batchrequiredObjectacceptedBatchResponseAcceptedDetailResponse

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"
        }
    ]
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}

post /ach/payments/v1/tel

Authorize and submit a payment by the phone.

HEADER FIELDTYPEDESCRIPTION
X-PointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
BODY FIELDTYPEDESCRIPTION
batchrequiredObjectbatchRequestTELDetailRequest

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"
            }
        ]
    }
}
NAMETYPEDESCRIPTION
batchrequiredObjectacceptedBatchResponseAcceptedDetailResponse

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"
        }
    ]
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}

post /ach/payments/v1/web

Authorize and submit a payment on a website.

HEADER FIELDTYPEDESCRIPTION
X-PointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
BODY FIELDTYPEDESCRIPTION
batchrequiredObjectbatchRequestWEBDetailRequest

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"
                    }
                ]
            }
        ]
    }
}
NAMETYPEDESCRIPTION
batchrequiredObjectacceptedBatchResponseAcceptedDetailResponse

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": []
                }
            ]
        }
    ]
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}

post /ach/payments/v1/undo

Reverse a payment request before it enters consolidation.

HEADER FIELDTYPEDESCRIPTION
X-PointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
BODY FIELDTYPEDESCRIPTION
uuidrequiredstringUUID 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"
}
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
statusoptionalstringStatus of the record. Status can be either accepted or rejected for batch record and can be deleted, accepted, rejected, notFound, waitingForAddenda for detail record.
errorMessagesoptionalarraydetailMessage
informationMessagesoptionalarraydetailMessage
traceNumberoptionalstringTrace 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}

post /ach/payments/v1/addenda

Add records to an existing ACH transaction.

HEADER FIELDTYPEDESCRIPTION
X-PointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
BODY FIELDTYPEDESCRIPTION
addendarequiredarrayaddendaRequest
uuidrequiredstringUUID 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"
}
NAMETYPEDESCRIPTION
uuidoptionalstringUUID 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.
statusoptionalstringOverall Status of the addenda. Can be either accepted or rejected.
traceNumberoptionalstringTrace 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.
informationMessagesoptionalarraydetailMessage
errorMessagesoptionalarraydetailMessage
addendaoptionalarrayaddendaResponse
requestAcceptedUTCTimeoptionalstringUTC 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}

post /ach/payments/v1/status

Return status of one or more Detail Item(s).

HEADER FIELDTYPEDESCRIPTION
X-PointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
BODY FIELDTYPEDESCRIPTION
detailStatusoptionalarraypaymentInquiryDetailRequest

Request example

{
    "detailStatus": [
        {
            "uuid": "qas220602x-49eb-47664-b94rhd1-e52e2re11001"
        },
        {
            "uuid": "qas220602x-49eb-47664-b94rhd1-e52e2re11002"
        }
    ]
}
NAMETYPEDESCRIPTION
detailsoptionalarraydetailStatusResponse

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
    }
]
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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"
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}
NAMETYPEDESCRIPTION
ErrorMessageoptionalstringError message related to system generating this error.
TransactionIdoptionalstringUnique functional identifier from the data to identify a message.
X-CorrelationIdoptionalstringUniversal id to trace the transaction across all the systems involved.CorrelationId is unique per request.
TransactionTimeoptionalstringTime of the occurrence of the error of the message.
ServiceErroroptionaloneOfdetailMessage 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."
    }
}

post /ach/payments/v1/status/addenda

Check the status for large addenda reports.

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"
}
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"
        }
    ]
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
    }
}
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."
    }
}
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."
    }
}
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
NAME TYPE DESCRIPTION
ConnectErroroptional string Error information of the connectivity with downstream service.
NAMETYPEDESCRIPTION
uuidoptionalstringUUID 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.
statusoptionalstringOverall Status of the addenda. Can be either accepted or rejected.
traceNumberoptionalstringTrace 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.
informationMessagesoptionalarraydetailMessage
errorMessagesoptionalarraydetailMessage
addendaoptionalarrayaddendaResponse
requestAcceptedUTCTimeoptionalstringUTC time when request is accepted.
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
statusrequiredstringOverall Status of the batch can be either accepted/rejected.
requestAcceptedUTCTimeoptionalstringUTC time when request is accepted.
effectiveDateoptionalstringEffective Date in YYMMDD format.
informationMessagesoptionalarraydetailMessage
errorMessagesoptionalarraydetailMessage
detailsoptionalarrayacceptedDetailResponse
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
statusoptionalstringOverall Status of the addenda. Can be either accepted or rejected.
errorMessagesoptionalarraydetailMessage
informationMessagesoptionalarraydetailMessage
traceNumberoptionalstringTrace 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.
requestAcceptedUTCTimeoptionalstringRequest accepted time in UTC format.
NAMETYPEDESCRIPTION
paymentRelatedInformationrequiredstringAddendas payment related information. Its maximum size is 80 characters.
addendaSequenceNumberrequiredstringSequence number for Addenda.
NAMETYPEDESCRIPTION
addendarequiredarrayaddendaRequest
uuidrequiredstringUUID 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.
NAMETYPEDESCRIPTION
statusoptionalstringStatus of addenda.
errorMessagesoptionalarraydetailMessage
informationMessagesoptionalarraydetailMessage
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
pageSizeoptionalstringThe number of records to be returned in Pagination Search.
startAddendaSequenceNumberoptionalstringAddenda Sequence number.
NAMETYPEDESCRIPTION
uuidoptionalstringUUID 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.
statusoptionalstringOverall Status of the batch can be either accepted/rejected.
errorMessagesoptionalarraydetailMessage
traceNumberoptionalstringTrace 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.
informationMessagesoptionalarraydetailMessage
addendaoptionalarraybaseAddendaDetailResponse
NAMETYPEDESCRIPTION
addendaTypeCodeoptionalstringType code for Addenda. Value remains "05".
addendaSequenceNumberoptionalstringSequence number for Addenda. It can be maximum of 4 digits.
paymentRelatedInformationoptionalstringAddendas payment related information. Its maximum size is 80.
NAMETYPEDESCRIPTION
paymentRelatedInformationrequiredstringPayment Related Information can be a maximum of 80 characters.
NAMETYPEDESCRIPTION
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
statusoptionalstringStatus of the record. Status can be either accepted or rejected for batch record and can be deleted, accepted, rejected, notFound, waitingForAddenda for detail record.
errorMessagesoptionalarraydetailMessage
informationMessagesoptionalarraydetailMessage
traceNumberoptionalstringTrace 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.
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
pointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
collectionApplicationIdrequiredstringThis short name will be provided during API onboarding and is specific to your account.
collectionApplicationTypeoptionalstringCollection Application Type can be a maximum of 6 characters.
secCoderequiredstringStandard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules.
effectiveDateoptionalstringEffective Date in YYMMDD format.(6 numeric characters).
companyDescriptiveDateoptionalstringCompany Descriptive Date in YYMMDD format.
detailsoptionalarraycCDDetailRequest
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
pointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
collectionApplicationIdrequiredstringThis short name will be provided during API onboarding and is specific to your account.
collectionApplicationTypeoptionalstringCollection Application Type can be a maximum of 6 characters.
secCoderequiredstringStandard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules.
effectiveDateoptionalstringEffective Date in YYMMDD format.(6 numeric characters).
companyDescriptiveDateoptionalstringCompany Descriptive Date in YYMMDD format.
detailsoptionalarraycTXDetailRequest
NAMETYPEDESCRIPTION
batchrequiredObjectbatchRequestCCDDetailRequest
NAMETYPEDESCRIPTION
batchrequiredObjectbatchRequestCTXDetailRequest
NAMETYPEDESCRIPTION
batchrequiredObjectbatchRequestPPDDetailRequest
NAMETYPEDESCRIPTION
batchrequiredObjectbatchRequestTELDetailRequest
NAMETYPEDESCRIPTION
batchrequiredObjectbatchRequestWEBDetailRequest
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
pointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
collectionApplicationIdrequiredstringThis short name will be provided during API onboarding and is specific to your account.
collectionApplicationTypeoptionalstringCollection Application Type can be a maximum of 6 characters.
secCoderequiredstringStandard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules.
effectiveDateoptionalstringEffective Date in YYMMDD format.(6 numeric characters).
companyDescriptiveDateoptionalstringCompany Descriptive Date in YYMMDD format.
detailsoptionalarraypPDDetailRequest
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
pointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
collectionApplicationIdrequiredstringThis short name will be provided during API onboarding and is specific to your account.
collectionApplicationTypeoptionalstringCollection Application Type can be a maximum of 6 characters.
secCoderequiredstringStandard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules.
effectiveDateoptionalstringEffective Date in YYMMDD format.(6 numeric characters).
companyDescriptiveDateoptionalstringCompany Descriptive Date in YYMMDD format.
detailsoptionalarraytelDetailRequest
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
pointrequiredstringThis short name will be provided during API onboarding and is specific to your Company Name.
collectionApplicationIdrequiredstringThis short name will be provided during API onboarding and is specific to your account.
collectionApplicationTypeoptionalstringCollection Application Type can be maximum of 6 alphanumeric characters. For Add must not exist.
secCoderequiredstringStandard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules.
effectiveDateoptionalstringEffective Date in YYMMDD format.
companyDescriptiveDateoptionalstringCompany Descriptive Date in YYMMDD format.
detailsoptionalarraywebDetailRequest
NAMETYPEDESCRIPTION
batchrequiredObjectacceptedBatchResponseAcceptedDetailResponse
NAMETYPEDESCRIPTION
batchrequiredObjectrejectedBatchResponseBaseDetailResponse
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
accountTyperequiredstringTransaction Type must be either Checking('C') or Savings('S')
creditDebitCoderequiredstringCredit Debit Code must be either Credit('C') or Debit('D')
transactionTyperequiredstringTransaction Type must be either Live('L') or Prenote('P') or Zero ('Z')
receivingDFIIdrequiredstringReceiving DFI ID can be maximum of 8 digits.
checkDigitrequiredstringCheck digit is 1 numeric digit.
DFIAccountNumberrequiredstringDFI Account Number can be maximum of 17 characters.
amountrequiredstringAmount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal.
identificationNumberoptionalstringIdentification Number can be a maximum of 15 characters.
receivingCompanyNamerequiredstringReceiving Company Name can be a maximum of 22 characters.
discretionaryDataoptionalstringDiscretionary Data can be of max 2 characters.
addendaoptionalarraybaseAddendaRequest
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
accountTyperequiredstringTransaction Type must be either Checking('C') or Savings('S').
creditDebitCoderequiredstringCredit Debit Code must be either Credit('C') or Debit('D').
transactionTyperequiredstringTransaction Type must be either Live('L') or Prenote('P') or Zero ('Z').
receivingDFIIdrequiredstringReceiving DFI ID can be maximum of 8 digits.
checkDigitrequiredstringCheck digit is 1 numeric digit.
DFIAccountNumberrequiredstringDFI Account Number can be maximum of 17 characters.
totalAmountrequiredstringAmount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal.
identificationNumberoptionalstringIdentification Number with size maximum of 15 characters.
numberOfAddendaRecordsrequiredstring4 digit indicator for number of Addenda Records.
receivingCompanyNameIDNumberrequiredstringReceiving Company Name/ID Number with size maximum of 16 characters.
discretionaryDataoptionalstringDiscretionary Data can be a maximum of 2 characters.
addendaoptionalarraybaseAddendaRequest
NAMETYPEDESCRIPTION
codeoptionalstringThe code for the message.
moreInfooptionalstringDetailed descriptive message.
NAMETYPEDESCRIPTION
detailStatusoptionalarraypaymentInquiryDetailRequest
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
statusoptionalstringOverall Status of the batch can be either accepted/rejected.
errorMessagesoptionalarraydetailMessage
informationMessagesoptionalarraydetailMessage
traceNumberoptionalstringTrace 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.
requestAcceptedUTCTimeoptionalstringUTC time when request is accepted.
requestDeletedUTCTimeoptionalstringUTC time of the request deleted.
requestLastUpdatedUTCTimeoptionalstringLast updated UTC time of request.
pointoptionalstringThis short name will be provided during API onboarding and is specific to your Company Name.
collectionApplicationIdoptionalstringThis short name will be provided during API onboarding and is specific to your account.
collectionApplicationTypeoptionalstringCollection Application Type can be maximum of 6 alphanumeric characters. For Add must not exist.
secCodeoptionalstringStandard Entry Class Code. Length must be exactly 3 alphabetical characters and adhere to Nacha rules.
effectiveDateoptionalstringEffective Date in YYMMDD format.
companyDescriptiveDateoptionalstringCompany Descriptive Date in YYMMDD format.
batchNumberoptionalstringBatch Number is a numeric field and can be a maximum of 7 digits.
companyNameoptionalstringCompany 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.
companyDiscretionaryDataoptionalstringDiscretionary data for the company.
companyIdentificationoptionalstringIdentification Number with size maximum of 15 characters.
companyEntryDescriptionoptionalstringEntry description for the company.
originatingDFIIdoptionalstringOriginating DFI ID can be a maximum of 8 digits.
accountTypeoptionalstringTransaction Type must be either Checking('C') or Savings('S').
creditDebitCodeoptionalstringCredit 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.
transactionTypeoptionalstringTransaction Type must be either Live('L') or Prenote('P') or Zero ('Z')
transcationCodeoptionalstringTransaction Code is a 2 character field used specify the appropriate billing credit transaction code.
receivingDFIIdoptionalstringReceiving DFI ID can be a maximum of 8 digits.
checkDigitoptionalstringCheck digit is 1 numeric digit.
dfiAccountNumberoptionalstringDFI Account number.
amountoptionalstringAmount of the detail record.
identificationNumberoptionalstringIdentifcation number for the detail record.
receivingCompanyNameoptionalstringReceiving Company Name can be a maximum of 22 characters.
discretionaryDataoptionalstringDiscretionary Data is used to further identify the corporation or describe the type of entries being processed. Up to 20 characters in length.
totalAmountoptionalstringTotal amount of record.
receivingCompanyNameIDNumberoptionalstringReceiving company name and Id Number.
individualIdentificationNumberoptionalstringIdentification number for an Individual.
individualNameoptionalstringIndividual name.
paymentTypeCodeoptionalstringPayment type code with maximum of 2 characters. Filled with 2 spaces character in the generated ACH transaction if not provided by the client.
numberOfAddendaRecordsoptionalstringCount of Addenda records in Detail record.
numberOfAddendaReceivedoptionalstringCount of addenda records received.
addendaoptionalarraybaseAddendaDetailResponse
fileCreationDateoptionalstringCreation date for File.
fileCreationTimeoptionalstringCreation time of File.
fileIdModifieroptionalstringFile ID modifier for Control Totals. Alphanumeric values are allowed. Its maximum size is 1.
NAMETYPEDESCRIPTION
detailsoptionalarraydetailStatusResponse
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
NAMETYPEDESCRIPTION
messageoptionalstringThe short message for the request.
detailsoptionalarraydetailMessage
NAMETYPEDESCRIPTION
pointoptionalstringThis short name will be provided during API onboarding and is specific to your Company Name.
collectionApplicationIdoptionalstringThis short name will be provided during API onboarding and is specific to your account.
collectionApplicationTypeoptionalstringCollection Application Type can be a maximum of 6 characters.
eventIdoptionalstringUnique Id of an event. Contains up to 6 alphanumeric characters.
eventMessageoptionalstringDescription of the event generated. Contains up to 500 alphanumeric characters.
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
accountTyperequiredstringTransaction Type must be either Checking('C') or Savings('S')
creditDebitCoderequiredstringCredit Debit Code must be either Credit('C') or Debit('D')
transactionTyperequiredstringTransaction Type must be either Live('L') or Prenote('P') or Zero ('Z')
receivingDFIIdrequiredstringReceiving DFI ID can be maximum of 8 digits.
checkDigitrequiredstringCheck digit is 1 numeric digit.
DFIAccountNumberrequiredstringDFI Account Number can be maximum of 17 characters.
amountrequiredstringAmount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal.
individualNamerequiredstringIndividual Name field with maximum 22 characters.
individualIdentificationNumberoptionalstringIndividual Identification Number with a maximum of 15 characters.
discretionaryDataoptionalstringDiscretionary Data can be of max 2 characters.
addendaoptionalarraybaseAddendaRequest
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
statusrequiredstringOverall Status of the batch can be either accepted/rejected.
errorsoptionalarraydetailMessage
detailsoptionalarraybaseDetailResponse
NAMETYPEDESCRIPTION
sortByoptionalstringContains fields on which sorting is done.
sortOrderoptionalstringOrder on which sorting is done. It can contain a value of asc or desc.
NAMETYPEDESCRIPTION
pageNumberoptionalintegerPage number retrieved in Pagination search.
sizeUsedoptionalintegerPage size value used by server API.
sizeRequestedoptionalintegerPage size value sent by client in request payload.
totalRecordsoptionalintegerTotal number of records available for Inquiry.
sortoptionalarraysortControl
NAMETYPEDESCRIPTION
dataoptionalarrayList of data returned in success response.
NAMETYPEDESCRIPTION
dataoptionalarraynotificationEventResponse
metaoptionalObjectsuccessMetaResponse
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
accountTyperequiredstringTransaction Type must be either Checking('C') or Savings('S').
creditDebitCoderequiredstringCredit Debit Code must be either Credit('C') or Debit('D').
transactionTyperequiredstringTransaction Type must be either Live('L') or Prenote('P') or Zero ('Z').
receivingDFIIdrequiredstringReceiving DFI ID can be maximum of 8 digits.
checkDigitrequiredstringCheck digit is 1 numeric digit.
DFIAccountNumberrequiredstringDFI Account Number can be maximum of 17 characters.
amountrequiredstringAmount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal.
individualIdentificationNumberoptionalstringOptional. Individual Identification Number with a maximum of 15 characters.
individualNamerequiredstringRequired. Individual Name field with a maximum of 22 characters.
paymentTypeCodeoptionalstringPayment type code with maximum of 2 characters. Filled with 2 spaces character in the generated ACH transaction if not provided by the client.
NAMETYPEDESCRIPTION
uuidrequiredstringUUID 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.
accountTyperequiredstringTransaction Type must be either Checking('C') or Savings('S').
creditDebitCoderequiredstringCredit Debit Code must be either Credit('C') or Debit('D').
transactionTyperequiredstringTransaction Type must be either Live('L') or Prenote('P') or Zero ('Z').
receivingDFIIdrequiredstringReceiving DFI ID can be maximum of 8 digits.
checkDigitrequiredstringCheck digit is 1 numeric digit.
DFIAccountNumberrequiredstringDFI Account Number can be maximum of 17 characters.
amountrequiredstringAmount To in valid currency format. Its size is 8 digits before the decimal and 2 digits after the decimal.
individualIdentificationNumberoptionalstringIndividual Identification Number with maximum 15 characters.
individualNamerequiredstringIndividual Name field with maximum of 22 characters.
paymentTypeCodeoptionalstringPayment type code with maximum of 2 characters. Filled with 2 spaces character in the generated ACH transaction if not provided by the client.
addendaoptionalarraybaseAddendaRequest

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.

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.

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.

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.

Mandatory data not provided, please verify the data, and resubmit the request.

401 Received request is unauthorized.

Received request is unauthorized, please provide valid credentials.

403 Request is forbidden to access the resource.

Access to requested resource is forbidden.

404 Request resource is not found.

Requested resource is not found, please verify the resource, and resubmit the request.

405 Request method is not allowed.

Requested method is not allow, please verify the method, and resubmit the request.

415 Requested unsupported media type.

Requested media type is not allowed, please verify the media type, and resubmit the request.

429 Too many request received.

Number requests threshold reached, please resubmit the request after sometime.

500 Internal server error.

Unknown error occurred, please resubmit the request.

502 Bad Gateway.

Bad Gateway, please resubmit the request.

503 Service Unavailable.

Service is currently unavailable, please resubmit the request.

504 Gateway timeout.

Request could not be processed on time, please resubmit the request.


YAML file