Interest Accrual

openapi: 3.0.3 info: title: Account Services APIs - Interest Accrual 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: Interest Accrual description: V1 APIs for Interest Accrual paths: /a/api/acct-svcs/v1/{InstitutionUniversalId}/interest-accrual/accounts/{AccountId}/interest-summary/{OperationalPeriod}: get: operationId: AccruedInterestLedgerAccountSummary tags: - Interest Accrual summary: API to retrieve interest ledger summary fields for an account description: API to retrieve interest ledger summary fields for an account 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: AccountId in: path description: A unique identifier which identifies the Account to retrieve interest summary fields for required: true schema: type: string format: uuid - name: OperationalPeriod in: path description: A date formatted as RFC3339 to establish the operational period requested. required: true schema: type: string format: Date(RFC3339) default: '2024-08-31T00:00:00Z' - name: LastCycleOperationalPeriod in: query description: 'A date formatted as RFC3339 to optionally specify the last cycle operational period. If not supplied, a call will be made to retrieve it from the account summary record. <br>Example: `.../interest-summary?lastCycleOperationalPeriod=2024-07-31T00:00:00Z`' required: false schema: type: string format: Date(RFC3339) default: '' responses: '200': description: Success content: application/json: schema: type: object properties: accountId: type: string format: uuid description: AccountId for the retrieved interest summary. nullable: false lastInterestPaidAmount: type: string description: The last interest paid amount on the account. nullable: true lastInterestPaidDate: type: string description: The last interest paid date for the account. nullable: true interestAccruedNotPaid: type: string description: The total interest accrued on the account that has not yet been paid. nullable: false interestPaidCurrentYTD: type: string description: The total interest paid for the current year to date. nullable: false interestPaidCurrentCTD: type: string description: The total interest paid for the current cycle to date. nullable: false accruedInterestCTDAPY: type: string description: The total accrued interest in the cycle. nullable: false daysCTDAPY: type: integer description: The total days in the cycle that interest was accrued on. nullable: false federalWithholdingAmountYTD: type: string description: The total federal withholding amount for the current year to date. nullable: false stateWithholdingAmountYTD: type: string description: The total state withholding amount for the current year to date. nullable: false apyEarnedCTD: type: string description: The annual percentage yield (APY) earned in the current cycle to date. 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. ? /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/interest-accrual/accounts/{AccountId}/interest-summary/{OperationalPeriod} : get: operationId: AccruedInterestLedgerAccountSummaryWithEnterpriseUserId tags: - Interest Accrual summary: API to retrieve interest ledger summary fields for an account description: API to retrieve interest ledger summary fields for an account 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: AccountId in: path description: A unique identifier which identifies the Account to retrieve interest summary fields for required: true schema: type: string format: uuid - name: OperationalPeriod in: path description: A date formatted as RFC3339 to establish the operational period requested. required: true schema: type: string format: Date(RFC3339) default: '2024-08-31T00:00:00Z' - name: LastCycleOperationalPeriod in: query description: 'A date formatted as RFC3339 to optionally specify the last cycle operational period. If not supplied, a call will be made to retrieve it from the account summary record. <br>Example: `.../interest-summary?lastCycleOperationalPeriod=2024-07-31T00:00:00Z`' required: false schema: type: string format: Date(RFC3339) default: '' responses: '200': description: Success content: application/json: schema: type: object properties: accountId: type: string format: uuid description: AccountId for the retrieved interest summary. nullable: false lastInterestPaidAmount: type: string description: The last interest paid amount on the account. nullable: true lastInterestPaidDate: type: string description: The last interest paid date for the account. nullable: true interestAccruedNotPaid: type: string description: The total interest accrued on the account that has not yet been paid. nullable: false interestPaidCurrentYTD: type: string description: The total interest paid for the current year to date. nullable: false interestPaidCurrentCTD: type: string description: The total interest paid for the current cycle to date. nullable: false accruedInterestCTDAPY: type: string description: The total accrued interest in the cycle. nullable: false daysCTDAPY: type: integer description: The total days in the cycle that interest was accrued on. nullable: false federalWithholdingAmountYTD: type: string description: The total federal withholding amount for the current year to date. nullable: false stateWithholdingAmountYTD: type: string description: The total state withholding amount for the current year to date. nullable: false apyEarnedCTD: type: string description: The annual percentage yield (APY) earned in the current cycle to date. 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.

Please ignore this field