Reports

openapi: 3.0.3 info: version: v1 title: Exception Item Processing API - Reports 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: Reports description: APIs for generating Exception Item Processing reports paths: /a/api/eip/v1/{InstitutionUniversalId}/unresolved-exceptions: post: tags: - Reports description: Provides a list of unresolved exception items for a financial insitution within a specified date range summary: API for Unresolved Exception Item Reporting operationId: GetUnresolvedExceptionsReport 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: type: object properties: startDate: type: string format: date nullable: false description: Start date of the transaction set to be used for the report endDate: type: string format: date nullable: false description: End date of the transaction set to be used for the report branchId: type: string description: Branch ID for which the report needs to be generated nullable: true transactionType: type: string description: Identifies the type of transaction nullable: true enum: - ACH - AFT - ATM - Check - Unspecified - null responses: '200': description: OK content: application/pdf: schema: type: string format: binary application/json: schema: type: object properties: accountNumber: type: string branchId: type: string checkNumber: type: string debitCredit: type: string decision: type: string exceptionSource: type: string exceptionState: type: string returnReason: type: string transactionAmount: type: string transactionAmountNumber: type: integer format: int64 transactionCode: type: string transactionDate: type: string format: date transactionSourceTracerNumber: type: string nullable: true transactionType: 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}/resolved-exceptions: post: tags: - Reports description: Provides a list of resolved exception items for a financial insitution within a specified date range summary: API for Resolved Exception Item Reporting operationId: GetResolvedExceptionsReport 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: type: object properties: startDate: type: string format: date nullable: false description: Start date of the transaction set to be used for the report endDate: type: string format: date nullable: false description: End date of the transaction set to be used for the report branchId: type: string description: Branch ID for which the report needs to be generated nullable: true transactionType: type: string description: Identifies the type of transaction nullable: true enum: - ACH - AFT - ATM - Check - Unspecified - null responses: '200': description: OK content: application/pdf: schema: type: string format: binary application/json: schema: type: object properties: accountNumber: type: string branchId: type: string checkNumber: type: string debitCredit: type: string decision: type: string exceptionSource: type: string exceptionState: type: string returnReason: type: string transactionAmount: type: string transactionAmountNumber: type: integer format: int64 transactionCode: type: string transactionDate: type: string format: date transactionSourceTracerNumber: type: string nullable: true transactionType: 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

Please ignore this field