Transfer Settings

openapi: 3.0.0 info: version: "0.0" title: Transfer Settings tags: - name: Institution External Transfer Settings - name: User External Transfer Settings - name: Institution Internal Transfer Settings - name: User Internal Transfer Settings paths: "/a/transfer-settings/api/v0/institutions/{institutionId}/transfer/settings/external": put: tags: - Institution External Transfer Settings description: | Updates the external transfer settings for an institution. A jx institution must have an officer code defined in our database when updating inboundFee or outboundFee. Requires the "Manage external transfers" permission for People/Settings security: - clientCredentials: - https://jackhenry.com/transfer-settings/external.write parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/externalInstTransferSettings" description: inboundDailyLimit, inboundFee, outboundDailyLimit, outboundFee, and additionalMessage are optional and can be null. cutOffTime must be in format HH:mm:ss. required: true responses: "204": description: No Content. If changes are made, an event is created and sent to History. If no changes are made, no event is sent to History. "500": description: >- Internal Server Error (Officer code not defined). One of two error messages: Failed to update `transferType` transfer settings Unable to retrieve `transferType` transfer settings content: application/json: schema: type: string example: Failed to update `transferType` transfer settings "/a/transfer-settings/api/v0/institutions/{institutionId}/users/{userId}/transfer/settings/external": put: tags: - User External Transfer Settings description: | Updates user external transfer settings. A jx institution must have an officer code defined in our database when updating inboundFee or outboundFee, or a 500 Internal Server Error will be returned. Requires the "Manage external transfers" permission for People/Users security: - clientCredentials: - https://jackhenry.com/transfer-settings/external.write parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/externalUserTransferSettings" description: Fee and Limit fields can be null. required: true responses: "204": description: No Content. If changes are made, an event is created and sent to History. If no changes are made, no event is sent to History. "500": description: Internal Server Error (Officer code not defined) content: application/json: schema: type: string example: Officer code not defined "/a/transfer-settings/api/v0/institutions/{institutionId}/transfer/settings/internal": put: tags: - Institution Internal Transfer Settings description: | Updates the internal transfer settings for an institution. transferFee, cutoffTime, and additionalMessage fields are optional. A jx institution must have an officer code defined in our database when updating transferFee. If officer code is not defined, 500 Internal Server Error is returned with message 'Officer code not defined'. Requires the "Manage internal transfers" permission for People/Settings security: - clientCredentials: - https://jackhenry.com/transfer-settings/internal.write parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/internalInstTransferUpdate" required: true responses: "204": description: No Content. If changes are made, an event is created and sent to History. If no changes are made, no event is sent to History. "500": description: >- Internal Server Error (Officer code not defined). One of two error messages: Failed to update `transferType` transfer settings Unable to retrieve `transferType` transfer settings content: application/json: schema: type: string example: Unable to retrieve `transferType` transfer settings "/a/transfer-settings/api/v0/institutions/{institutionId}/users/{userId}/transfer/settings/internal": put: tags: - User Internal Transfer Settings description: | Updates user internal transfer settings. Send null for transfer fee to remove transfer fee user override. A jx institution must have an officer code defined in our database when updating transferFee. If officer code is not defined, 500 Internal Server Error is returned with message 'Officer code not defined'. Requires the "Manage internal transfers" permission for People/Users security: - clientCredentials: - https://jackhenry.com/transfer-settings/internal.write parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/transferFee" required: true responses: "204": description: No Content. If changes are made, an event is created and sent to History. If no changes are made, no event is sent to History. "500": description: Internal Server Error (Officer code not defined) content: application/json: schema: type: string example: Officer code not defined servers: - url: https://banno.com components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://login.jackhenry.com/a/oidc-provider/api/v0/token scopes: {} schemas: externalInstTransferSettings: type: object required: - cutOffTime properties: inboundDailyLimit: type: number description: How much money can a user transfer out on a single day? example: 100 inboundFee: type: number description: How much do we charge a user by making an inbound transfer? example: 2.5 outboundDailyLimit: type: number description: How much money can a user transfer out on a single day? example: 100 outboundFee: type: number description: How much do we charge a user by making an out-bound transfer? example: 2.5 inboundDailyQuantitativeLimit: type: number description: How many inbound transfers can a user make on a single day? example: 42 outboundDailyQuantitativeLimit: type: number description: How many outbound transfers can a user make on a single day? example: 42 cutOffTime: type: string description: This time should be local to institution's timezone format: hh:mm:ss example: "17:00:00" additionalMessage: type: string inboundHighRiskThreshold: type: number description: Threshold amount, up from which an in-bound transfer is to be considered a high-risk operation example: 100 outboundHighRiskThreshold: type: number description: Threshold amount, up from which an out-bound transfer is to be considered a high-risk operation example: 100 externalUserTransferSettings: type: object properties: inboundFee: type: number description: Optional number. Sending null indicates 'user fee value from core'. Field missing indicates to fall back to the setting we already have for the institution. example: 1 outboundFee: type: number description: Optional. Sending null indicates 'user fee value from core'. Field missing indicates to fall back to the setting we already have for the institution. example: 1 dailyInboundLimit: type: number description: Optional. Sending null indicates 'user has no limit'. Field missing indicates to fall back to the setting we already have for the institution. example: 1 dailyOutboundLimit: type: number description: Optional. Sending null indicates 'user has no limit'. Field missing indicates to fall back to the setting we already have for the institution. example: 1 dailyInboundQuantitativeLimit: type: number description: "Optional. How many inbound transfers can this user make in a single day? If this field appears, the field override is set to `true`, otherwise the override is set to `false` " example: 42 dailyOutboundQuantitativeLimit: type: number description: "Optional. How many outbound transfers can this user make in a single day? If this field appears, the field override is set to `true`, otherwise the override is set to `false` " example: 42 inboundHighRiskThreshold: type: number description: Optional. Limit from which an inbound transfer is considered as a high risk operation. example: 1000000.23 outboundHighRiskThreshold: type: number description: Optional. Limit from which an inbound transfer is considered as a high risk operation. example: 1000000.23 overrideInstitutionInboundHighRiskThreshold: type: boolean description: Optional. Whether the User's HighRisk Inbound Threshold should override the Institution's ones overrideInstitutionOutboundHighRiskThreshold: type: boolean description: " Optional. Whether the User's HighRisk Outbound Threshold should override the Institution's ones" internalInstTransferUpdate: type: object properties: transferFee: type: number description: "Optional number. Can be null. A jx institution must have an officer code defined in our database when updating this value. TEMPORARY: when transferFee field is not in request body, 'transfer_fee' will not be changed in the DB." example: 2.5 cutoffTime: type: string description: Optional. Can be null. This time should be local to institution's timezone format: hh:mm:ss example: "17:00:00" additionalMessage: type: string description: optional. Can be null. transferFee: type: object properties: transferFee: type: number description: Optional. Can be null. Send as null to remove transfer fee user override. A jx institution must have an officer code defined in our database when updating transferFee. If an officer code is not defined, 500 Internal Server Error is returned with message 'Officer code not defined'. example: 0