Rules

openapi: 3.0.3 info: version: v1 title: Exception Item Processing API - Rules 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: Rules description: APIs for user specific Rules in Exception Item Processing paths: /a/api/eip/v1/{InstitutionUniversalId}/rules: get: operationId: GetRules tags: - Rules summary: Get rules description: Retrieve the rules for the specified user. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Successfully retrieved rules content: application/json: schema: type: object required: - rules properties: rules: type: object description: Dictionary of rule definitions keyed by rule pattern additionalProperties: type: object required: - label - permissions properties: label: type: string example: NSF (all) permissions: type: array items: type: object required: - id - label - requiredPermission properties: id: type: string example: view label: type: string example: View Exception requiredPermission: type: string example: eip:silverlake_nsf:*:*:*:view '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}/rules/key-definition: get: operationId: GetRuleKeyDefinition tags: - Rules summary: Get rule key definition description: Retrieve the rule key definition for the specified institution. parameters: - name: InstitutionUniversalId in: path description: A unique identifier to establish the identity of an Institution/Environment/Brand combination required: true schema: type: string responses: '200': description: Successfully retrieved rule key definition content: application/json: schema: type: object required: - keyFormat - permissionPrefix - segments properties: keyFormat: type: object required: - separator - segmentOrder - description properties: separator: type: string example: ':' segmentOrder: type: array items: type: string example: - exceptionSource - exceptionType - transactionType - accountType description: type: string example: 'Four segments: exceptionSource, exceptionType, transactionType, accountType.' permissionPrefix: type: string description: Prefix used when constructing requiredPermission strings example: eip segments: type: array items: type: object required: - name - description - source - normalization properties: name: type: string example: exceptionSource description: type: string source: type: object required: - field - path properties: field: type: string example: exceptionSource path: type: string example: exceptionSource normalization: type: object required: - type - mapping - fallbackRule properties: type: type: string example: mapping mapping: type: object description: Maps raw values to normalized key values additionalProperties: type: string example: RapidTransfers: rapid_transfers fallbackRule: type: string description: Rule applied if no mapping entry is found example: lowercase_underscore '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}/rules/key-definition/build-key: post: operationId: buildRuleKey summary: Build normalized rule key description: Build a normalized rule key based on the provided raw key values and the rule key definition for the specified institution. tags: - Rules 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: required: true content: application/json: schema: type: object required: - segmentValues properties: segmentValues: type: object description: Raw segment values used to construct the rule key additionalProperties: type: string example: exceptionSource: SilverlakeNonPost exceptionType: foo bar transactionType: ACH accountType: Checking responses: '200': description: Successfully generated rule key content: application/json: schema: type: object required: - key properties: key: type: string description: Fully normalized rule key example: silverlake_nonpost:foo_bar:ach:checking '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