Payments

openapi: 3.0.0 info: version: "0.0" title: Bill Pay Payments servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Payments paths: "/users/{userId}/availableDeliveryOptions": get: parameters: - in: path name: userId description: Id of the user required: true schema: type: string tags: - Payments 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 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. Retrieves the available delivery options for a user responses: "200": description: OK content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/deliveriesOptionsResponseV2" "403": description: Forbidden, see `type` enum value for specific failure; userFriendlyMessage is intended to be displayed to end user content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse403" "404": description: Not Found, see `type` enum value for specific failure; userFriendlyMessage is intended to be displayed to end user content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse404" "500": description: Unable to retrieve delivery options from iPay content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" "/users/{userId}/payments": post: parameters: - in: path name: userId description: Id of the user required: true schema: type: string tags: - Payments security: - OpenID_Connect: - '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. Create one (or many) scheduled, potentially recurring payments for multiple payees (only a payment for each payee) responses: "200": description: OK content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/paymentsV2Response" "403": description: Forbidden, see `type` enum value for specific failure; userFriendlyMessage is intended to be displayed to end user content: application/json: schema: type: object $ref: "../schemas.yaml#/components/schemas/errorResponse403" example: type: NotEligibleForPayment userFriendlyMessage: We're unable to update this payee at this time because the payee is not currently active. "500": description: Unable to make any payment content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" requestBody: content: application/json: schema: allOf: - type: object properties: allowDuplicate: type: boolean description: Controls whether the payment will override a duplicate payment. If false and a duplicate payment is found, an error for that payment will be returned. If true and a duplicate payment is found, the payment will be submitted. default: false - $ref: "../schemas.yaml#/components/schemas/paymentsCreationV2" get: tags: - Payments security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payments.readonly' - 'https://api.banno.com/consumer/auth/billpay.payments.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. summary: Get payments for userId parameters: - in: path name: userId required: true schema: type: string format: uuid - in: query name: payeeId description: Retrieve payments for specific payeeId, ignoring others required: false 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: Successfully retrieved scheduled payments with payment settings content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/SchedPaymentsWithSettingsV0" "404": description: The user or user settings were not found "500": description: Unable to get payments content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" "/users/{userId}/payment": post: tags: - Payments security: - OpenID_Connect: - '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. summary: Creates an individual payment for a userID parameters: - in: path name: userId required: true schema: type: string format: uuid requestBody: content: application/json: schema: allOf: - type: object properties: allowDuplicate: type: boolean description: Controls whether the payment will override a duplicate payment. If false and a duplicate payment is found, an error for that payment will be returned. If true and a duplicate payment is found, the payment will be submitted. default: false - $ref: "../schemas.yaml#/components/schemas/paymentsCreationPayee" responses: "200": description: Created payment for user content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/SchedPaymentWithSettingsV0" "400": description: Payment has validation errors content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse400" "403": description: Forbidden, see `type` enum value for specific failure; userFriendlyMessage is intended to be displayed to end user content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse403" "404": description: Not Found, see `type` enum value for specific failure; userFriendlyMessage is intended to be displayed to end user content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse404" "409": description: Duplicate payment submitted "500": description: Unable to retrieve delivery options from iPay content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" "/users/{userId}/payees/{payeeId}/availableDeliveryOptions": get: parameters: - in: path name: userId description: Id of the user required: true schema: type: string - in: path name: payeeId description: Id of the payee required: true schema: type: string tags: - Payments 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. Retrieves the available delivery options for a payee responses: "200": description: OK content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/deliveryOptionsResponseV2" "403": description: Forbidden - User lacks bill pay abilities content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse403" "404": description: Not Found "500": description: Unable to retrieve delivery options from iPay content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500" "/users/{userId}/configuration/payments": get: tags: - Payments security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payments.readonly' - 'https://api.banno.com/consumer/auth/billpay.payments.readwrite' summary: Retrieve payment configuration for user 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. parameters: - in: path name: userId required: true schema: type: string format: uuid responses: "200": description: Able to retrieve payment configuration for user content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/paymentsConfigurationResponse" "404": description: Unable to retrieve payment configuration for user (user not persisted) "500": description: Failed to retrieve payments configuration "/users/{userId}/payments/{paymentId}": parameters: - in: path name: userId description: Id of the user required: true schema: type: string - in: path name: paymentId description: Id of the payment required: true schema: type: string get: tags: - Payments security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/billpay.payments.readonly' - 'https://api.banno.com/consumer/auth/billpay.payments.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. responses: "200": description: OK content: "*/*": schema: $ref: "../schemas.yaml#/components/schemas/SchedPaymentWithSettingsV0" "403": description: Forbidden - User is not authorized content: "*/*": schema: $ref: "../schemas.yaml#/components/schemas/errorResponse403" "404": description: The payment did not exist "500": description: Unable to retrieve payment content: application/json: schema: type: object $ref: "../schemas.yaml#/components/schemas/errorResponse500" put: tags: - Payments security: - OpenID_Connect: - '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. Updates a single payment for a user parameters: - in: path name: userId description: Id of the user required: true schema: type: string - in: path name: paymentId description: Id of the payment required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/paymentsV2Response" "400": description: Payment has validation errors content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse400" "403": description: Forbidden - User is not authorized content: application/json: schema: type: object $ref: "../schemas.yaml#/components/schemas/errorResponse403" "500": description: Unable to update payment content: application/json: schema: type: object $ref: "../schemas.yaml#/components/schemas/errorResponse500" requestBody: content: application/json: schema: allOf: - type: object properties: allowDuplicate: type: boolean description: Controls whether the payment will override a duplicate payment. If false and a duplicate payment is found, an error for that payment will be returned. If true and a duplicate payment is found, the payment will be submitted. default: false - $ref: "../schemas.yaml#/components/schemas/paymentsCreationPayee" delete: tags: - Payments security: - OpenID_Connect: - '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. responses: "204": description: OK "403": description: Forbidden - User is not authorized content: "*/*": schema: type: object $ref: "../schemas.yaml#/components/schemas/errorResponse403" example: type: PaymentNotEligible userFriendlyMessage: User friendly message describing what went wrong "404": description: The payment did not exist "500": description: Unable to delete payment content: application/json: schema: $ref: "../schemas.yaml#/components/schemas/errorResponse500"