apiVersion: naftiko.io/v1alpha1
kind: Capability
metadata:
  name: banno-consumer-api
  title: Banno Consumer API
  provider: jack-henry
  api: banno-consumer-api
  description: >-
    Shared capability surface for the Banno Consumer API powering accountholder
    experiences in Banno Mobile and Online. Provides OAuth/OpenID Connect
    protected access to user profile, accounts, transactions, transfers,
    bill pay, ACH, wires, Zelle, cards, alerts, and messages.
  tags:
    - Consumer Banking
    - Accounts
    - Transactions
    - Transfers
    - Payments
    - OpenID Connect
spec:
  baseUrl: https://api.banno.com
  auth:
    type: openIdConnect
    discoveryUrl: https://api.banno.com/a/oidc/.well-known/openid-configuration
  operations:
    - id: getUser
      title: Get User Profile
      method: GET
      path: /a/consumer/api/v0/users/{userId}
      scopes: [https://api.banno.com/consumer/auth/user.profile.readonly]
    - id: listAccounts
      title: List Accounts
      method: GET
      path: /a/consumer/api/v0/users/{userId}/accounts
      scopes: [https://api.banno.com/consumer/auth/accounts.readonly]
      outputs:
        - schema: ../../json-schema/banno-account-schema.json
      examples:
        - response: ../../examples/banno-consumer-list-accounts-response-example.json
    - id: getAccount
      title: Get Account Details
      method: GET
      path: /a/consumer/api/v0/users/{userId}/accounts/{accountId}
      scopes: [https://api.banno.com/consumer/auth/accounts.detail.readonly]
    - id: listTransactions
      title: List Account Transactions
      method: GET
      path: /a/consumer/api/v0/users/{userId}/accounts/{accountId}/transactions
      scopes: [https://api.banno.com/consumer/auth/transactions.readonly]
      examples:
        - response: ../../examples/banno-consumer-list-transactions-response-example.json
    - id: createTransfer
      title: Create Transfer
      method: POST
      path: /a/consumer/api/v0/users/{userId}/transfers
      scopes: [https://api.banno.com/consumer/auth/transfers.write]
      examples:
        - request: ../../examples/banno-consumer-create-transfer-request-example.json
          response: ../../examples/banno-consumer-create-transfer-response-example.json
    - id: createBillPayPayment
      title: Create Bill Pay Payment
      method: POST
      path: /a/consumer/api/v0/users/{userId}/bill-pay/payments
      scopes: [https://api.banno.com/consumer/auth/bill-pay.write]
    - id: sendZellePayment
      title: Send Zelle Payment
      method: POST
      path: /a/consumer/api/v0/users/{userId}/zelle/payments
      scopes: [https://api.banno.com/consumer/auth/zelle.write]