Payees

openapi: 3.0.0 info: version: "0.0" title: Bill Pay Payees servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Payees paths: "/users/{userId}/payees": get: tags: - Payees security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payees.readonly' - 'https://api.banno.com/consumer/auth/billpay.payees.readwrite' description: | This endpoint supports being used with an Access Token from the Admin API with "View everything – users, messages, settings, and organizations and organization members" permission for Associated User. Get all payees associated with a user. parameters: - in: path name: userId description: Id of the user required: true schema: type: string format: uuid - in: query name: updatedSince description: Retrieve payments that have been updated after the submitted date-time (in ISO-8601 format) required: false schema: type: string format: date-time responses: "200": description: Payees retrieved successfully content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/payeesV0" "401": description: User is unauthorized "403": description: User is forbidden to use bill pay content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse403" "500": description: Internal server error content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" post: tags: - Payees security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payees.readwrite' description: | This endpoint does not support being used with an Access Token from the Admin API. Creates a bill pay payee parameters: - in: path name: userId description: Id of the user required: true schema: type: string requestBody: content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/addPayeeV0" description: Payee being added required: true responses: "200": description: Payee added successfully content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/payeeV0" "400": description: Bad request content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/addPayee400ResponseBetter" "403": description: Forbidden content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/addPayee403ResponseBetter" "500": description: Internal Server Error content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" "/users/{userId}/payees/{payeeId}": get: tags: - Payees security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payees.readonly' - 'https://api.banno.com/consumer/auth/billpay.payees.readwrite' description: | This endpoint supports being used with an Access Token from the Admin API with "View everything – users, messages, settings, and organizations and organization members" permission for Associated User. Get a payee. parameters: - in: path name: userId description: Id of the user required: true schema: type: string format: uuid - in: path name: payeeId description: Id of the payee, equivalent to the Bill Id in the previous model required: true schema: type: string format: uuid responses: "200": description: Payees retrieved successfully content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/payeeV0" "401": description: User is unauthorized "403": description: User is forbidden to use bill pay "404": description: Payee not found "500": description: Internal server error content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" put: tags: - Payees security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payees.readwrite' description: | This endpoint does not support being used with an Access Token from the Admin API. Modifies an existing payee parameters: - in: path name: userId description: Id of the user required: true schema: type: string - in: path name: payeeId description: Id of the payee, equivalent to the Bill Id in the previous model required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/updatePayeeV0" description: Payee being updated required: true responses: "200": description: Payee updated successfully content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/payeeV0" "400": description: Bad request content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/updatePayee400ResponseBetter" "403": description: Forbidden content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/updatePayee403ResponseBetter" "404": description: Payee does not exist "500": description: Internal Server Error content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" "501": description: Edit not supported for that payee type delete: tags: - Payees security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payees.readwrite' description: | This endpoint does not support being used with an Access Token from the Admin API. Deletes an existing payee parameters: - in: path name: userId description: Id of the user required: true schema: type: string - in: path name: payeeId description: Id of the payee, equivalent to the Bill Id in the previous model required: true schema: type: string format: uuid - in: query name: force description: Delete the payee even when pending payments exist required: false schema: type: boolean responses: "204": description: OK "403": description: Forbidden content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/deletePayee403ResponseBetter" "404": description: Payee does not exist content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse404" "409": description: Pending payments exist "500": description: Internal Server Error content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500"