Cycle Time Service Charge Fee

openapi: 3.0.3 info: title: Platform Fee APIs - Cycle Time Service Charge Fee version: v1 description: | Platform Fee APIs. contact: name: Platform Services - Platform Fee url: https://www.jackhenry.com/ email: DC-Operations@jackhenry.com servers: - url: http://jx-r.jhacorp.com description: Corporate Test Server security: [] tags: - name: Cycle Time Service Charge Fee description: APIs for Cycle Time Service Charge fees paths: /a/api/platform/v1/{InstitutionUniversalId}/fees/cycle-time-service-charge-fee: post: operationId: CreateCycleTimeServiceChargeFee tags: - Cycle Time Service Charge Fee summary: API to create a cycle time service charge fee. description: API to create a cycle time service charge fee. 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 cycle time service charge fee to be created. content: application/json: schema: allOf: - required: - name - fee - description - minimumLowBalance - minimumAverageBalance - perDebitFee - canOverdrawAccount - type: object properties: name: type: string description: The name of the fee. fee: 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: type: string description: The description of the fee. minimumLowBalance: type: string format: currency minimumAverageBalance: type: string format: currency perDebitFee: type: string format: currency perDebitFeeDescription: type: string description: The description of the fee. numberOfFreeDebits: type: integer description: The number of free debits before any ‘Cycle Per Debit Fees’ are assessed. For example, the FI allows for 10 free debits before any Cycle. canOverdrawAccount: type: boolean description: Indicates if the calculated fee should be allowed to overdraw the account balance. responses: '201': description: Success content: application/json: schema: allOf: - type: object properties: messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string additionalProperties: false - required: - id - type: object properties: id: type: string format: uuid description: The ID assigned to the fee when it was successfully added. '400': description: | Bad Request: The server could not understand the request due to an invalid request. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string '401': description: | Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '403': description: | Forbidden: 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. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '404': description: | Not Found: 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. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '500': description: | Unexpected Error: An unexpected internal server error occurred while processing the request. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/platform/v1/{InstitutionUniversalId}/fees/cycle-time-service-charge-fee/{FeeId}: get: operationId: GetCycleTimeServiceChargeFee tags: - Cycle Time Service Charge Fee summary: API to read a cycle time service charge fee. description: API to read a cycle time service charge fee. 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: FeeId in: path description: The ID assigned to the fee when it was successfully added. required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: allOf: - required: - name - fee - description - minimumLowBalance - minimumAverageBalance - perDebitFee - perDebitFeeDescription - canOverdrawAccount - numberOfFreeDebits - active type: object properties: messageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string name: type: string description: The name of the fee. fee: 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: type: string description: The description of the fee. minimumLowBalance: type: string format: currency description: The minimum low balance to avoid all cycle time service charges. minimumAverageBalance: type: string format: currency description: The minimum average balance to avoid all cycle time service charges. perDebitFee: type: string format: currency description: The fee to be assessed for each debit that posted during the cycle period. perDebitFeeDescription: type: string description: The description of the fee. numberOfFreeDebits: type: integer description: The number of free debits before any ‘Cycle Per Debit Fees’ are assessed. For example, the FI allows for 10 free debits before any Cycle. canOverdrawAccount: type: boolean description: Indicates if the calculated fee should be allowed to overdraw the account balance. active: type: boolean description: Indicates if the fee is active or inactive. '400': description: | Bad Request: The server could not understand the request due to an invalid request. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string '401': description: | Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '403': description: | Forbidden: 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. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '404': description: | Not Found: 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. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '500': description: | Unexpected Error: An unexpected internal server error occurred while processing the request. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error delete: operationId: DeleteCycleTimeServiceChargeFee tags: - Cycle Time Service Charge Fee summary: API to delete a cycle time service charge fee. description: API to delete a cycle time service charge fee. 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: FeeId in: path description: The ID assigned to the fee when it was successfully added. required: true schema: type: string format: uuid responses: '204': description: Success '400': description: | Bad Request: The server could not understand the request due to an invalid request. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string '401': description: | Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '403': description: | Forbidden: 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. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '404': description: | Not Found: 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. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '500': description: | Unexpected Error: An unexpected internal server error occurred while processing the request. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error put: operationId: UpdateCycleTimeServiceChargeFee tags: - Cycle Time Service Charge Fee summary: API to update a cycle time service charge fee. description: API to update a cycle time service charge fee. 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: FeeId in: path description: The ID assigned to the fee when it was successfully added. required: true schema: type: string format: uuid requestBody: description: The cycle time service charge fee to be updated. content: application/json: schema: allOf: - required: - name - fee - description - minimumLowBalance - minimumAverageBalance - perDebitFee - canOverdrawAccount - type: object properties: name: type: string description: The name of the fee. fee: type: string format: currency description: type: string description: The description of the fee. minimumLowBalance: type: string format: currency minimumAverageBalance: type: string format: currency perDebitFee: type: string format: currency perDebitFeeDescription: type: string description: The description of the fee. numberOfFreeDebits: type: integer description: The number of free debits before any ‘Cycle Per Debit Fees’ are assessed. For example, the FI allows for 10 free debits before any Cycle. canOverdrawAccount: type: boolean description: Indicates if the calculated fee should be allowed to overdraw the account balance. responses: '204': description: Success '400': description: | Bad Request: The server could not understand the request due to an invalid request. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string '401': description: | Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '403': description: | Forbidden: 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. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '404': description: | Not Found: 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. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '500': description: | Unexpected Error: An unexpected internal server error occurred while processing the request. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error /a/api/platform/v1/{InstitutionUniversalId}/fees/cycle-time-service-charge-fee/{FeeId}/calculate: post: operationId: CalculateCycleTimeServiceChargeFee tags: - Cycle Time Service Charge Fee summary: API to calculate a cycle time service charge fee. description: API to calculate a cycle time service charge fee. 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: FeeId in: path description: The ID assigned to the fee when it was successfully added. required: true schema: type: string format: uuid requestBody: description: The cycle time service charge fee to be calculated. content: application/json: schema: allOf: - required: - accountBalance - lowBalance - averageBalance - debitsPosted type: object properties: accountBalance: type: string format: currency description: The current balance of the account to determine if calculated service charge should overdraw the account balance. lowBalance: type: string format: currency description: The lowest balance for this cycle period; this is needed for minimum low balance test to waive all service charges. averageBalance: type: string format: currency description: The average balance for this cycle period; this is needed for the minimum average balance test to waive all service charges. debitsPosted: description: Total number of debits posted during this cycle period; this is needed for per debit fee calculation. type: integer responses: '200': description: Success content: application/json: schema: allOf: - required: - fee - description - perDebitFee - perDebitFeeDescription - type: object properties: fee: 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: type: string description: The description of the fee. perDebitFee: type: string format: currency description: The Per Debit Cycle Time Service charge fee that should be assessed when the statement cycle occurs. perDebitFeeDescription: description: The Per Debit Fee Cycle Time Service Charge fee description that should be printed on the customer’s statement. type: string '400': description: | Bad Request: The server could not understand the request due to an invalid request. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string '401': description: | Unauthorized: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '403': description: | Forbidden: 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. headers: X-Request-ID: required: true description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '404': description: | Not Found: 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. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 '500': description: | Unexpected Error: An unexpected internal server error occurred while processing the request. headers: X-Request-ID: description: "The `X-Request-Id` is used to track and identify individual requests as they traverse various systems to enable tracing and troubleshooting. If one is not provided in the request, the API generates this ID. A new ID is generated for each service call when a request requires calls to other services. Developers and system administrators use this ID to correlate logs and monitor the flow of requests through multiple systems. \n" required: false schema: type: string format: uuid example: 368b8d8f-5d07-4612-9523-d92fd57b0341 X-Correlation-ID: required: true description: | The `X-Correlation-ID` header is used to correlate related requests and responses within a distributed system. This header allows clients to assign a unique identifier to a request, which servers or middleware components can then use to track and link subsequent requests and responses that are part of the same logical operation or transaction. schema: type: string format: uuid example: 8e87d005-f99f-40ab-a4e0-811f9263f1e7 X-WorkflowCorrelationId: description: | The `X-WorkflowCorrelationId` header correlates different requests or events as part of a workflow or process. It is used to track and manage the flow of requests throughout multiple systems. When a workflow client sends multiple related requests, they can include the `X-WorkflowCorrelationId` header with the same value to indicate that these requests are part of the same workflow to support the grouping and associating the requests together, thus enabling reporting systems to identify them as a single logical unit. Additionally, this header element can assist in monitoring and troubleshooting the workflow by allowing administrators or developers to trace and analyze the flow of requests using this common identifier. required: false schema: type: string format: uuid example: 062e61c8-1d5f-41c6-9ddb-e00f35004e60 content: application/problem+json: schema: type: object required: - type - title properties: type: description: A string path which uniquely classifies the domain of the error. type: string title: description: A user readable string title of the error type. type: string details: description: An array of strings which provide additional details for the error message. type: array items: type: string data: description: An array of strings which provide additional data for the error message. type: array items: type: object properties: description: type: string element: type: string elementValue: type: string examples: internalServerError: summary: Internal server error value: type: general/internal-server-error title: Internal server error details: - Unexpected internal server error

Please ignore this field