Accounts

openapi: 3.0.3 info: title: Account Services APIs - Accounts 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: Accounts description: V1 APIs for Deposit Accounts paths: /a/api/acct-svcs/v1/{InstitutionUniversalId}/accounts: post: operationId: AccountAdd tags: - Accounts summary: API to create an Account record and add a relationship to an existing entity description: API to create an Account and add a relationship to an existing entity 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 Account record to be created and its relationship details content: application/json: schema: type: object required: - accountNumber - productId - regEOptIn - waiveOdNsfFees - entityId - relationshipTypeId properties: accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' nullable: false autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. If the consumer does not provide a value for autoClose, it will default from the product. If the Product's number of days zero balance is greater than zero, the auto close field will default to true. If the Product's number of days zero balance is equal to zero, the auto close field will default to false. nullable: true cycleDay: type: integer format: int32 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. If the consumer does not provide a value for cycleDay, it will default from the product's cycleDay. minimum: 1 maximum: 31 nullable: true openedDate: type: string format: date-time description: This attribute defines the date the account was opened. nullable: true overdraftLimit: nullable: true 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 regEOptIn: nullable: false type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: false waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal tax withholding should occur when interest is being paid. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state tax withholding should occur when interest is being paid. nullable: true entityId: type: string format: uuid description: This attribute defines the unique identifier of the entity to relate the account to. nullable: false relationshipTypeId: type: string format: uuid description: This attribute defines the unique identifier of the relationship type to use when relating the account to the entity. nullable: false AccountPreferredName: type: string description: This attribute defines the preferred name for the account in the context of the relationship to the entity. nullable: true additionalProperties: false responses: '201': description: Success - Created content: application/json: schema: type: object required: - accountId - relationshipId properties: accountId: type: string format: uuid description: This attribute defines the unique identifier of the created account. nullable: false relationshipId: type: string format: uuid description: This attribute defines the unique identifier of the created relationship between the account and the entity. 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}/accounts: post: operationId: AccountAddWithEnterpriseUserId tags: - Accounts summary: API to create an Account record and add a relationship to an existing entity description: API to create an Account and add a relationship to an existing entity 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 Account record to be created and its relationship details content: application/json: schema: type: object required: - accountNumber - productId - regEOptIn - waiveOdNsfFees - entityId - relationshipTypeId properties: accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' nullable: false autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. If the consumer does not provide a value for autoClose, it will default from the product. If the Product's number of days zero balance is greater than zero, the auto close field will default to true. If the Product's number of days zero balance is equal to zero, the auto close field will default to false. nullable: true cycleDay: type: integer format: int32 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. If the consumer does not provide a value for cycleDay, it will default from the product's cycleDay. minimum: 1 maximum: 31 nullable: true openedDate: type: string format: date-time description: This attribute defines the date the account was opened. nullable: true overdraftLimit: nullable: true 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 regEOptIn: nullable: false type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: false waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal tax withholding should occur when interest is being paid. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state tax withholding should occur when interest is being paid. nullable: true entityId: type: string format: uuid description: This attribute defines the unique identifier of the entity to relate the account to. nullable: false relationshipTypeId: type: string format: uuid description: This attribute defines the unique identifier of the relationship type to use when relating the account to the entity. nullable: false AccountPreferredName: type: string description: This attribute defines the preferred name for the account in the context of the relationship to the entity. nullable: true additionalProperties: false responses: '201': description: Success - Created content: application/json: schema: type: object required: - accountId - relationshipId properties: accountId: type: string format: uuid description: This attribute defines the unique identifier of the created account. nullable: false relationshipId: type: string format: uuid description: This attribute defines the unique identifier of the created relationship between the account and the entity. 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}/accounts/{Id}: get: operationId: AccountGet tags: - Accounts summary: API to retrieve an Account record with a key description: Method to retrieve Account information by account 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 an Account required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: 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 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 accountStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' 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 format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: This attribute defines the date the account is charged off. nullable: true chargedOffAmount: 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 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 autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: This attribute defines the interest rate of the account. 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. put: operationId: AccountUpdate tags: - Accounts summary: API to update an Account record description: API to update 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: Id in: path description: A unique identifier to establish the identity of an Account required: true schema: type: string format: uuid requestBody: description: The Account record to be updated content: application/json: schema: type: object properties: cycleDay: type: integer format: int32 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. minimum: 1 maximum: 31 nullable: true regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible 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 nullable: true waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: true autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: true waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal tax withholding should occur when interest is being paid. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state tax withholding should occur when interest is being paid. nullable: true 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: operationId: AccountDelete tags: - Accounts summary: API to delete an Account record with a key description: Method to delete Account by account 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 an Account 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. patch: operationId: AccountStatusPatch tags: - Accounts summary: API to patch an Account Status description: API to patch an Account Status 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 an Account required: true schema: type: string format: uuid requestBody: description: The Account record status to be updated content: application/json-patch+json: schema: type: object required: - accountStatus properties: accountStatus: nullable: false type: string description: This enum attribute defines the account status for patch account status operations. enum: - active - inactive - restricted - no_debits - no_credits - dormant - escheat effectiveDate: type: string format: date-time description: This attribute specifies the date when the account status change takes effect, overriding the default current date for dormant, inactive, and escheat statuses. nullable: true 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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/accounts/{Id}: get: operationId: AccountGetWithEnterpriseUserId tags: - Accounts summary: API to retrieve an Account record with a key description: Method to retrieve Account information by account 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 an Account required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: 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 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 accountStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' 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 format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: This attribute defines the date the account is charged off. nullable: true chargedOffAmount: 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 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 autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: This attribute defines the interest rate of the account. 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. put: operationId: AccountUpdateWithUserId tags: - Accounts summary: API to update an Account record description: API to update 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: Id in: path description: A unique identifier to establish the identity of an Account required: true schema: type: string format: uuid requestBody: description: The Account record to be updated content: application/json: schema: type: object properties: cycleDay: type: integer format: int32 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. minimum: 1 maximum: 31 nullable: true regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible 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 nullable: true waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: true autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: true waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal tax withholding should occur when interest is being paid. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state tax withholding should occur when interest is being paid. nullable: true 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: operationId: AccountDeleteWithUserId tags: - Accounts summary: API to delete an Account record with a key description: Method to delete Account by account 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 an Account 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. patch: operationId: AccountStatusPatchWithUserId tags: - Accounts summary: API to patch an Account Status description: API to patch an Account Status 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 an Account required: true schema: type: string format: uuid requestBody: description: The Account record status to be updated content: application/json-patch+json: schema: type: object required: - accountStatus properties: accountStatus: nullable: false type: string description: This enum attribute defines the account status for patch account status operations. enum: - active - inactive - restricted - no_debits - no_credits - dormant - escheat effectiveDate: type: string format: date-time description: This attribute specifies the date when the account status change takes effect, overriding the default current date for dormant, inactive, and escheat statuses. nullable: true 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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/accounts/{Id}/dates: patch: operationId: AccountDatesPatch tags: - Accounts summary: API to patch Account Dates description: API to patch Account dates 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 an Account required: true schema: type: string format: uuid requestBody: description: The Account record dates and charged off amount to be updated content: application/json-patch+json: schema: type: object properties: openedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was opened. example: '2025-03-12T00:00:00Z' closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. example: '2025-03-12T00:00:00Z' dormantDate: type: string format: date-time nullable: true description: This attribute defines the date the account was dormant. example: '2025-03-12T00:00:00Z' escheatDate: type: string format: date-time nullable: true description: This attribute defines the date the account was escheat. example: '2025-03-12T00:00:00Z' inactiveDate: type: string format: date-time nullable: true description: This attribute defines the date the account was inactive. example: '2025-03-12T00:00:00Z' chargedOffDate: type: string format: date-time nullable: true description: This attribute defines the date the account was charged off. example: '2025-03-12T00:00:00Z' chargedOffAmount: 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 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}/accounts/{Id}/dates: patch: operationId: AccountDatesPatchWithEnterpriseUserId tags: - Accounts summary: API to patch Account Dates description: API to patch Account dates 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 an Account required: true schema: type: string format: uuid requestBody: description: The Account record dates and charged off amount to be updated content: application/json-patch+json: schema: type: object properties: openedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was opened. example: '2025-03-12T00:00:00Z' closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. example: '2025-03-12T00:00:00Z' dormantDate: type: string format: date-time nullable: true description: This attribute defines the date the account was dormant. example: '2025-03-12T00:00:00Z' escheatDate: type: string format: date-time nullable: true description: This attribute defines the date the account was escheat. example: '2025-03-12T00:00:00Z' inactiveDate: type: string format: date-time nullable: true description: This attribute defines the date the account was inactive. example: '2025-03-12T00:00:00Z' chargedOffDate: type: string format: date-time nullable: true description: This attribute defines the date the account was charged off. example: '2025-03-12T00:00:00Z' chargedOffAmount: 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 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}/accounts/get-list: post: operationId: GetAccounts tags: - Accounts summary: API to retrieve mulitple Account records from an array of AccountIds description: Method to retrieve mulitple Account records from an array of AccountIds 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: An array of AccountIds content: application/json: schema: type: array description: An array of strings. items: type: string format: uuid description: AccountId nullable: false nullable: false responses: '200': description: Success content: application/json: schema: type: array description: An array of account records. items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: 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 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 accountStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' 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 format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: This attribute defines the date the account is charged off. nullable: true chargedOffAmount: 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 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 autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: This attribute defines the interest rate of the account. nullable: true nullable: false '207': description: Partial Success - Some or all of the AccountIds submitted were not found. Successful instance will return same example as 200. content: application/json: schema: type: array description: An array of account records. items: type: object required: - id - accountNumber - accountType - accountStatus properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string example: Account Not Found accountType: type: string example: '' accountStatus: type: string example: Account Not Found nullable: 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}/accounts/get-list: post: operationId: GetAccountsWithEnterpriseUserId tags: - Accounts summary: API to retrieve mulitple Account records from an array of AccountIds description: Method to retrieve mulitple Account records from an array of AccountIds 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: An array of AccountIds content: application/json: schema: type: array description: An array of strings. items: type: string format: uuid description: AccountId nullable: false nullable: false responses: '200': description: Success content: application/json: schema: type: array description: An array of account records. items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: 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 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 accountStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' 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 format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: This attribute defines the date the account is charged off. nullable: true chargedOffAmount: 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 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 autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: This attribute defines the interest rate of the account. nullable: true nullable: false '207': description: Partial Success - Some or all of the AccountIds submitted were not found. Successful instance will return same example as 200. content: application/json: schema: type: array description: An array of account records. items: type: object required: - id - accountNumber - accountType - accountStatus properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string example: Account Not Found accountType: type: string example: '' accountStatus: type: string example: Account Not Found nullable: 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}/accounts/inquiry: post: tags: - Accounts summary: API to get an Account record by account number and account type description: Method to get an account by account number and type in the request body operationId: AccountInquiry 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: Request parameters content: application/json: schema: type: object required: - accountNumber - accountType properties: accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings responses: '200': description: Success content: application/json: schema: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: 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 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 accountStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' 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 format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: This attribute defines the date the account is charged off. nullable: true chargedOffAmount: 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 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 autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: This attribute defines the interest rate of the account. 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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/enterprise/{EnterpriseUserId}/accounts/inquiry: post: tags: - Accounts summary: API to get an Account record by account number and account type description: Method to get an account by account number and type in the request body operationId: AccountInquiryWithUserId 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: Request parameters content: application/json: schema: type: object required: - accountNumber - accountType properties: accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: type: string description: This enum attribute defines the account type. enum: - checking - savings responses: '200': description: Success content: application/json: schema: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: 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 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 accountStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' 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 format: int32 minimum: 1 maximum: 31 openedDate: type: string format: date-time nullable: false description: This attribute defines the date the account was opened. closedDate: type: string format: date-time nullable: true description: This attribute defines the date the account was closed. dormantDate: type: string format: date-time description: This attribute defines the date the account status changed to dormant. nullable: true escheatDate: type: string format: date-time description: This attribute defines the date the account status changed to escheat. nullable: true inactiveDate: type: string format: date-time description: This attribute defines the date the account status changed to inactive. nullable: true chargedOffDate: type: string format: date-time description: This attribute defines the date the account is charged off. nullable: true chargedOffAmount: 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 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 autoClose: type: boolean description: This attribute defines if the account will automatically close when brought to a zero balance. This attribute will work in conjunction with the Number of Days at a zero balance before closing. nullable: false regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible regEOptInDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false waiveOdNsfFees: type: boolean description: This attribute defines if an account is set to waive all OD/NSF fees. nullable: true waiveServiceCharge: type: boolean description: This attribute defines whether service charges can be waived on an account. nullable: true waiveServiceChargeReason: type: string description: This attribute defines the reason an account is set to waive service charges. nullable: true federalWithholdingFlag: type: boolean description: This attribute defines whether federal withholding is taken from interest accrual. nullable: true stateWithholdingFlag: type: boolean description: This attribute defines whether state withholding is taken from interest accrual. nullable: true interestRate: type: number format: float64 description: This attribute defines the interest rate of the account. 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. /a/api/acct-svcs/v1/{InstitutionUniversalId}/accounts/search: post: tags: - Accounts summary: API to search for accounts description: API to search for accounts operationId: SearchAccount 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: '10' 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 description: Either accountNumber or productId is required properties: accountNumber: type: string description: This attribute defines a search on all or the last 4 digits of an account number. nullable: true minLength: 4 maxLength: 34 productId: type: string format: uuid description: This attribute defines the productId of a product assigned to an account. nullable: true additionalProperties: false responses: '200': description: Success content: application/json: schema: type: object required: - accounts - paging properties: accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: 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 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 accountStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' nullable: 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 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}/accounts/search: post: tags: - Accounts summary: API to search for accounts description: API to search for accounts operationId: SearchAccountWithUserId 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: '10' 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 description: Either accountNumber or productId is required properties: accountNumber: type: string description: This attribute defines a search on all or the last 4 digits of an account number. nullable: true minLength: 4 maxLength: 34 productId: type: string format: uuid description: This attribute defines the productId of a product assigned to an account. nullable: true additionalProperties: false responses: '200': description: Success content: application/json: schema: type: object required: - accounts - paging properties: accounts: type: array items: type: object required: - id - accountNumber - accountType - accountStatus - productId properties: id: type: string format: uuid description: This attribute defines the unique account identifier. nullable: false accountNumber: type: string description: This attribute defines the account number assigned to an account. minLength: 6 maxLength: 34 nullable: false accountType: 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 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 accountStatusDisplay: type: string description: This attribute defines the display value for the associated enum. nullable: false productId: type: string format: uuid description: 'This attribute defines the productId of a product assigned to an account. Attributes that can be defined are: cycle day, OD/NSF charges, fees, dormant days, accrual methods if interest is paid, etc.' nullable: 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 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}/accounts/{Id}/closure-eligibility: get: operationId: AccountClosureEligibilityGet tags: - Accounts summary: API to get Account Closure Eligibility description: API to get Account Closure Eligibility 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 an Account required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object required: - isEligible - closureSnapshot properties: isEligible: type: boolean description: This attribute defines whether the account is eligible for closure. closureSnapshot: type: object required: - accountStatus - currentBalance - unpaidAccruedInterest 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 currentBalance: 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 unpaidAccruedInterest: 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 federalWithholding: 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 stateWithholding: 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 failureConditions: type: array items: type: string description: This attribute provides a list of conditions that prevent the account from being closed. nullable: true 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}/accounts/{Id}/closure-eligibility: get: operationId: AccountClosureEligibilityGetWithEnterpriseUserId tags: - Accounts summary: API to get Account Closure Eligibility description: API to get Account Closure Eligibility 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 an Account required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object required: - isEligible - closureSnapshot properties: isEligible: type: boolean description: This attribute defines whether the account is eligible for closure. closureSnapshot: type: object required: - accountStatus - currentBalance - unpaidAccruedInterest 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 currentBalance: 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 unpaidAccruedInterest: 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 federalWithholding: 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 stateWithholding: 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 failureConditions: type: array items: type: string description: This attribute provides a list of conditions that prevent the account from being closed. nullable: true 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}/accounts/{Id}/close: post: operationId: AccountClose tags: - Accounts summary: API to close an Account description: API to close 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: Id in: path description: A unique identifier to establish the identity of an Account 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}/accounts/{Id}/close: post: operationId: AccountCloseWithEnterpriseUserId tags: - Accounts summary: API to close an Account description: API to close 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: Id in: path description: A unique identifier to establish the identity of an Account 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}/accounts/{AccountId}/available-balance: get: operationId: GetAccountAvailableBalance tags: - Accounts summary: API to get an Account available balance by AccountId description: Method to get an Account available balance by AccountId 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 record for which the message is intended required: true schema: type: string format: uuid - name: AvailableBalCalcSettingId in: query description: 'The available balance calculation settings to use by the API to determine the available balance. If not supplied, the default balance calculations settings will be used. <br>Example: `.../available-balance?AvailableBalCalcSettingId=25aef5cb-8273-4cdb-90e1-25d21027f1d3`' schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: accountId: description: This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountStatus: nullable: false 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 availableBalCalcSettingId: type: string format: uuid description: This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: 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 description: This attribute defines the current balance of the account. holds: 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 description: This attribute defines total holds for the account. float: 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 description: This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: 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 description: This attribute defines the available balance that excludes overdraft protection. 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 description: This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: 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 description: This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: 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 description: This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. '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}/accounts/{AccountId}/available-balance: get: operationId: GetAccountAvailableBalanceWithEnterpriseUserId tags: - Accounts summary: API to get an Account available balance by AccountId description: Method to get an Account available balance by AccountId 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 record for which the message is intended required: true schema: type: string format: uuid - name: AvailableBalCalcSettingId in: query description: 'The available balance calculation settings to use by the API to determine the available balance. If not supplied, the default balance calculations settings will be used. <br>Example: `.../available-balance?AvailableBalCalcSettingId=25aef5cb-8273-4cdb-90e1-25d21027f1d3`' schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: accountId: description: This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountStatus: nullable: false 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 availableBalCalcSettingId: type: string format: uuid description: This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: 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 description: This attribute defines the current balance of the account. holds: 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 description: This attribute defines total holds for the account. float: 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 description: This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: 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 description: This attribute defines the available balance that excludes overdraft protection. 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 description: This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: 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 description: This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: 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 description: This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. '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}/accounts/available-balance: post: operationId: GetAccountsAvailableBalances tags: - Accounts summary: API to get available balances for multiple Accounts by AccountIds description: Method to get available balances for multiple Accounts by AccountIds 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: AvailableBalCalcSettingId in: query description: 'The available balance calculation settings to use by the API to determine the available balance. If not supplied, the default balance calculations settings will be used. <br>Example: `.../available-balance?AvailableBalCalcSettingId=25aef5cb-8273-4cdb-90e1-25d21027f1d3`' schema: type: string format: uuid requestBody: description: An array of AccountIds content: application/json: schema: type: array description: An array of strings. items: type: string format: uuid description: AccountId nullable: false nullable: false responses: '200': description: Success content: application/json: schema: type: array description: An array of account available balances. items: type: object properties: accountId: description: This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountStatus: nullable: false 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 availableBalCalcSettingId: type: string format: uuid description: This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: 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 description: This attribute defines the current balance of the account. holds: 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 description: This attribute defines total holds for the account. float: 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 description: This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: 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 description: This attribute defines the available balance that excludes overdraft protection. 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 description: This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: 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 description: This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: 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 description: This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. nullable: false '207': description: Partial Success - Some or all of the AccountIds submitted were not found. Successful instance will return same example as 200. content: application/json: schema: type: array description: An array of account available balances. items: type: object properties: accountId: description: This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: type: string example: Account Not Found accountType: type: string example: '' accountStatus: type: string example: Account Not Found nullable: 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}/accounts/available-balance: post: operationId: GetAccountsAvailableBalancesWithEnterpriseUserId tags: - Accounts summary: API to get available balances for multiple Accounts by AccountIds description: Method to get available balances for multiple Accounts by AccountIds 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: AvailableBalCalcSettingId in: query description: 'The available balance calculation settings to use by the API to determine the available balance. If not supplied, the default balance calculations settings will be used. <br>Example: `.../available-balance?AvailableBalCalcSettingId=25aef5cb-8273-4cdb-90e1-25d21027f1d3`' schema: type: string format: uuid requestBody: description: An array of AccountIds content: application/json: schema: type: array description: An array of strings. items: type: string format: uuid description: AccountId nullable: false nullable: false responses: '200': description: Success content: application/json: schema: type: array description: An array of account available balances. items: type: object properties: accountId: description: This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: description: This attribute defines the account number associated with the account identifier. type: string nullable: false maxLength: 34 accountType: nullable: false type: string description: This enum attribute defines the account type. enum: - checking - savings accountStatus: nullable: false 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 availableBalCalcSettingId: type: string format: uuid description: This attribute defines the Unique identifier that represents the available balance calculation setting. nullable: false description: type: string maxLength: 50 description: This attribute defines the description of the available balance calculation setting. nullable: true currentBalance: 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 description: This attribute defines the current balance of the account. holds: 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 description: This attribute defines total holds for the account. float: 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 description: This attribute defines the total float amount for the account. availableBalanceExcludeOverdraft: 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 description: This attribute defines the available balance that excludes overdraft protection. 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 description: This attribute defines the amount the account can overdraw. availableBalanceIncludeOverdraft: 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 description: This attribute dfines the available balance that includes overdraft protection. regEOptIn: nullable: true type: string description: This enum attributre defines the account RegEOptIn setting. enum: - decline - accept - ineligible availableBalanceRegEOptIn: 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 description: This attribute defines the available balance based on the RegEOptIn value calculation. If the value is accept the overdraftLimit is included. If the value is NOT accept overdraftLimit is excluded. nullable: false '207': description: Partial Success - Some or all of the AccountIds submitted were not found. Successful instance will return same example as 200. content: application/json: schema: type: array description: An array of account available balances. items: type: object properties: accountId: description: This attribute defines the identifier of the Account. type: string format: uuid nullable: false accountNumber: type: string example: Account Not Found accountType: type: string example: '' accountStatus: type: string example: Account Not Found nullable: 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}/accounts/{AccountId}/account-summary/{OperationalPeriod}: get: operationId: GetAccountSummary tags: - Accounts summary: API to get the Account Summary by Account Id and Operational Period description: Method to get the Account Summary by Account Id and Operational Period 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 record for which the message is intended 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 establish the last operational period requested. required: false schema: type: string format: Date(RFC3339) default: '2024-08-31T00:00:00Z' responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string format: uuid description: Id of the retrieved account summary. nullable: false accountId: type: string format: uuid description: Id of the Account for the retrieved summary. nullable: false operationalPeriod: type: string format: date description: This attribute defines the operational period for the request. (Formatted as RFC3339) nullable: false lastCycleOperationalPeriod: type: string format: date description: This attribute returns the operational period the account was last cycled. (Formatted as RFC3339) nullable: false currentBalance: type: string description: The current balance of the account for the provided operational period. nullable: false opPeriodDelta: type: string description: The operational period delta for the account on the provided operational period. (The total change to the current balance) nullable: false averageBalanceCTD: type: string description: The average of all current balances for the account cycle period, up to the provided operational period. nullable: true lowestBalanceCTD: type: string description: The lowest of all current balances for the account cycle period, up to the provided operational period. nullable: true accumulatedBalanceCTD: type: string description: The total of all current balances for the account cycle period, up to the provided operational period. nullable: true daysCTD: type: integer description: The total days into the current cycle, since the last account cycle. nullable: true lastActivityDate: type: string format: date description: The date of last activity for the account. Will be null if no transaction activity has occurred. nullable: true lastDepositDate: type: string format: date description: The date of the last deposit transaction for the account. Will be null if none have posted. nullable: true lastDepositAmount: type: string description: The amount of the last deposit transaction posted to the account. nullable: true lastWithdrawalDate: type: string format: date description: The date of the last withdrawal transaction posted to the account. Will be null if none have posted. nullable: true lastWithdrawalAmount: type: string description: The amount of the last withdrawal transaction posted to the account. nullable: true totalNumberOfDebitsPostedCTD: type: integer description: The total debit transactions posted since the last account cycle. nullable: true totalNumberOfCreditsPostedCTD: type: integer description: The total credit transactions posted since the last account cycle. nullable: true totalNumberOfDebitsInclFeesInterestCTD: type: integer description: The total debit transactions including fees and interest posted since the last account cycle. nullable: true totalNumberOfCreditsInclFeesInterestCTD: type: integer description: The total credit transactions including fees and interest posted since the last account cycle. nullable: true debitsAmountInclFeesInterestCTD: type: string description: The amount of all debits including fees and interest posted to the account. nullable: true creditsAmountInclFeesInterestCTD: type: string description: The amount of all debits including fees and interest posted to the account. nullable: true createdDate: type: string format: date description: The date the record was created. nullable: false modifiedDate: type: string format: date description: The date the record was last modified. 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}/accounts/{AccountId}/account-summary/{OperationalPeriod} : get: operationId: GetAccountSummaryWithEnterpriseUserId tags: - Accounts summary: API to get the Account Summary by Account Id and Operational Period description: Method to get the Account Summary by Account Id and Operational Period 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 record for which the message is intended 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 establish the last operational period requested. required: false schema: type: string format: Date(RFC3339) default: '2024-08-31T00:00:00Z' responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string format: uuid description: Id of the retrieved account summary. nullable: false accountId: type: string format: uuid description: Id of the Account for the retrieved summary. nullable: false operationalPeriod: type: string format: date description: This attribute defines the operational period for the request. (Formatted as RFC3339) nullable: false lastCycleOperationalPeriod: type: string format: date description: This attribute returns the operational period the account was last cycled. (Formatted as RFC3339) nullable: false currentBalance: type: string description: The current balance of the account for the provided operational period. nullable: false opPeriodDelta: type: string description: The operational period delta for the account on the provided operational period. (The total change to the current balance) nullable: false averageBalanceCTD: type: string description: The average of all current balances for the account cycle period, up to the provided operational period. nullable: true lowestBalanceCTD: type: string description: The lowest of all current balances for the account cycle period, up to the provided operational period. nullable: true accumulatedBalanceCTD: type: string description: The total of all current balances for the account cycle period, up to the provided operational period. nullable: true daysCTD: type: integer description: The total days into the current cycle, since the last account cycle. nullable: true lastActivityDate: type: string format: date description: The date of last activity for the account. Will be null if no transaction activity has occurred. nullable: true lastDepositDate: type: string format: date description: The date of the last deposit transaction for the account. Will be null if none have posted. nullable: true lastDepositAmount: type: string description: The amount of the last deposit transaction posted to the account. nullable: true lastWithdrawalDate: type: string format: date description: The date of the last withdrawal transaction posted to the account. Will be null if none have posted. nullable: true lastWithdrawalAmount: type: string description: The amount of the last withdrawal transaction posted to the account. nullable: true totalNumberOfDebitsPostedCTD: type: integer description: The total debit transactions posted since the last account cycle. nullable: true totalNumberOfCreditsPostedCTD: type: integer description: The total credit transactions posted since the last account cycle. nullable: true totalNumberOfDebitsInclFeesInterestCTD: type: integer description: The total debit transactions including fees and interest posted since the last account cycle. nullable: true totalNumberOfCreditsInclFeesInterestCTD: type: integer description: The total credit transactions including fees and interest posted since the last account cycle. nullable: true debitsAmountInclFeesInterestCTD: type: string description: The amount of all debits including fees and interest posted to the account. nullable: true creditsAmountInclFeesInterestCTD: type: string description: The amount of all debits including fees and interest posted to the account. nullable: true createdDate: type: string format: date description: The date the record was created. nullable: false modifiedDate: type: string format: date description: The date the record was last modified. 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