Products

openapi: 3.0.3 info: title: Account Services APIs - Products 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: Products description: V1 APIs for Account Products paths: /a/api/acct-svcs/v1/{InstitutionUniversalId}/products: post: description: Add product operationId: AddProduct tags: - Products summary: API to create a product. 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: description: The product resource to be created. content: application/json: schema: type: object required: - accountType - productDescriptionInternal - productStatus - minimumBalanceType - cycleDay properties: accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false responses: '201': description: Success - Created content: application/json: schema: type: object properties: id: type: string format: uuid description: The new identifier for the product. '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. get: description: Get all Products for an Institution operationId: GetAllProducts tags: - Products summary: API to get all Products for an 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 - schema: type: string default: '0' 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: `.../resource?Offset=50` - schema: type: string default: '500' 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: `.../resource?Count=100`' responses: '200': description: Success content: application/json: schema: type: object properties: products: type: array items: type: object properties: id: type: string format: uuid description: This attribute defines the unique product identifier. nullable: false accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal productStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 accrualMethodDaysDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false 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 '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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/products: post: description: Add product operationId: AddProductWithEnterpriseUserId tags: - Products summary: API to create a product. 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. requestBody: description: The product resource to be created. content: application/json: schema: type: object required: - accountType - productDescriptionInternal - productStatus - minimumBalanceType - cycleDay properties: accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false responses: '201': description: Success - Created content: application/json: schema: type: object properties: id: type: string format: uuid description: The new identifier for the product. '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. get: description: Get all Products for an Institution operationId: GetAllProductsWithEnterpriseUserId tags: - Products summary: API to get all Products for an 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 - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - schema: type: string default: '0' 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: `.../resource?Offset=50` - schema: type: string default: '500' 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: `.../resource?Count=100`' responses: '200': description: Success content: application/json: schema: type: object properties: products: type: array items: type: object properties: id: type: string format: uuid description: This attribute defines the unique product identifier. nullable: false accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal productStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 accrualMethodDaysDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false 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 '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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/products/{Id}: get: description: Get product operationId: GetProduct tags: - Products summary: API to get a product based on its identifier. 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 description: A unique identifier to establish the identity of a Product. required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string format: uuid description: This attribute defines the unique product identifier. nullable: false accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal productStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 accrualMethodDaysDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false '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. put: description: Update product operationId: UpdateProductById tags: - Products summary: API to update a product. 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 description: A unique identifier to establish the identity of a Product. required: true schema: type: string format: uuid requestBody: description: The product resource to be updated. content: application/json: schema: type: object required: - productDescriptionInternal - productStatus - minimumBalanceType - cycleDay properties: productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false responses: '204': description: Success - No Content '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. delete: description: Delete product operationId: DeleteProduct tags: - Products summary: API endpoint to delete a product based on the provided identifier. 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 description: A unique identifier to establish the identity of a Product. required: true schema: type: string format: uuid responses: '204': description: Success - No Content '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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/products/{Id}: get: description: Get product operationId: GetProductWithEnterpriseUserId tags: - Products summary: API to get a product based on its identifier. 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. - name: Id in: path description: A unique identifier to establish the identity of a Product. required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string format: uuid description: This attribute defines the unique product identifier. nullable: false accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal productStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 accrualMethodDaysDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false '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. put: description: Update product operationId: UpdateProductByIdWithEnterpriseUserId tags: - Products summary: API to update a product. 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. - name: Id in: path description: A unique identifier to establish the identity of a Product. required: true schema: type: string format: uuid requestBody: description: The product resource to be updated. content: application/json: schema: type: object required: - productDescriptionInternal - productStatus - minimumBalanceType - cycleDay properties: productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false responses: '204': description: Success - No Content '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. delete: description: Delete product operationId: DeleteProductWithEnterpriseUserId tags: - Products summary: API endpoint to delete a product based on the provided identifier. 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. - name: Id in: path description: A unique identifier to establish the identity of a Product. required: true schema: type: string format: uuid responses: '204': description: Success - No Content '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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/products/search: post: description: Search Products based on Account Type operationId: SearchProduct tags: - Products summary: API to search for products based on account type for an 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 - schema: type: string default: '0' 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: `.../resource?Offset=50` - schema: type: string default: '500' 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: `.../resource?Count=100`' requestBody: description: Request parameters. content: application/json: schema: type: object required: - accountType properties: accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings additionalProperties: false responses: '200': description: Success content: application/json: schema: type: object required: - products - paging properties: products: type: array items: type: object properties: id: type: string format: uuid description: This attribute defines the unique product identifier. nullable: false accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal productStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 accrualMethodDaysDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false 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 '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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/products/search: post: description: Search Products based on Account Type operationId: SearchProductWithEnterpriseUserId tags: - Products summary: API to search for products based on account type for an 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 - in: path name: EnterpriseUserId required: true schema: type: string format: uuid description: The ID of the enterprise user. - schema: type: string default: '0' 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: `.../resource?Offset=50` - schema: type: string default: '500' 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: `.../resource?Count=100`' requestBody: description: Request parameters. content: application/json: schema: type: object required: - accountType properties: accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings additionalProperties: false responses: '200': description: Success content: application/json: schema: type: object required: - products - paging properties: products: type: array items: type: object properties: id: type: string format: uuid description: This attribute defines the unique product identifier. nullable: false accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountTypeDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productDescriptionInternal: type: string description: This attribute defines the internal product name. maxLength: 30 nullable: false productDescriptionExternal: type: string description: This attribute defines the product name shown externally. maxLength: 30 nullable: true productStatus: nullable: false type: string description: This enum attribute defines the status of the product. enum: - active - inactive - internal productStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false overdraftLimit: type: object properties: value: type: string 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 numberDaysZeroBalance: type: integer description: This attribute defines whether an account will close if it remains at a zero balance for a predetermined set number of days. nullable: true interestRate: type: number description: This attribute defines the interest rate that will be used to calculate interest paid to an account. nullable: true accrualMethod: nullable: true type: string description: This enum attribute defines how interest is accrued on an account. enum: - simple - compound accrualMethodDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false accrualMethodDays: nullable: true type: integer description: This enum attribute defines the number of days in the calendar year the interest accruals are calculated on. enum: - 360 - 365 - 366 accrualMethodDaysDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false cycleDay: type: integer description: This attribute defines the day of the month when all account activity will be cycled to assess services charges, pay interest (if applicable), and generate an account statement. nullable: false cycleTimeServiceChargeFeeId: type: string format: uuid description: This attribute defines the Cycle Time Service Charge Fee Id. nullable: false odItemFeeId: type: string format: uuid description: This attribute defines the Od Item Fee Id. nullable: false returnItemFeeId: type: string format: uuid description: This attribute defines the Return Item Fee Id. nullable: false flatFeeId: type: string format: uuid description: This attribute defines the Flat Fee Id. nullable: false accountNumberGenerationSettingsId: type: string format: uuid description: This attribute defines the settings Id used to generate an account number nullable: false additionalProperties: false 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 '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