Jack Henry & Associates Bill Pay API

openapi: 3.2.0
info:
  title: Banno Consumer Bill Pay API
  description: 'Build apps and services using the same Consumer API that powers Banno

    Mobile and Online. OAuth 2.0 / OpenID Connect protects every endpoint;

    scopes are enforced per resource (e.g. `user.profile.readonly`,

    `transactions.detail.readonly`). All endpoints are scoped under

    `/a/consumer/api/v0` and operate within the context of a `userId`.


    Resource groups documented at

    https://banno.github.io/open-api-docs/consumer-api/api-reference/v0/

    include: Abilities, Account Aggregation, Accounts, ACH, Alerts,

    Bill Pay, Cards, Documents and Statements, Forms, Institutions,

    Messages, OAuth and OpenID Connect, Positive Pay, Routing Numbers,

    Task Events, Transactions, Transfers, User, Wire Transfers, and Zelle.

    '
  version: v0
  contact:
    name: Jack Henry Developer Support
    url: https://jackhenry.dev/support/
  license:
    name: Proprietary
    url: https://www.jackhenry.com/legal/terms-of-use
servers:
- url: https://api.banno.com
  description: Banno production
security:
- openIdConnect: []
tags:
- name: Bill Pay
  description: Bill-payment payees and payments.
paths:
  /a/consumer/api/v0/users/{userId}/bill-pay/payees:
    get:
      summary: List Bill Pay Payees
      operationId: listPayees
      tags:
      - Bill Pay
      security:
      - openIdConnect:
        - https://api.banno.com/consumer/auth/bill-pay.readonly
      parameters:
      - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: Payees.
          content:
            application/json:
              schema:
                type: object
                properties:
                  payees:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payee'
  /a/consumer/api/v0/users/{userId}/bill-pay/payments:
    post:
      summary: Create Bill Pay Payment
      operationId: createBillPayPayment
      tags:
      - Bill Pay
      security:
      - openIdConnect:
        - https://api.banno.com/consumer/auth/bill-pay.write
      parameters:
      - $ref: '#/components/parameters/UserId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillPayPaymentRequest'
      responses:
        '201':
          description: Bill-pay payment scheduled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillPayPayment'
components:
  schemas:
    BillPayPaymentRequest:
      type: object
      required:
      - payeeId
      - fromAccountId
      - amount
      - scheduledDate
      properties:
        payeeId:
          type: string
          format: uuid
        fromAccountId:
          type: string
          format: uuid
        amount:
          type: number
        scheduledDate:
          type: string
          format: date
        memo:
          type: string
    BillPayPayment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        payeeId:
          type: string
          format: uuid
        fromAccountId:
          type: string
          format: uuid
        amount:
          type: number
        scheduledDate:
          type: string
          format: date
        status:
          type: string
          enum:
          - Scheduled
          - Processing
          - Complete
          - Failed
          - Cancelled
    Payee:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        nickname:
          type: string
        accountNumber:
          type: string
        address:
          type: object
          properties:
            line1:
              type: string
            line2:
              type: string
            city:
              type: string
            state:
              type: string
            postalCode:
              type: string
        deliveryMethod:
          type: string
          enum:
          - Electronic
          - Check
  parameters:
    UserId:
      name: userId
      in: path
      required: true
      description: ID of the desired user (UUID format).
      schema:
        type: string
        format: uuid
  securitySchemes:
    openIdConnect:
      type: openIdConnect
      openIdConnectUrl: https://api.banno.com/a/oidc/.well-known/openid-configuration