Exception Items

openapi: 3.0.3 info: version: v1 title: Exception Item Processing API - Exception Items description: Digital Core Exception Item Processing API - Management of a Financial Institution's Exception Item Processing contact: name: Digital Core @ Jack Henry and Associates, inc. url: https://www.jackhenry.com/ email: DC-Operations@jackhenry.com servers: - url: https://{API_ENDPOINT} variables: API_ENDPOINT: default: digital.garden-fi.com security: - bearerAuth: [] tags: - name: Exception Items description: APIs for managing exception items paths: /a/api/eip/v1/{InstitutionUniversalId}/exception-items: post: tags: - Exception Items summary: API to Create Exception Item description: API to Create Exception Item operationId: ExceptionItemAdd parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string requestBody: content: application/json: schema: required: - transactionExceptionType type: object properties: transactionExceptionType: type: string nullable: false description: The EIP type will define Exception Type assigned to transaction. enum: - Charge Back - Charged Off Account - Closed Account - Credit Back - Dormant Account - Duplicate - Escheated Account - Invalid Transaction Data - Non Sufficient Funds - Other - Overdraft - Positive Pay Review - Restricted Account - Stop Payment Match - Stop Payment Suspect - Unable To Locate - Uncollected Funds exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. nullable: false transactionStatus: type: string description: This attribute identifies the posting status of the exception. enum: - Unspecified - Posted - NonPosted nullable: true transactionExceptionDescription: type: string description: This attribute will provide the reason why the transaction could not be posted. nullable: true decision: type: string description: The attribute defines the requested outcome of the exception item. enum: - No Action - Retry - Manual Post - Return - Force Post default: No Action nullable: true transactionDate: type: string format: date description: This attribute will return the transaction date that was used when the transaction posted. nullable: true effectiveDate: type: string nullable: true format: date description: This attribute defines the effective date of the transaction. accountType: type: array description: Used to store the updated account type associated with the account. This is used for display purposes only. The Source of truth for the account type is the originator of the record. items: type: string enum: - Checking - Savings - Loan - Club - Certificate Of Deposit - General Ledger - Overdraft Protection - Unspecified nullable: true accountNumber: type: string maxLength: 40 description: The corrected account number where transaction posted. nullable: true accountId: type: string maxLength: 40 format: UUID description: The corrected account id where transaction posted. nullable: true branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution nullable: true transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. nullable: true transactionCodeDescription: type: string description: This attribute will provide the transaction description that defines the behavior of the transaction. nullable: true debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified nullable: true transactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. nullable: true description: type: string maxLength: 100 description: Optional description. nullable: true transactionId: type: string format: uuid description: This attribute dentifies the source or origin of the transaction. nullable: true transactionType: type: string description: This attribute identifies originator of transaction. enum: - ACH - Check - ATM - AFT - Unspecified nullable: true checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. nullable: true onUsReturn: type: boolean description: This attribute is used to specify if the return is handled internally at the FI or not. Default value “false” if no value is provided. nullable: true returnReason: type: string nullable: true description: This attribute is used to specify the reason for return and specific to transaction type. feeDecision: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. nullable: true enum: - Waive - Charge - No Action default: No Action feeWaiveReason: type: string description: This attribute is used to specify the reason for waiving the fee. nullable: true enum: - Financial Hardship - Promotional or Specialoffer - GoodStanding or Loyalty - Service Issue - Charitable or Nonprofit - Government or Regulatory Requirements - Referral or Affiliate Programs - Education or Non Commercial Use - Trial Period Partnership Agreements - Error or Mistake - Not Applicable feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true assessedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount assessed for transaction. nullable: true calculatedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount that was calculated for the debit. nullable: true feeDescription: type: string maxLength: 80 description: This attribute is used to specify the description of the fee that may be printed on the customer statement. nullable: true printNotice: type: string description: This attribute is used to specify if the notices are printed or not. Default to "No Action" if no value is provided. nullable: true enum: - No Action - 'Yes' - 'No' default: No Action externalId: type: string description: Unique identifier within any third-party integration. nullable: true responses: '201': description: Created content: application/json: schema: type: object properties: id: type: string format: UUID nullable: false createdDateTime: type: string format: date-time nullable: false status: type: string description: Indicates the user defined progress of an exception item for workflow management purposes. nullable: false enum: - New - In Progress - On Hold - Pending Approval - Done default: New exceptionState: type: string description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic. nullable: false enum: - Ready - Error - Resolved - Settled - Settled Externally default: Ready transactionExceptionType: type: string nullable: false description: The EIP type will define Exception Type assigned to transaction. enum: - Charge Back - Charged Off Account - Closed Account - Credit Back - Dormant Account - Duplicate - Escheated Account - Invalid Transaction Data - Non Sufficient Funds - Other - Overdraft - Positive Pay Review - Restricted Account - Stop Payment Match - Stop Payment Suspect - Unable To Locate - Uncollected Funds '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}: get: tags: - Exception Items description: API to Get Exception Item By Id summary: API to Get Exception Item By Id operationId: ExceptionItemInquiry parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: UUID status: type: string description: Indicates the user defined progress of an exception item for workflow management purposes. enum: - New - In Progress - On Hold - Pending Approval - Done default: New exceptionState: type: string description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic enum: - Ready - Error - Resolved - Settled - Settled Externally createdDateTime: type: string format: date-time lastChangedDateTime: type: string format: date-time lastChangedBy: type: string description: The UserId who last updated the Exception Item. createdBy: type: string description: The UserId who created the Exception Item. transactionExceptionType: type: string nullable: false description: The EIP type will define Exception Type assigned to transaction. enum: - Charge Back - Charged Off Account - Closed Account - Credit Back - Dormant Account - Duplicate - Escheated Account - Invalid Transaction Data - Non Sufficient Funds - Other - Overdraft - Positive Pay Review - Restricted Account - Stop Payment Match - Stop Payment Suspect - Unable To Locate - Uncollected Funds exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. nullable: true transactionStatus: type: string description: This attribute identifies the posting status of the exception. enum: - Unspecified - Posted - NonPosted nullable: true transactionExceptionDescription: type: string description: This attribute will provide the reason why the transaction could not be posted. nullable: true decision: type: string description: The attribute defines the requested outcome of the exception item. enum: - No Action - Retry - Manual Post - Return - Force Post default: No Action transactionDate: type: string format: date description: This attribute will return the transaction date that was used when the transaction posted. nullable: true effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction. nullable: true accountId: type: string format: UUID description: The most recent account ID and the unique identifier for the account. nullable: true originalAccountId: type: string format: UUID description: The original account ID and the unique identifier for the account. nullable: true accountNumber: type: string maxLength: 40 description: The most recent account number associated with the account identifier. nullable: true originalAccountNumber: type: string maxLength: 40 description: The original account number associated with the account identifier. nullable: true accountType: type: string description: The most recent account type that defines the type of product. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger nullable: true originalAccountType: type: string description: The original account type that defines the type of product. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger nullable: true branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution nullable: true transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. nullable: true originalTransactionCode: type: string description: This attribute will provide the original transaction code that defines the behavior of the transaction. nullable: true transactionCodeDescription: type: string description: This attribute will provide the transaction description that defines the behavior of the transaction. nullable: true originalTransactionCodeDescription: type: string description: This attribute will provide the original transaction description that defines the behavior of the transaction. nullable: true debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified nullable: true transactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. nullable: true description: type: string maxLength: 100 description: Optional description. nullable: true assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. nullable: true transactionType: type: string description: This attribute identifies originator of transaction. enum: - ACH - Check - ATM - AFT - Unspecified nullable: true checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. nullable: true originalCheckNumber: type: string description: This attribute dentifies the original check Number associated with transaction. nullable: true onUsReturn: type: boolean description: This attribute is used to specify if the return is handled internally at the FI or not. Default value “false” if no value is provided. nullable: true returnReason: nullable: true description: This attribute is used to specify the reason for return and specific to transaction type. type: string feeDecision: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. nullable: true enum: - Waive - Charge - Fee Limit Reached - No Action default: No Action feeWaiveReason: type: string description: This attribute is used to specify the reason for waiving the fee. nullable: true enum: - Financial Hardship - Promotional or Specialoffer - GoodStanding or Loyalty - Service Issue - Charitable or Nonprofit - Government or Regulatory Requirements - Referral or Affiliate Programs - Education or Non Commercial Use - Trial Period Partnership Agreements - Error or Mistake - Not Applicable feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true assessedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount assessed for transaction. nullable: true calculatedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount that was calculated for the debit. nullable: true feeDescription: type: string maxLength: 80 description: This attribute is used to specify the description of the fee that may be printed on the customer statement. nullable: true printNotice: type: string description: This attribute is used to specify if the notices are printed or not. nullable: true enum: - 'Yes' - 'No' - No Action default: No Action officerId: type: string description: A unique identifier for the officer or employee associated with the account. nullable: true nameOnAccount: type: string description: The name of the account holder or authorized entity associated with the account. nullable: true externalError: type: string description: Most recent error string returned by any third-party integration. nullable: true externalErrorCode: type: string description: Most recent error code returned by any third-party integration. nullable: true resolvedBy: type: string description: The identifier of the user, system, or process that resolved the exception item. nullable: true resolvedDateTime: type: string format: date-time description: The date and time when the Exception Item was resolved. nullable: true '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error patch: tags: - Exception Items description: API to Update Exception Item summary: API to Update Exception Item operationId: ExceptionItemUpdatePatch parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/merge-patch+json: schema: type: object properties: status: type: string description: Indicates the user defined progress of an exception item for workflow management purposes. - New - In Progress - On Hold - Pending Approval - Done default: New accountNumber: type: string maxLength: 40 description: The corrected account number where transaction posted. accountId: type: string maxLength: 40 format: UUID description: The corrected account id where transaction posted. accountType: type: string description: Used to store the updated account type associated with the account. This is used for display purposes only. The Source of truth for the account type is the originator of the record. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger - Overdraft Protection - Unspecified transactionCode: type: string description: The corrected transaction code for the exception item. description: type: string description: Extra details a user can provide about the exception item checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction. assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. externalId: type: string description: Unique identifier within any third-party integration. nullable: true externalError: type: string description: Most recent error string returned by any third-party integration. nullable: true externalErrorCode: type: string description: Most recent error code returned by any third-party integration. nullable: true additionalProperties: false responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/decision: patch: tags: - Exception Items description: API to Update Decision summary: API to Update Decision operationId: ExceptionItemUpdatePatchDecision parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/merge-patch+json: schema: type: object properties: decision: type: string description: This attribute defines the requested outcome of the exception item. - No Action - Retry - Manual Post - Return - Force Post default: No Action onUsReturn: type: boolean description: This attribute is used to specify if the return is handled internally at the FI or not. Default value “false” if no value is provided. nullable: true returnReason: nullable: true description: This attribute is used to specify the reason for return and specific to transaction type. type: string responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/fee-decision: patch: tags: - Exception Items description: API to Update Fee-Decision summary: API to Update Fee-Decision operationId: ExceptionItemUpdatePatchFeeDecision parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/merge-patch+json: schema: type: object properties: feeDecision: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. nullable: true enum: - Waive - Charge - No Action default: No Action feeWaiveReason: type: string description: This attribute is used to specify the reason for waiving the fee. nullable: true enum: - Financial Hardship - Promotional or Specialoffer - GoodStanding or Loyalty - Service Issue - Charitable or Nonprofit - Government or Regulatory Requirements - Referral or Affiliate Programs - Education or Non Commercial Use - Trial Period Partnership Agreements - Error or Mistake - Not Applicable feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true assessedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount assessed for transaction. nullable: true calculatedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount that was calculated for the debit. nullable: true feeDescription: type: string maxLength: 80 description: This attribute is used to specify the description of the fee that may be printed on the customer statement. nullable: true printNotice: type: string description: This attribute is used to specify if the notices are printed or not. nullable: true enum: - 'Yes' - 'No' - No Action default: No Action responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/account-inquiry: get: tags: - Exception Items summary: API to Get Account Inquiry By Exception Item Id description: API to Get Account Inquiry By Exception Item Id operationId: GetAccountInquiry parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: OK content: application/json: schema: type: object required: - id - availableBalance - currentBalance - overdraftLimit - accountStatus - accountOpenDate - accountNumber - accountType properties: id: type: string format: UUID description: Unique identifier for exception item. availableBalance: type: string description: The available balance for the account. nullable: false currentBalance: type: string description: The current balance for the account. nullable: false overdraftLimit: type: string description: The overdraft limit for the account. nullable: false accountStatus: type: string description: This enum defines the possible account status values. enum: - Escheat - Active - Closed - Dormant - New Today - Pending Close - Restricted - No post - Charged Off - No Credits accountOpenDate: type: string format: date description: The date when the account was opened. nullable: false accountNumber: type: string description: The account number. nullable: false accountType: type: string description: The type of account. nullable: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/resolve: post: tags: - Exception Items description: API to Resolve Exception Item summary: API to Resolve Exception Item operationId: ExceptionItemResolve parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '204': description: No Content content: application/json: schema: type: object properties: messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items-search: post: tags: - Exception Items description: API to Search Exception Item summary: API to Search Exception Item operationId: ExceptionItemSearch parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: ?offset=50 schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: ?count=100 schema: type: string default: '100' - name: sort required: false in: query description: The key sorting list separated by commas. The order may be defaulted by the server or included in path example: ?sort=field1:direction,field2:direction schema: type: string requestBody: content: application/json: schema: required: - startDate - endDate type: object properties: startDate: type: string format: date nullable: false endDate: type: string format: date nullable: false exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. nullable: true transactionStatus: type: array items: type: string example: '[''NonPosted'', ''Posted'']' description: The transaction status indicating if it was Posted to GL or not. Searches the store with IN filter (transactionStatus IN ('NonPosted', 'Posted')) nullable: true transactionExceptionType: type: array items: type: string example: '[''Unable To Locate'', ''Restricted Account'', ''Other'']' description: The EIP type will define Exception Type assigned to transaction. Searches the store with IN filter (transactionExceptionType IN ('Unable To Locate', 'Restricted Account')) nullable: true decision: type: array items: type: string example: '[''No Action'', ''Manual Post'']' description: The attribute will defines the requested outcome of the exception item. Initialize to "No Action". Searches the store with IN filter (decision IN ('No Action', 'ManualPost')) nullable: true status: type: array items: type: string example: '[''New'', ''In Progress'', ''Done'']' description: Stores the current status of the exception item. Searches the store with IN filter (status IN ('New', 'InProgress', 'Done')) nullable: true exceptionState: type: array items: type: string example: '[''Ready'', ''Settled Externally'']' description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic Searches the store with IN filter (exceptionState IN ('Ready', 'Settled Externally')) nullable: true accountNumber: type: string maxLength: 40 description: Used to store the updated account number associated with the account. This is used for display purposes only. The Source of truth for the account number is the originator of the record. nullable: true originalAccountNumber: type: string maxLength: 40 description: As received from the source of the record. This cannot be changed in EIP. nullable: true accountType: type: array items: type: string example: '[ ''Checking'', ''Savings'', ''Loan'', ''Club'', ''Certificate of Deposit'', ''General Ledger'' ]' description: Used to store the updated account type associated with the account. This is used for display purposes only. The Source of truth for the account type is the originator of the record. nullable: true originalAccountType: type: array items: type: string example: '[ ''Checking'', ''Savings'', ''Loan'', ''Club'', ''Certificate of Deposit'', ''General Ledger'' ]' description: As received from the source of the record. This cannot be changed in EIP. nullable: true branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution nullable: true debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified nullable: true minimumTransactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true maximumTransactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. nullable: true originalTransactionCode: type: string description: As received from the source of the record. This cannot be changed in EIP. nullable: true transactionCodeDescription: type: string description: This attribute will provide the transaction description that defines the behavior of the transaction. nullable: true originalTransactionCodeDescription: type: string description: This attribute will provide the original transaction description that defines the behavior of the transaction. nullable: true transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. nullable: true assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. nullable: true transactionType: type: array items: type: string example: '[''ACH'', ''Check'', ''ATM'', ''AFT'', ''Unspecified'']' description: This attribute identifies originator of transaction. nullable: true checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. nullable: true originalCheckNumber: type: string description: This attribute dentifies the original check Number associated with transaction. nullable: true returnReason: type: array items: type: string description: This attribute is used to specify the reason for return and is specific to transaction type. Searches the store with IN filter. nullable: true feeDecision: type: array items: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. Searches the store with IN filter. nullable: true feeWaiveReason: type: array items: type: string description: This attribute is used to specify the reason for waiving the fee. Searches the store with IN filter. nullable: true feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true officerId: type: string description: A unique identifier for the officer or employee associated with the account. nullable: true externalId: type: string nullable: true description: Unique identifier within any third-party integration. nameOnAccount: type: string description: The name of the account holder or authorized entity associated with the account. nullable: true description: type: string description: Optional description used when searching for exception items. nullable: true responses: '200': description: OK content: application/json: schema: type: object properties: messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string paging: type: object properties: nextOffset: description: 'The next offset is the start position of the read pointer for pagination ' type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer exceptionItems: type: array items: type: object properties: id: type: string format: UUID status: type: string description: Indicates the user defined progress of an exception item for workflow management purposes. nullable: false enum: - New - In Progress - On Hold - Pending Approval - Done default: New exceptionState: type: string description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic enum: - Ready - Error - Resolved - Settled - Settled Externally transactionExceptionType: type: string nullable: false description: The EIP type will define Exception Type assigned to transaction. enum: - Charge Back - Charged Off Account - Closed Account - Credit Back - Dormant Account - Duplicate - Escheated Account - Invalid Transaction Data - Non Sufficient Funds - Other - Overdraft - Positive Pay Review - Restricted Account - Stop Payment Match - Stop Payment Suspect - Unable To Locate - Uncollected Funds transactionStatus: type: string description: This attribute identifies the posting status of the exception. enum: - Unspecified - Posted - NonPosted nullable: true transactionDate: type: string format: date description: This attribute will return the transaction date that was used when the transaction posted. nullable: true decision: type: string description: The attribute will defines the requested outcome of the exception item. enum: - No Action - Retry - Manual Post - Return - Force Post default: No Action exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. nullable: true assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. nullable: true createdBy: type: string lastChangedBy: type: string createdDateTime: type: string format: date-time lastChangedDateTime: type: string format: date-time branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution nullable: true debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified nullable: true description: type: string nullable: true transactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true transactionExceptionDescription: type: string nullable: true transactionId: type: string nullable: true transactionType: type: string description: This attribute identifies the originator of the transaction. enum: - ACH - Check - ATM - AFT - Unspecified nullable: true transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. nullable: true originalAccountId: type: string nullable: true accountId: type: string nullable: true accountNumber: type: string maxLength: 40 description: Used to store the updated account number associated with the account. This is used for display purposes only. The Source of truth for the account number is the originator of the record. nullable: true originalAccountNumber: type: string maxLength: 40 description: As received from the source of the record. This cannot be changed in EIP. nullable: true transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. nullable: true originalTransactionCode: type: string description: As received from the source of the record. This cannot be changed in EIP. nullable: true accountType: type: string description: Used to store the updated account type associated with the account. This is used for display purposes only. The Source of truth for the account type is the originator of the record. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger nullable: true originalAccountType: type: string description: As received from the source of the record. This cannot be changed in EIP. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger nullable: true checkNumber: type: string description: This attribute identifies the check Number associated with transaction. nullable: true originalCheckNumber: type: string description: This attribute identifies the original check Number associated with transaction. nullable: true effectiveDate: type: string format: date nullable: true returnReason: type: string nullable: true onUsReturn: type: boolean nullable: true feeDecision: type: string feeWaiveReason: type: string feeWaivedBy: type: string nullable: true feeDescription: type: string nullable: true printNotice: type: string assessedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true calculatedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true externalId: type: string nullable: true officerId: type: string description: A unique identifier for the officer or employee associated with the account. nameOnAccount: type: string description: The name of the account holder or authorized entity associated with the account. required: - id - status - createdBy - lastChangedBy - createdDateTime - lastChangedDateTime '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items-export: post: tags: - Exception Items description: API to Export Exception Item summary: API to Export Exception Item operationId: ExceptionItemExport parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: sort required: false in: query description: The key sorting list separated by commas. The order may be defaulted by the server or included in path example: ?sort=field1:direction,field2:direction schema: type: string requestBody: content: application/json: schema: required: - startDate - endDate type: object properties: startDate: type: string format: date nullable: false endDate: type: string format: date nullable: false exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. nullable: true transactionStatus: type: array items: type: string example: '[''NonPosted'', ''Posted'']' description: The transaction status indicating if it was Posted to GL or not. Searches the store with IN filter (transactionStatus IN ('NonPosted', 'Posted')) nullable: true transactionExceptionType: type: array items: type: string example: '[''Unable To Locate'', ''Restricted Account'', ''Other'']' description: The EIP type will define Exception Type assigned to transaction. Searches the store with IN filter (transactionExceptionType IN ('Unable To Locate', 'Restricted Account')) nullable: true decision: type: array items: type: string example: '[''No Action'', ''Manual Post'']' description: The attribute will defines the requested outcome of the exception item. Initialize to "No Action". Searches the store with IN filter (decision IN ('No Action', 'ManualPost')) nullable: true status: type: array items: type: string example: '[''New'', ''In Progress'', ''Done'']' description: Stores the current status of the exception item. Searches the store with IN filter (status IN ('New', 'InProgress', 'Done')) nullable: true exceptionState: type: array items: type: string example: '[''Ready'', ''Settled Externally'']' description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic Searches the store with IN filter (exceptionState IN ('Ready', 'Settled Externally')) nullable: true accountNumber: type: string maxLength: 40 description: Used to store the updated account number associated with the account. This is used for display purposes only. The Source of truth for the account number is the originator of the record. nullable: true originalAccountNumber: type: string maxLength: 40 description: As received from the source of the record. This cannot be changed in EIP. nullable: true accountType: type: array items: type: string example: '[ ''Checking'', ''Savings'', ''Loan'', ''Club'', ''Certificate of Deposit'', ''General Ledger'' ]' description: Used to store the updated account type associated with the account. This is used for display purposes only. The Source of truth for the account type is the originator of the record. nullable: true originalAccountType: type: array items: type: string example: '[ ''Checking'', ''Savings'', ''Loan'', ''Club'', ''Certificate of Deposit'', ''General Ledger'' ]' description: As received from the source of the record. This cannot be changed in EIP. nullable: true branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution nullable: true debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified nullable: true minimumTransactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true maximumTransactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. nullable: true originalTransactionCode: type: string description: As received from the source of the record. This cannot be changed in EIP. nullable: true transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. nullable: true assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. nullable: true transactionType: type: array items: type: string example: '[''ACH'', ''Check'', ''ATM'', ''AFT'', ''Unspecified'']' description: This attribute identifies originator of transaction. nullable: true checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. nullable: true originalCheckNumber: type: string description: This attribute dentifies the original check Number associated with transaction. nullable: true returnReason: type: array items: type: string description: This attribute is used to specify the reason for return and is specific to transaction type. Searches the store with IN filter. nullable: true feeDecision: type: array items: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. Searches the store with IN filter. nullable: true feeWaiveReason: type: array items: type: string description: This attribute is used to specify the reason for waiving the fee. Searches the store with IN filter. nullable: true feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: UUID createdDateTime: type: string format: date-time lastChangedDateTime: type: string format: date-time lastChangedBy: type: string description: The UserId who last updated the Exception Item. createdBy: type: string description: The UserId who created the Exception Item. exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. status: type: string description: Indicates the user defined progress of an exception item for workflow management purposes. enum: - New - In Progress - On Hold - Pending Approval - Done default: New exceptionState: type: string description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic enum: - Ready - Error - Resolved - Settled - Settled Externally transactionStatus: type: string description: This attribute identifies the posting status of the exception. enum: - Unspecified - Posted - NonPosted transactionExceptionDescription: type: string description: This attribute will provide the reason why the transaction could not be posted. decision: type: string description: The attribute defines the requested outcome of the exception item. enum: - No Action - Retry - Manual Post - Return - Force Post default: No Action transactionDate: type: string format: date description: This attribute will return the transaction date that was used when the transaction posted. effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction. transactionExceptionType: type: string nullable: false description: The EIP type will define Exception Type assigned to transaction. enum: - Charge Back - Charged Off Account - Closed Account - Credit Back - Dormant Account - Duplicate - Escheated Account - Invalid Transaction Data - Non Sufficient Funds - Other - Overdraft - Positive Pay Review - Restricted Account - Stop Payment Match - Stop Payment Suspect - Unable To Locate - Uncollected Funds assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. originalAccountId: type: string description: The original account ID and the unique identifier for the account. accountId: type: string description: The most recent account ID and the unique identifier for the account. accountNumber: type: string maxLength: 40 description: Used to store the updated account number associated with the account. This is used for display purposes only. The Source of truth for the account number is the originator of the record. originalAccountNumber: type: string maxLength: 40 description: As received from the source of the record. This cannot be changed in EIP. branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. originalTransactionCode: type: string description: This attribute will provide the original transaction code that defines the behavior of the transaction. debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified transactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. description: type: string maxLength: 100 description: Optional description. transactionId: type: string format: uuid description: This attribute dentifies the source or origin of the transaction. transactionType: type: string description: This attribute identifies originator of transaction. enum: - ACH - Check - ATM - AFT - Unspecified checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. originalCheckNumber: type: string description: This attribute dentifies the original check Number associated with transaction. returnReason: type: string description: This attribute is used to specify the reason for return and specific to transaction type. onUsReturn: type: boolean description: This attribute is used to specify if the return is handled internally at the FI or not. Default value “false” if no value is provided. feeDecision: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. nullable: true enum: - Waive - Charge - Fee Limit Reached - No Action default: No Action feeWaiveReason: type: string description: This attribute is used to specify the reason for waiving the fee. nullable: true enum: - Financial Hardship - Promotional or Specialoffer - GoodStanding or Loyalty - Service Issue - Charitable or Nonprofit - Government or Regulatory Requirements - Referral or Affiliate Programs - Education or Non Commercial Use - Trial Period Partnership Agreements - Error or Mistake - Not Applicable feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true assessedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount assessed for transaction. nullable: true calculatedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount that was calculated for the debit. nullable: true feeDescription: type: string maxLength: 80 description: This attribute is used to specify the description of the fee that may be printed on the customer statement. nullable: true printNotice: type: string description: This attribute is used to specify if the notices are printed or not. nullable: true enum: - 'Yes' - 'No' - No Action default: No Action externalId: type: string description: Unique identifier within any third-party integration. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/consumer/{ConsumerUserId}/exception-items/{Id}: get: tags: - Exception Items description: API to Get Exception Item By Id for Consumer User summary: API to Get Exception Item By Id for Consumer User operationId: ExceptionItemInquiryConsumer parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: ConsumerUserId required: true schema: type: string format: uuid description: The ID of the consumer user. - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: UUID status: type: string description: Indicates the user defined progress of an exception item for workflow management purposes. enum: - New - In Progress - On Hold - Pending Approval - Done default: New exceptionState: type: string description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic enum: - Ready - Error - Resolved - Settled - Settled Externally createdDateTime: type: string format: date-time lastChangedDateTime: type: string format: date-time lastChangedBy: type: string description: The UserId who last updated the Exception Item. createdBy: type: string description: The UserId who created the Exception Item. transactionExceptionType: type: string nullable: false description: The EIP type will define Exception Type assigned to transaction. enum: - Charge Back - Charged Off Account - Closed Account - Credit Back - Dormant Account - Duplicate - Escheated Account - Invalid Transaction Data - Non Sufficient Funds - Other - Overdraft - Positive Pay Review - Restricted Account - Stop Payment Match - Stop Payment Suspect - Unable To Locate - Uncollected Funds exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. nullable: true transactionStatus: type: string description: This attribute identifies the posting status of the exception. enum: - Unspecified - Posted - NonPosted nullable: true transactionExceptionDescription: type: string description: This attribute will provide the reason why the transaction could not be posted. nullable: true decision: type: string description: The attribute defines the requested outcome of the exception item. enum: - No Action - Retry - Manual Post - Return - Force Post default: No Action transactionDate: type: string format: date description: This attribute will return the transaction date that was used when the transaction posted. nullable: true effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction. nullable: true accountId: type: string format: UUID description: The most recent account ID and the unique identifier for the account. nullable: true originalAccountId: type: string format: UUID description: The original account ID and the unique identifier for the account. nullable: true accountNumber: type: string maxLength: 40 description: The most recent account number associated with the account identifier. nullable: true originalAccountNumber: type: string maxLength: 40 description: The original account number associated with the account identifier. nullable: true accountType: type: string description: The most recent account type that defines the type of product. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger nullable: true originalAccountType: type: string description: The original account type that defines the type of product. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger nullable: true branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution nullable: true transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. nullable: true originalTransactionCode: type: string description: This attribute will provide the original transaction code that defines the behavior of the transaction. nullable: true transactionCodeDescription: type: string description: This attribute will provide the transaction description that defines the behavior of the transaction. nullable: true originalTransactionCodeDescription: type: string description: This attribute will provide the original transaction description that defines the behavior of the transaction. nullable: true debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified nullable: true transactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. nullable: true description: type: string maxLength: 100 description: Optional description. nullable: true assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. nullable: true transactionType: type: string description: This attribute identifies originator of transaction. enum: - ACH - Check - ATM - AFT - Unspecified nullable: true checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. nullable: true originalCheckNumber: type: string description: This attribute dentifies the original check Number associated with transaction. nullable: true onUsReturn: type: boolean description: This attribute is used to specify if the return is handled internally at the FI or not. Default value “false” if no value is provided. nullable: true returnReason: nullable: true description: This attribute is used to specify the reason for return and specific to transaction type. type: string feeDecision: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. nullable: true enum: - Waive - Charge - Fee Limit Reached - No Action default: No Action feeWaiveReason: type: string description: This attribute is used to specify the reason for waiving the fee. nullable: true enum: - Financial Hardship - Promotional or Specialoffer - GoodStanding or Loyalty - Service Issue - Charitable or Nonprofit - Government or Regulatory Requirements - Referral or Affiliate Programs - Education or Non Commercial Use - Trial Period Partnership Agreements - Error or Mistake - Not Applicable feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true assessedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount assessed for transaction. nullable: true calculatedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount that was calculated for the debit. nullable: true feeDescription: type: string maxLength: 80 description: This attribute is used to specify the description of the fee that may be printed on the customer statement. nullable: true printNotice: type: string description: This attribute is used to specify if the notices are printed or not. nullable: true enum: - 'Yes' - 'No' - No Action default: No Action officerId: type: string description: A unique identifier for the officer or employee associated with the account. nullable: true nameOnAccount: type: string description: The name of the account holder or authorized entity associated with the account. nullable: true externalError: type: string description: Most recent error string returned by any third-party integration. nullable: true externalErrorCode: type: string description: Most recent error code returned by any third-party integration. nullable: true resolvedBy: type: string description: The identifier of the user, system, or process that resolved the exception item. nullable: true resolvedDateTime: type: string format: date-time description: The date and time when the Exception Item was resolved. nullable: true '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error patch: tags: - Exception Items description: API to Update Exception Item for Consumer User summary: API to Update Exception Item for Consumer User operationId: ExceptionItemUpdatePatchConsumer parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: ConsumerUserId required: true schema: type: string format: uuid description: The ID of the consumer user. - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/merge-patch+json: schema: type: object properties: status: type: string description: Indicates the user defined progress of an exception item for workflow management purposes. - New - In Progress - On Hold - Pending Approval - Done default: New accountNumber: type: string maxLength: 40 description: The corrected account number where transaction posted. accountId: type: string maxLength: 40 format: UUID description: The corrected account id where transaction posted. accountType: type: string description: Used to store the updated account type associated with the account. This is used for display purposes only. The Source of truth for the account type is the originator of the record. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger - Overdraft Protection - Unspecified transactionCode: type: string description: The corrected transaction code for the exception item. description: type: string description: Extra details a user can provide about the exception item checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. effectiveDate: type: string format: date description: This attribute defines the effective date of the transaction. assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. externalId: type: string description: Unique identifier within any third-party integration. nullable: true externalError: type: string description: Most recent error string returned by any third-party integration. nullable: true externalErrorCode: type: string description: Most recent error code returned by any third-party integration. nullable: true additionalProperties: false responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/consumer/{ConsumerUserId}/exception-items/{Id}/decision: patch: tags: - Exception Items description: API to Update Decision for Consumer User summary: API to Update Decision for Consumer User operationId: ExceptionItemUpdatePatchDecisionConsumer parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: ConsumerUserId required: true schema: type: string format: uuid description: The ID of the consumer user. - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/merge-patch+json: schema: type: object properties: decision: type: string description: This attribute defines the requested outcome of the exception item. - No Action - Retry - Manual Post - Return - Force Post default: No Action onUsReturn: type: boolean description: This attribute is used to specify if the return is handled internally at the FI or not. Default value “false” if no value is provided. nullable: true returnReason: nullable: true description: This attribute is used to specify the reason for return and specific to transaction type. type: string responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/consumer/{ConsumerUserId}/exception-items/{Id}/fee-decision: patch: tags: - Exception Items description: API to Update Fee-Decision for Consumer User summary: API to Update Fee-Decision for Consumer User operationId: ExceptionItemUpdatePatchFeeDecisionConsumer parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: ConsumerUserId required: true schema: type: string format: uuid description: The ID of the consumer user. - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/merge-patch+json: schema: type: object properties: feeDecision: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. nullable: true enum: - Waive - Charge - No Action default: No Action feeWaiveReason: type: string description: This attribute is used to specify the reason for waiving the fee. nullable: true enum: - Financial Hardship - Promotional or Specialoffer - GoodStanding or Loyalty - Service Issue - Charitable or Nonprofit - Government or Regulatory Requirements - Referral or Affiliate Programs - Education or Non Commercial Use - Trial Period Partnership Agreements - Error or Mistake - Not Applicable feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true assessedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount assessed for transaction. nullable: true calculatedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false description: This attribute is used to specify the fee amount that was calculated for the debit. nullable: true feeDescription: type: string maxLength: 80 description: This attribute is used to specify the description of the fee that may be printed on the customer statement. nullable: true printNotice: type: string description: This attribute is used to specify if the notices are printed or not. nullable: true enum: - 'Yes' - 'No' - No Action default: No Action responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/consumer/{ConsumerUserId}/exception-items/{Id}/resolve: post: tags: - Exception Items description: API to Resolve Exception Item for Consumer User summary: API to Resolve Exception Item for Consumer User operationId: ExceptionItemResolveConsumer parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: ConsumerUserId required: true schema: type: string format: uuid description: The ID of the consumer user. - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '204': description: No Content content: application/json: schema: type: object properties: messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message. required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated) required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/consumer/{ConsumerUserId}/exception-items-search: post: tags: - Exception Items description: API to Search Exception Item for Consumer User summary: API to Search Exception Item for Consumer User operationId: ExceptionItemSearchConsumer parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - in: path name: ConsumerUserId required: true schema: type: string format: uuid description: The ID of the consumer user. - name: offset in: query required: false description: When returning a list of results, the offset determines the number of records to skip before returning the result. If the offset is not provided, the server will return the first set of records. example: ?offset=50 schema: type: string default: '0' - name: count in: query required: false description: The count of records requested. The server may limit the number of records returned in a single response. If the count is not provided, the server will return a default number of records. example: ?count=100 schema: type: string default: '100' - name: sort required: false in: query description: The key sorting list separated by commas. The order may be defaulted by the server or included in path example: ?sort=field1:direction,field2:direction schema: type: string requestBody: content: application/json: schema: required: - startDate - endDate type: object properties: startDate: type: string format: date nullable: false endDate: type: string format: date nullable: false exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. nullable: true transactionStatus: type: array items: type: string example: '[''NonPosted'', ''Posted'']' description: The transaction status indicating if it was Posted to GL or not. Searches the store with IN filter (transactionStatus IN ('NonPosted', 'Posted')) nullable: true transactionExceptionType: type: array items: type: string example: '[''Unable To Locate'', ''Restricted Account'', ''Other'']' description: The EIP type will define Exception Type assigned to transaction. Searches the store with IN filter (transactionExceptionType IN ('Unable To Locate', 'Restricted Account')) nullable: true decision: type: array items: type: string example: '[''No Action'', ''Manual Post'']' description: The attribute will defines the requested outcome of the exception item. Initialize to "No Action". Searches the store with IN filter (decision IN ('No Action', 'ManualPost')) nullable: true status: type: array items: type: string example: '[''New'', ''In Progress'', ''Done'']' description: Stores the current status of the exception item. Searches the store with IN filter (status IN ('New', 'InProgress', 'Done')) nullable: true exceptionState: type: array items: type: string example: '[''Ready'', ''Settled Externally'']' description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic Searches the store with IN filter (exceptionState IN ('Ready', 'Settled Externally')) nullable: true accountNumber: type: string maxLength: 40 description: Used to store the updated account number associated with the account. This is used for display purposes only. The Source of truth for the account number is the originator of the record. nullable: true originalAccountNumber: type: string maxLength: 40 description: As received from the source of the record. This cannot be changed in EIP. nullable: true accountType: type: array items: type: string example: '[ ''Checking'', ''Savings'', ''Loan'', ''Club'', ''Certificate of Deposit'', ''General Ledger'' ]' description: Used to store the updated account type associated with the account. This is used for display purposes only. The Source of truth for the account type is the originator of the record. nullable: true originalAccountType: type: array items: type: string example: '[ ''Checking'', ''Savings'', ''Loan'', ''Club'', ''Certificate of Deposit'', ''General Ledger'' ]' description: As received from the source of the record. This cannot be changed in EIP. nullable: true branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution nullable: true debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified nullable: true minimumTransactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true maximumTransactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. nullable: true originalTransactionCode: type: string description: As received from the source of the record. This cannot be changed in EIP. nullable: true transactionCodeDescription: type: string description: This attribute will provide the transaction description that defines the behavior of the transaction. nullable: true originalTransactionCodeDescription: type: string description: This attribute will provide the original transaction description that defines the behavior of the transaction. nullable: true transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. nullable: true assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. nullable: true transactionType: type: array items: type: string example: '[''ACH'', ''Check'', ''ATM'', ''AFT'', ''Unspecified'']' description: This attribute identifies originator of transaction. nullable: true checkNumber: type: string description: This attribute dentifies the check Number associated with transaction. nullable: true originalCheckNumber: type: string description: This attribute dentifies the original check Number associated with transaction. nullable: true returnReason: type: array items: type: string description: This attribute is used to specify the reason for return and is specific to transaction type. Searches the store with IN filter. nullable: true feeDecision: type: array items: type: string description: This attribute is used to specify the decision made to indicate whether to waive the fee. Searches the store with IN filter. nullable: true feeWaiveReason: type: array items: type: string description: This attribute is used to specify the reason for waiving the fee. Searches the store with IN filter. nullable: true feeWaivedBy: type: string maxLength: 100 description: This attribute is used to specify the officer authorizing waiving the fees. nullable: true officerId: type: string description: A unique identifier for the officer or employee associated with the account. nullable: true externalId: type: string nullable: true description: Unique identifier within any third-party integration. nameOnAccount: type: string description: The name of the account holder or authorized entity associated with the account. nullable: true description: type: string description: Optional description used when searching for exception items. nullable: true responses: '200': description: OK content: application/json: schema: type: object properties: messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string paging: type: object properties: nextOffset: description: 'The next offset is the start position of the read pointer for pagination ' type: string results: description: The number of records sent for pagination type: integer total: description: The total number of records requested for pagination type: integer exceptionItems: type: array items: type: object properties: id: type: string format: UUID status: type: string description: Indicates the user defined progress of an exception item for workflow management purposes. nullable: false enum: - New - In Progress - On Hold - Pending Approval - Done default: New exceptionState: type: string description: Indicates the system controlled lifecycle phase of an exception item. This field is managed exclusively by the application and reflects transitions based on external system interactions and processing logic enum: - Ready - Error - Resolved - Settled - Settled Externally transactionExceptionType: type: string nullable: false description: The EIP type will define Exception Type assigned to transaction. enum: - Charge Back - Charged Off Account - Closed Account - Credit Back - Dormant Account - Duplicate - Escheated Account - Invalid Transaction Data - Non Sufficient Funds - Other - Overdraft - Positive Pay Review - Restricted Account - Stop Payment Match - Stop Payment Suspect - Unable To Locate - Uncollected Funds transactionStatus: type: string description: This attribute identifies the posting status of the exception. enum: - Unspecified - Posted - NonPosted nullable: true transactionDate: type: string format: date description: This attribute will return the transaction date that was used when the transaction posted. nullable: true decision: type: string description: The attribute will defines the requested outcome of the exception item. enum: - No Action - Retry - Manual Post - Return - Force Post default: No Action exceptionSource: type: string description: The ExceptionSource will identify which domain the transaction was originated from. nullable: true assignedTo: type: string description: The UserId who has been assigned to the Exception Item Record. nullable: true createdBy: type: string lastChangedBy: type: string createdDateTime: type: string format: date-time lastChangedDateTime: type: string format: date-time branchId: type: string description: This attribute will provide the Branch associated to the Financial Institution nullable: true debitCredit: type: string description: This attribute defines whether the transaction is a Debit or a Credit to the account. enum: - Debit - Credit - Unspecified nullable: true description: type: string nullable: true transactionAmount: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true transactionExceptionDescription: type: string nullable: true transactionId: type: string nullable: true transactionType: type: string description: This attribute identifies the originator of the transaction. enum: - ACH - Check - ATM - AFT - Unspecified nullable: true transactionSourceTracerNumber: type: string description: This attribute will be a unique tracer number assigned by transaction source. nullable: true originalAccountId: type: string nullable: true accountId: type: string nullable: true accountNumber: type: string maxLength: 40 description: Used to store the updated account number associated with the account. This is used for display purposes only. The Source of truth for the account number is the originator of the record. nullable: true originalAccountNumber: type: string maxLength: 40 description: As received from the source of the record. This cannot be changed in EIP. nullable: true transactionCode: type: string description: Used to store the updated transaction code associated with the account. This is used for display purposes only. The Source of truth for the transaction code is the originator of the record. nullable: true originalTransactionCode: type: string description: As received from the source of the record. This cannot be changed in EIP. nullable: true accountType: type: string description: Used to store the updated account type associated with the account. This is used for display purposes only. The Source of truth for the account type is the originator of the record. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger nullable: true originalAccountType: type: string description: As received from the source of the record. This cannot be changed in EIP. enum: - Checking - Savings - Loan - Club - Certificate of Deposit - General Ledger nullable: true checkNumber: type: string description: This attribute identifies the check Number associated with transaction. nullable: true originalCheckNumber: type: string description: This attribute identifies the original check Number associated with transaction. nullable: true effectiveDate: type: string format: date nullable: true returnReason: type: string nullable: true onUsReturn: type: boolean nullable: true feeDecision: type: string feeWaiveReason: type: string feeWaivedBy: type: string nullable: true feeDescription: type: string nullable: true printNotice: type: string assessedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true calculatedFee: type: object properties: value: type: number description: This defines the amount value. nullable: false currencyType: type: string description: The ISO 4217 three character currency type. USD is the default value. nullable: true default: USD additionalProperties: false nullable: true externalId: type: string nullable: true officerId: type: string description: A unique identifier for the officer or employee associated with the account. nameOnAccount: type: string description: The name of the account holder or authorized entity associated with the account. required: - id - status - createdBy - lastChangedBy - createdDateTime - lastChangedDateTime '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/account-detail: get: tags: - Exception Items description: API to Get Account Details By Id summary: API to Get Account Details By Id operationId: GetAccountDetail parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: UUID description: A unique identifier for an Exception Item officerId: type: string description: A unique identifier for the officer or employee associated with the account. entityNumber: type: string description: A numerical identifier assigned to the entity or organization associated with the account. nameOnAccount: type: string description: The name of the account holder or authorized entity associated with the account. createdDateTime: type: string format: date-time nullable: false transactionDate: type: string format: date description: This attribute will return the date that was used when the transaction was attempted. nullable: false deceasedDate: type: string format: date description: This attribute will return the date that the account holder or authorized entity passed away. nullable: true messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error patch: tags: - Exception Items description: API to Patch Account Details By Id summary: API to Patch Account Details By Id operationId: PatchAccountDetail parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/merge-patch+json: schema: type: object properties: deceasedDate: type: string format: date description: This attribute will return the date that the account holder or authorized entity passed away. nullable: true responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/ach-detail: get: tags: - Exception Items description: API to Get ACH Details By Id summary: API to Get ACH Details By Id operationId: GetAchDetail parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: UUID description: A unique identifier for an Exception Item achCode: type: string description: A key to link up ACH transactions between files that is 13 numbers long. achFileKey: type: string description: A unique identifier assigned to an ACH file. achBatch: type: string description: A collection of related ACH transactions grouped together for processing and transmission as a single unit. achSequence: type: string description: The order or sequence in which ACH transactions are processed within a batch. Each transaction within an ACH batch is assigned a unique sequence number to indicate its position within the batch. achStdEntryClassCode: type: string description: A three-letter code that describes how a payment was authorized by the consumer or business receiving an ACH transaction. achCompanyId: type: string description: Used to identify the Originator. Assigned by the ODFI. achCompanyName: type: string description: Name of the Originator known and recognized by the Receiver. odfiRoutingNumber: type: string description: The routing number of the financial institution originating the ACH transaction. achTransactionCode: type: string description: A code that identifies the type of ACH transaction being processed. This follows NACHA standards. achIndividualName: type: string description: The name of the individual associated with the ACH transaction. companyDiscretionaryData: type: string description: Optional data provided by the originator of the ACH transaction. createdDateTime: type: string format: date-time nullable: false transactionDate: type: string format: date description: This attribute will return the date that was used when the transaction was attempted. nullable: false messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/gl-detail: get: tags: - Exception Items description: API to Get EIP General Ledger Details By Id summary: API to Get EIP General Ledger Details By Id operationId: GetEIPGlDetail parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: UUID description: A unique identifier for an Exception Item createdDateTime: type: string format: date-time nullable: false costCenter: type: string description: Cost center code associated with general ledger account. maxLength: 36 productCode: type: string description: Product code associated with general ledger account. maxLength: 36 glBranchId: type: string description: ID of the branch associated with the general ledger account. maxLength: 36 glDescription: type: string description: A description of the general ledger entry. maxLength: 80 glTransactionReference: type: string description: This contains information that refers to the transaction that is associated with the general ledger entry. maxLength: 80 transactionDate: type: string format: date description: This attribute will return the date that was used when the transaction was attempted. nullable: false '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error post: tags: - Exception Items description: API to Create EIP General Ledger Details By Id summary: API to Create EIP General Ledger Details By Id operationId: CreateEIPGlDetail parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/json: schema: type: object properties: costCenter: type: string description: Cost center code associated with general ledger account. maxLength: 36 productCode: type: string description: Product code associated with general ledger account. maxLength: 36 glBranchId: type: string description: ID of the branch associated with the general ledger account. maxLength: 36 glDescription: type: string description: A description of the general ledger entry. maxLength: 80 glTransactionReference: type: string description: This contains information that refers to the transaction that is associated with the general ledger entry. maxLength: 80 transactionDate: type: string format: date description: This attribute will return the date that was used when the transaction was attempted. nullable: false responses: '201': description: Created content: application/json: schema: type: object properties: id: type: string format: UUID description: A unique identifier for an Exception Item createdDateTime: type: string format: date-time nullable: false messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string fieldDetails: type: array description: An array of objects which provide additional details to specific fields in the request that caused the error. items: type: object properties: field: type: string description: The name or path of the field in the request that caused the error. detail: type: string description: A end-user readable message describing the error related to the field. data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error patch: tags: - Exception Items description: API to Patch EIP General Ledger Details By Id summary: API to Patch EIP General Ledger Details By Id operationId: PatchEIPGlDetail parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false requestBody: content: application/merge-patch+json: schema: type: object properties: costCenter: type: string description: Cost center code associated with general ledger account. maxLength: 36 productCode: type: string description: Product code associated with general ledger account. maxLength: 36 glBranchId: type: string description: ID of the branch associated with the general ledger account. maxLength: 36 glDescription: type: string description: A description of the general ledger entry. maxLength: 80 glTransactionReference: type: string description: This contains information that refers to the transaction that is associated with the general ledger entry. maxLength: 80 responses: '204': description: No Content '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/nsf-detail: get: tags: - Exception Items description: API to Get Non Sufficent Funds Details By Id summary: API to Get Non Sufficent Funds Details By Id operationId: GetNsfDetail parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: UUID description: A unique identifier for an Exception Item postingAvailableBalance: type: string description: Available balance at the time of attempted posting. waiveWithinTolerance: type: boolean description: Indicates whether a fee was waived within a specified tolerance limit. serviceChargeCode: type: string description: Code used to determine the fee amounts, max charges and other NSF/OD behaviors. createdDateTime: type: string format: date-time nullable: false transactionDate: type: string format: date description: This attribute will return the date that was used when the transaction was attempted. nullable: false messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/check-image: get: tags: - Exception Items summary: API to get check images for an exception item by exception item ID description: API to get check images for an exception item by exception item ID operationId: GetCheckImages parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false - name: format description: File format for check image in: query schema: type: string enum: - JPG - GIF - PNG - TIFF - IOCA default: JPG - name: side description: Front/back side for check image in: query schema: type: string enum: - Front - Back default: Front responses: '200': description: OK content: image/jpeg: schema: type: string format: binary description: JPEG image of the requested side of the check image image/png: schema: type: string format: binary description: PNG image of the requested side of the check image image/gif: schema: type: string format: binary description: GIF image of the requested side of the check image image/tiff: schema: type: string format: binary description: TIFF image of the requested side of the check image application/octet-stream: schema: type: string format: binary description: Binary representation of the requested side of the check image '204': description: No Content - Check image nonexistent for exception item '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/customer-message-inquiry: get: tags: - Exception Items summary: API to get customer information messages associated with a customer's account that relate to an exception item description: API to get customer information messages associated with a customer's account that relate to an exception item operationId: GetCustomerMessages parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string - name: Id in: path required: true description: The unique ExceptionItemProcessing identifier. schema: type: string format: uuid nullable: false responses: '200': description: OK content: application/json: schema: type: object properties: accountNumber: type: string description: The number or character that identifies the account record. accountType: type: string description: The type of account record. customerId: type: string description: The identifier attached to a customer. messages: type: array items: type: object properties: messageType: type: string enum: - Acct - Cust description: The type of informational messages related to a customer or account. messageOrder: type: integer description: The order of informational messages related to a customer or account. messageId: type: string description: The informational message identification related to a customer or account. message: type: string description: The informational message related to a customer or account. '400': description: The server could not understand the request due to an invalid request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true '401': description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. '403': description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server. '404': description: The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. '500': description: An unexpected internal server error occurred while processing the request. content: application/problem+json: schema: type: object required: - type - title - details properties: type: description: A string path which uniquely classifies the domain of the error. type: string nullable: false example: jackhenry/operation-failed title: description: A end-user readable string title of the error type. nullable: false type: string details: description: An array of end-user readable strings which provide additional details for the error message. type: array nullable: false items: type: string data: type: object description: | Additional data that could be useful to a developer or for handing the error programmatically. The schema for the data in this object is intentionally left undefined. nullable: true examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error

Please ignore this field