External Transfer Settings

openapi: 3.0.0 info: title: Settings version: '0.0' servers: - url: 'https://{API_ENVIRONMENT}/a/transfer-settings/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: User External Transfer Settings paths: "/institutions/{institutionId}/users/{userId}/transfer/settings/external/calculated": get: tags: - User External Transfer Settings description: security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/transfers.accounts.readonly' - 'https://api.banno.com/consumer/auth/transfers.accounts.readwrite' parameters: - in: path name: institutionId description: Institution ID required: true schema: type: string - in: path name: userId description: ID of the banno user required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/GetExternalTransferSettings" "403": description: User is not permitted to use External Transfer Settings feature content: application/json: schema: $ref: "#/components/schemas/NoAbilityForbidden" "500": description: Internal error components: securitySchemes: OpenID_Connect: type: openIdConnect description: OpenID Connect - Discovery endpoint will be institution specific openIdConnectUrl: >- https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration schemas: GetExternalTransferSettings: type: object properties: additionalMessage: type: string cutOffTime: type: string description: This time should be local to institution's timezone format: hh:mm:ss example: "17:00:00" 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" NoAbilityForbidden: type: object required: - errorCode properties: errorCode: type: number enum: - 40 description: 40 - User is not permitted use ExternalTransferSettings Endpoints based on the users ability.