Suggested Actions

openapi: 3.0.3 info: version: v1 title: Exception Item Processing API - Suggested Actions 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: Suggested Actions description: APIs for retrieving suggested actions for exception items paths: /a/api/eip/v1/{InstitutionUniversalId}/exception-items/{Id}/suggested-action: get: tags: - Suggested Actions description: API to Get Suggested Action By Exception Item Id summary: API to Get Suggested Action By Exception Item Id operationId: GetSuggestedAction 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: Unique identifier for the suggested action. eipId: type: string format: UUID description: The exception item ID that this suggestion is for. institutionId: type: string description: The institution identifier. lastChangedAt: type: string format: date-time description: Timestamp when the suggested action was last modified. createdAt: type: string format: date-time description: Timestamp when the suggested action was created. status: type: string description: | Overall status of the suggested action. If fieldDecisions contains any values, status will automatically be set to "Reviewed". enum: - Pending - Accepted - Rejected - Reviewed example: Reviewed fieldDecisions: type: object description: | A map of suggested field names to their review decision. If at least one field is present, the SuggestedAction status will automatically become "Reviewed". additionalProperties: type: string enum: - Accepted - Rejected example: accountNumber: Rejected accountType: Accepted decision: Accepted acceptedBy: type: string description: User ID of who accepted the suggested action. nullable: true itemLevelReasoning: type: string description: Overall reasoning for the suggested action. modifications: description: The specific field modifications suggested. type: object properties: accountId: type: string format: UUID description: Suggested corrected account ID. nullable: true accountNumber: type: string description: Suggested corrected account number. nullable: true accountType: type: string description: Suggested account type. nullable: true debitCredit: type: string description: Suggested debit/credit indicator. nullable: true description: type: string description: Suggested description for the exception item. nullable: true status: type: string description: Suggested status for the exception item. nullable: true transactionType: type: string description: Suggested transaction type. nullable: true transactionCode: type: string description: Suggested transaction code. nullable: true transactionCodeDescription: type: string description: Suggested transaction code description. nullable: true originalTransactionCodeDescription: type: string description: Suggested original transaction code description. nullable: true assignedTo: type: string description: Suggested user to assign the exception item to. nullable: true checkNumber: type: string description: Suggested check number. nullable: true effectiveDate: type: string format: date description: Suggested effective date. nullable: true decision: type: string description: Suggested decision for the exception item. nullable: true returnReason: type: string description: Suggested return reason. nullable: true onUsReturn: type: boolean description: Suggested on-us return flag. nullable: true feeDecision: type: string description: Suggested fee decision. nullable: true feeWaiveReason: type: string description: Suggested reason for waiving the fee. nullable: true feeWaivedBy: type: string maxLength: 100 description: Suggested 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: Suggested 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: Suggested fee amount that was calculated for the debit. nullable: true feeDescription: type: string maxLength: 80 description: Suggested description of the fee that may be printed on the customer statement. nullable: true printNotice: type: string description: Suggested print notice setting. nullable: true fieldLevelReasoning: description: Detailed reasoning for each field modification. type: object properties: accountId: type: string description: Reasoning for the suggested account ID correction. nullable: true accountNumber: type: string description: Reasoning for the suggested account number correction. nullable: true accountType: type: string description: Reasoning for the suggested account type. nullable: true debitCredit: type: string description: Reasoning for the suggested debit/credit indicator. nullable: true description: type: string description: Reasoning for the suggested description. nullable: true status: type: string description: Reasoning for the suggested status. nullable: true transactionType: type: string description: Reasoning for the suggested transaction type. nullable: true transactionCode: type: string description: Reasoning for the suggested transaction code. nullable: true transactionCodeDescription: type: string description: Reasoning for the suggested transaction code description. nullable: true originalTransactionCodeDescription: type: string description: Reasoning for the suggested original transaction code description. nullable: true assignedTo: type: string description: Reasoning for the suggested assignment. nullable: true checkNumber: type: string description: Reasoning for the suggested check number. nullable: true effectiveDate: type: string description: Reasoning for the suggested effective date. nullable: true decision: type: string description: Reasoning for the suggested decision. nullable: true returnReason: type: string description: Reasoning for the suggested return reason. nullable: true onUsReturn: type: string description: Reasoning for the suggested on-us return flag. nullable: true feeDecision: type: string description: Reasoning for the suggested fee decision. nullable: true feeWaiveReason: type: string description: Reasoning for the suggested fee waive reason. nullable: true feeWaivedBy: type: string description: Reasoning for the suggested fee waived by officer. nullable: true assessedFee: type: string description: Reasoning for the suggested assessed fee. nullable: true calculatedFee: type: string description: Reasoning for the suggested calculated fee. nullable: true feeDescription: type: string description: Reasoning for the suggested fee description. nullable: true printNotice: type: string description: Reasoning for the suggested print notice setting. nullable: true required: - id - eipId - institutionId - lastChangedAt - createdAt - accepted - itemLevelReasoning - modifications - fieldLevelReasoning '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: - Suggested Actions description: API to Update Suggested Action summary: API to Update Suggested Action operationId: PatchSuggestedAction 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: fieldDecisions: type: object description: | A dictionary of suggested field names mapped to their review decision. If at least one field decision is provided, the SuggestedAction will be marked as "Reviewed". additionalProperties: type: string enum: - Accepted - Rejected example: accountNumber: Rejected accountType: Accepted decision: Accepted 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

Please ignore this field