Details

openapi: 3.0.0 info: version: '0.0' title: Zelle tags: - name: Disclosures - name: Allowed Types servers: - url: 'https://banno.com' paths: '/a/consumer/api/institutions/{institutionId}/zelle/allowed-types': parameters: - in: path name: institutionId description: Institution UUID schema: type: string format: uuid required: true get: tags: - Allowed Types description: | Returns an institution's allowed account types. Requires the "View" permission for People responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AllowedTypes' '401': description: 'Failure in the authorization, invalid or expired JWT' '500': description: Server error put: tags: - Allowed Types description: | Updates an institution's allowed account types. Requires the "Manage everything – users, messages & settings" permission for People requestBody: content: application/json: schema: $ref: '#/components/schemas/AllowedTypes' required: true responses: '204': description: The allowed types were updated. '401': description: 'Failure in the authorization, invalid or expired JWT' '500': description: Server error '/a/consumer/api/institutions/{institutionId}/zelle/disclosures': parameters: - in: path name: institutionId description: Institution UUID schema: type: string format: uuid required: true get: tags: - Disclosures description: | Returns the Zelle Disclosures for the institution associated with the authed jwt. Requires the "View" permission for People responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InstitutionDisclosure' '401': description: 'Failure in the authorization, invalid or expired JWT' '500': description: Server error post: tags: - Disclosures description: | Create new Zelle Disclosures for the institution associated with jwt auth Requires the "Manage everything – users, messages & settings" permission for People requestBody: content: application/json: schema: type: object properties: terms: type: string example: 'Terms and Conditions... yada yada yada' required: true responses: '200': description: OK content: application/json: schema: type: object properties: disclosureId: type: string example: 00000000-0000-0000-0000-000000000000 format: uuid terms: type: string example: 'Terms and Conditions... yada yada yada' creationDate: type: string example: '2019-01-01T00:00:00.000Z' '204': description: The new disclosure terms is the same as latest disclosure terms for the institution (no change). '401': description: 'Failure in the authorization, invalid or expired JWT' '404': description: User not found '500': description: Server error '/a/consumer/api/institutions/{institutionId}/zelle/regd': parameters: - in: path name: institutionId description: Institution UUID schema: type: string format: uuid required: true get: tags: - Disclosures description: | Returns the Zelle RegD notice for the institution associated with the authed jwt. Requires the "View" permission for People responses: '200': description: OK '401': description: 'Failure in the authorization, invalid or expired JWT' '404': description: User not found '500': description: Server error post: tags: - Disclosures description: | Insert a new RegD Notice for an institution. (This endpoint requires Enterprise Authentication.) Requires the "Manage everything – users, messages & settings" permission for People requestBody: content: application/json: schema: $ref: '#/components/schemas/RegDNotice' required: true responses: '200': description: Successfully updated regd notice. content: application/json: schema: $ref: '#/components/schemas/RegDNotice' '204': description: The new regD notice is the same as latest regD notice for the institution (no change). '401': description: 'Failure in the authorization, invalid or expired JWT' '500': description: Server Error '/a/consumer/api/institutions/{institutionId}/zelle/regd/toggle': parameters: - in: path name: institutionId description: Institution UUID schema: type: string format: uuid required: true put: tags: - Disclosures description: | Update whether Reg D legal notice should be shown to users. Requires the "Manage everything – users, messages & settings" permission for People requestBody: content: application/json: schema: $ref: '#/components/schemas/RegDToggle' required: true responses: '200': description: Successfully updated regd toggle. '401': description: 'Failure in the authorization, invalid or expired JWT' '500': description: Server Error components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: {} schemas: AllowedTypes: type: object properties: baseAllowedTypes: type: string enum: [ "Checking", "CheckingAndSavings" ] RegDNotice: type: object properties: notice: type: string example: Federal Regulation D limits certain types of withdrawals and transfers made from savings or money market accounts to a combined total of six per account cycle. Withdrawals and/or transfers exceeding the six per account cycle allowance will result in excessive withdrawal fee per transaction. For more infomation please contact us. InstitutionDisclosure: type: object properties: disclosure: nullable: true $ref: '#/components/schemas/Disclosure' Disclosure: type: object properties: disclosureId: type: string example: 00000000-0000-0000-0000-000000000000 format: uuid terms: type: string example: 'Terms and Conditions... yada yada yada' creationDate: type: string example: '2019-01-01T00:00:00.000Z' RegDToggle: type: object properties: enabled: type: boolean description: represents if RegD notice should be shown to users.