Enterprise Abilities

openapi: 3.0.3 info: title: Account Services APIs - Enterprise Abilities version: v1 description: APIs for Account Services 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: Enterprise Abilities description: Endpoints for getting enterprise account service abilities. paths: /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/abilities: get: operationId: GetEnterpriseAbilities tags: - Enterprise Abilities summary: Get enterprise user abilities for account services. description: Method to get enterprise user abilities for account services. 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: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. responses: '200': description: Abilities retrieved successfully. content: application/json: schema: type: object description: Abilities response object. required: - addDepositHolds - addAcctNumberGenSettings - editAcctNumberGenSettings - searchDepositStopPayments - editDepositHolds - deleteDepositHolds - editDepositAccountDateAmount - searchDepositTransactions - addDepositStopPayments - viewAcctNumberGenSettings - deleteDepositStopPayments - searchDepositAccounts - editFederalStateTaxWithholdingSettings - deleteDepositAccountProducts - editDepositAccounts - viewDepositAvailableBalance - addAccountNumber - addDepositTransactionRequest - viewDepositStopPaymentSettings - deleteDepositStateDormancySettings - viewDepositStopPayments - deleteAcctNumberGenSettings - deleteDepositTransactions - editDepositStateDormancySettings - editDepositStopPaymentSettings - addDepositStateDormancySettings - viewDepositTransactionEntry - deleteDepositAccounts - viewDepositAccounts - addFederalStateTaxWithholdingSettings - viewDepositTransactionLineItem - viewDepositAccountProducts - addDepositStopPaymentSettings - viewFederalStateTaxWithholdingSettings - verifyDepositTransactionRequest - searchDepositAccountProducts - addDepositAccounts - addDepositAccountProducts - searchDepositHolds - getAllDepositAccountProducts - editDepositAccountProducts - deleteDepositStopPaymentSettings - viewDepositStateDormancySettings - editDepositStopPayments - addTaxAggregationSchedulerSettings - viewTaxAggregationSchedulerSettings - editTaxAggregationSchedulerSettings - deleteTaxAggregationSchedulerSettings properties: addDepositHolds: type: boolean description: Ability to add deposit holds. addAcctNumberGenSettings: type: boolean description: Ability to add account-number-generation settings. editAcctNumberGenSettings: type: boolean description: Ability to edit account-number-generation settings. searchDepositStopPayments: type: boolean description: Ability to search for deposit stop-payment requests. editDepositHolds: type: boolean description: Ability to edit existing deposit holds. deleteDepositHolds: type: boolean description: Ability to delete deposit holds. editDepositAccountDateAmount: type: boolean description: Ability to edit deposit account date/amount values. searchDepositTransactions: type: boolean description: Ability to search deposit transactions. addDepositStopPayments: type: boolean description: Ability to add deposit stop-payment requests. viewAcctNumberGenSettings: type: boolean description: Ability to view account-number-generation settings. deleteDepositStopPayments: type: boolean description: Ability to delete deposit stop-payment requests. searchDepositAccounts: type: boolean description: Ability to search deposit accounts. editFederalStateTaxWithholdingSettings: type: boolean description: Ability to edit federal/state tax-withholding settings. deleteDepositAccountProducts: type: boolean description: Ability to delete deposit account products. editDepositAccounts: type: boolean description: Ability to edit deposit account details. viewDepositAvailableBalance: type: boolean description: Ability to view deposit available balance. addAccountNumber: type: boolean description: Ability to add new account numbers. addDepositTransactionRequest: type: boolean description: Ability to add a deposit transaction request. viewDepositStopPaymentSettings: type: boolean description: Ability to view deposit stop-payment settings. deleteDepositStateDormancySettings: type: boolean description: Ability to delete deposit state dormancy settings. viewDepositStopPayments: type: boolean description: Ability to view deposit stop-payment requests. deleteAcctNumberGenSettings: type: boolean description: Ability to delete account-number-generation settings. deleteDepositTransactions: type: boolean description: Ability to delete deposit transactions. editDepositStateDormancySettings: type: boolean description: Ability to edit deposit state dormancy settings. editDepositStopPaymentSettings: type: boolean description: Ability to edit deposit stop-payment settings. addDepositStateDormancySettings: type: boolean description: Ability to add deposit state dormancy settings. viewDepositTransactionEntry: type: boolean description: Ability to view deposit transaction entries. deleteDepositAccounts: type: boolean description: Ability to delete deposit accounts. viewDepositAccounts: type: boolean description: Ability to view deposit accounts. addFederalStateTaxWithholdingSettings: type: boolean description: Ability to add federal/state tax-withholding settings. viewDepositTransactionLineItem: type: boolean description: Ability to view deposit transaction line items. viewDepositAccountProducts: type: boolean description: Ability to view deposit account products. addDepositStopPaymentSettings: type: boolean description: Ability to add deposit stop-payment settings. viewFederalStateTaxWithholdingSettings: type: boolean description: Ability to view federal/state tax-withholding settings. verifyDepositTransactionRequest: type: boolean description: Ability to verify a deposit transaction request. searchDepositAccountProducts: type: boolean description: Ability to search deposit account products. addDepositAccounts: type: boolean description: Ability to add new deposit accounts. addDepositAccountProducts: type: boolean description: Ability to add deposit account products. searchDepositHolds: type: boolean description: Ability to search deposit holds. getAllDepositAccountProducts: type: boolean description: Ability to retrieve all deposit account products. editDepositAccountProducts: type: boolean description: Ability to edit deposit account products. deleteDepositStopPaymentSettings: type: boolean description: Ability to delete deposit stop-payment settings. viewDepositStateDormancySettings: type: boolean description: Ability to view deposit state dormancy settings. editDepositStopPayments: type: boolean description: Ability to edit deposit stop-payment requests. addTaxAggregationSchedulerSettings: type: boolean description: Ability to add tax aggregation scheduler settings. viewTaxAggregationSchedulerSettings: type: boolean description: Ability to view tax aggregation scheduler settings. editTaxAggregationSchedulerSettings: type: boolean description: Ability to edit tax aggregation scheduler settings. deleteTaxAggregationSchedulerSettings: type: boolean description: Ability to delete tax aggregation scheduler settings. '400': description: The server could not process 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 examples: badRequest: summary: Bad request value: type: acct-svcs/bad-request title: Rule violation details: - exampleField is invalid or malformed. fieldDetails: - field: exampleField detail: Provide a valid value for this field. '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: acct-svcs/internal-server-error title: Unexpected error details: - An unexpected error occurred. Please contact your service provider and/or try again later.

Please ignore this field