Account Services Query Service

openapi: 3.0.3 info: title: Account Services APIs - Account Services Query Service 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: http://jx-r.jhacorp.com description: Corporate Test Server security: [] components: securitySchemes: OpenIDEnterprise: type: openIdConnect openIdConnectUrl: https://login.jackhenry.com/.well-known/openid-configuration description: "Jack Henry Enterprise Authentication. \n\n ### Supported Flows\n \n #### 1. Authorization Code Flow\n * **Use Case:** Person-at-keyboard logins (FI or JH Employees).\n * **Security:** Supports/recommends PKCE (S256). Supports Pushed Authorization Requests (PAR), and DPoP token binding.\n * **Client Auth:** Supports/recommends `client_assertion` (Private Key JWT), also supports `client_secret`.\n \n #### 2. Client Credentials Flow\n * **Use Case:** System services and machine-to-machine integrations.\n * **Security:** Supports DPoP token binding.\n * **Client Auth:** **Requires** `client_assertion` (Private Key JWT).\n" tags: - name: Account Services Query Service description: V1 APIs for generating Report Data from Account Services Data Broker paths: /a/api/acct-svcs/v1/{InstitutionUniversalId}/trial-balance: get: operationId: GetTrialBalance security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/accounts.read tags: - Account Services Query Service summary: API to get trial balance report description: Get trial balance report 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 - name: RunDate in: query required: false description: Results will be returned as if the query for balances was run on the date provided. Defaults to the current UTC time. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: object properties: accounts: type: array items: type: object properties: accountNumber: type: string accountStatus: type: string description: This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off branchId: type: string format: uuid cycleDay: type: integer format: int32 currentBalance: type: string format: decimal lastActivityDate: type: string format: date-time nullable: true accruedInterestNotPaid: type: string format: decimal lastDepositDate: type: string format: date-time nullable: true lastDepositAmount: type: string format: decimal nullable: true statusTotals: type: array items: type: object properties: accountStatus: type: string description: This enum attribute defines the account status. enum: - new - active - inactive - restricted - no_debits - no_credits - dormant - escheat - pending_close - closed - charged_off totalAccounts: type: integer format: int32 positiveBalances: type: string format: decimal negativeBalances: type: string format: decimal accruedInterestNotPaid: type: string format: decimal dailyAccruedInterest: type: string format: decimal institutionTotals: type: object properties: totalAccounts: type: integer format: int32 totalPositiveBalances: type: string format: decimal totalNegativeBalances: type: string format: decimal totalAccruedInterestNotPaid: type: string format: decimal totalDailyAccruedInterest: type: string format: decimal productTotals: type: array items: type: object properties: productId: type: string format: uuid productDescriptionInternal: type: string productDescriptionExternal: type: string totalAccounts: type: integer format: int32 positiveBalances: type: string format: decimal negativeBalances: type: string format: decimal accruedInterestNotPaid: type: string format: decimal '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}/new-accounts: get: operationId: GetNewAccounts security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/accounts.read tags: - Account Services Query Service summary: API to get new accounts report description: Get new accounts opened within a date range 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 - name: startDate in: query required: false description: The start date of the date range to query. Defaults to the current date. Must be in YYYY-MM-DD format on or after 2000-01-01. schema: type: string format: date nullable: true - name: endDate in: query required: false description: The end date of the date range to query. Defaults to the current date. Must be in YYYY-MM-DD format on or after 2000-01-01. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: accountNumber: type: string customerName: type: string productName: type: string accountStatus: type: string openedDate: type: string format: date-time currentBalance: type: string format: decimal '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}/closed-accounts: get: operationId: GetClosedAccounts security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/accounts.read tags: - Account Services Query Service summary: API to get closed accounts report description: Get closed accounts report within a date range 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 - name: startDate in: query required: false description: The start date of the date range to query. Defaults to the current date. Must be in YYYY-MM-DD format on or after 2000-01-01. schema: type: string format: date nullable: true - name: endDate in: query required: false description: The end date of the date range to query. Defaults to the current date. Must be in YYYY-MM-DD format on or after 2000-01-01. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: accountNumber: type: string customerName: type: string productName: type: string accountStatus: type: string openedDate: type: string format: date-time closedDate: type: string format: date-time '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}/overdrawn-accounts: get: operationId: GetOverdrawnAccounts security: - OpenIDEnterprise: - https://jackhenry.com/acct-svcs/accounts.read tags: - Account Services Query Service summary: API to get overdrawn accounts report description: Get a report on accounts with a negative combined current and overdraft balance as of a specific date 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 - name: RunDate in: query required: false description: Results will be returned as if the query for balances was run on the date provided. Defaults to the current UTC time. schema: type: string format: date nullable: true responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: accountNumber: type: string entityName: type: string productName: type: string accountStatus: type: string openedDate: type: string format: date-time dateOfLastActivity: type: string format: date-time nullable: true accountBalance: type: string format: decimal overdraftLimit: type: string format: decimal lastDepositDate: type: string format: date-time nullable: true lastDepositAmount: type: string format: decimal nullable: true '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