Enrollment

openapi: 3.0.0 info: title: Bill Pay Enrollment description: Enrolls users in the iPay bill pay product. version: "0.0" servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Enrollment paths: "/users/{userId}/configuration/billpay": get: tags: - Enrollment security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.enrollment.readwrite' summary: Returns a user's bill pay configuration. description: | This endpoint does not support being used with an Access Token from the Admin API. This bill pay configuration includes a user's bill pay enrollment status, which is intended to be used in conjunction with the institution and user-specific abilities to determine whether to display bill pay enrollment as an option to the user. parameters: - in: path name: userId description: Banno user id required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/BillPayConfiguration" "404": description: User not found "500": description: Server error. "/users/{userId}/billpay/enrollment/eligible": post: tags: - Enrollment security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.enrollment.readwrite' summary: Enrolls all of a user's eligible accounts in bill pay. description: | This endpoint does not support being used with an Access Token from the Admin API. This endpoint enrolls a user in the iPay Bill Pay product and enrolls all accounts that are eligible. The primary bill pay account is picked by default from the checking accounts if available, else the savings accounts. If no accounts are available or the user doesn't have the Banno ability, the user cannot be enrolled. Eligibility: * Deposit account * Account is open
 * Is a core account * Is allowed according to ChanInq (savings allowed, multiple accounts allowed) parameters: - in: path name: userId description: Banno user id required: true schema: type: string responses: "201": description: Bill pay subscriber created. content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/EligibleEnrollmentResponse" "403": description: "Error message reads as: 'The following issues were identified with user information: ' detailing whether the Tax ID, Username, Address, Primary Phone Number, or Email are invalid or missing." content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/ServerError403" "404": description: User not found "500": description: Something went wrong during enrollment content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/ServerError500"