Retrieval

openapi: 3.0.0 info: version: "0.0" title: Bill Pay Sync servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Retrieval paths: "/users/{userId}/billpay/fetch": post: tags: - Retrieval security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payees.readonly' - 'https://api.banno.com/consumer/auth/billpay.payees.readwrite' - 'https://api.banno.com/consumer/auth/billpay.payments.readonly' - 'https://api.banno.com/consumer/auth/billpay.payments.readwrite' description: | This endpoint does not support being used with an Access Token from the Admin API. Perform a Bill Pay sync and returns the Bill Pay Accounts, Payees, and Payments updated for a specific user. In case the user don't have a subscriber id yet, we'll find it for core FIs. For Aggregate/OLB FIs we won't find subscriber id here and will instead leave the FI ability flag set to scrape the subscriber on the MDS `PUT /fetch` in the sync. parameters: - in: path name: userId description: Id of the user required: true schema: type: string format: uuid responses: "200": description: OK content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/fetchResponse" "403": description: "User is forbidden from performing bill pay action (see error type), possible errors include: - SubscriberAccountLocked - BillPayAbilitiesMissing - BillPayProductNotEligible" content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/ServerError" "404": description: "User is unable to perform bill pay action, identifier was not found, possible errors include: - BannoUserNotFound - BannoLoginIdNotFound - SubscriberIdNotFound - SubscriberIdNotFoundScrapeLogin - BannoCommonIdNotFound - BillPayConfigurationNotFound" content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/ServerError" "500": description: Something went wrong (either internally or with iPay), will receive GenericBillPayError content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/ServerError"