betteroff-finance Accounts API

The accounts API from betteroff-finance — 10 operation(s) for accounts.

Operations 13

GET /accounts Get accounts #
POST /accounts Post accounts #
PATCH /accounts/reorder Patch accounts reorder #
PATCH /accounts/{id} Patch accounts id #
DELETE /accounts/{id} Delete accounts id #
GET /accounts/{id}/funding-config Get accounts id funding config #
POST /accounts/{id}/funding-link/auth-intent Post accounts id funding link auth intent #
POST /accounts/{id}/funding-link/complete Post accounts id funding link complete #
GET /accounts/{id}/funding-link/status Get accounts id funding link status #
POST /accounts/{id}/funding-quote Post accounts id funding quote #
GET /accounts/{id}/funding-sessions Get accounts id funding sessions #
POST /accounts/{id}/funding-sessions Post accounts id funding sessions #
POST /accounts/{id}/funding-sessions/{sessionId}/checkout Post accounts id funding sessions session id checkout #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/betteroff-finance:betteroff-finance-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

betteroff-finance-accounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Betteroff Finance Accounts API
  version: 0.5.0+cd65185c
  description: 'Operations tagged accounts across 2 of this provider''s published API definitions: betteroff-finance-openapi.json, betteroff-finance-public.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.betteroff.finance
tags:
- name: Accounts
paths:
  /accounts:
    get:
      operationId: getAccounts
      tags:
      - Accounts
      security:
      - session: []
      - apiToken:
        - accounts:read
      x-stability: beta
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  accounts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        name:
                          type: string
                        updatedAt:
                          type: string
                          format: date-time
                          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                      required:
                      - id
                      - name
                      - updatedAt
                      additionalProperties: false
                required:
                - accounts
                additionalProperties: false
          headers:
            RateLimit-Limit:
              description: 'Sent to API tokens and agent grants: requests per minute in the tighter bucket.'
              schema:
                type: integer
            RateLimit-Remaining:
              schema:
                type: integer
            RateLimit-Reset:
              description: Seconds until the window resets.
              schema:
                type: integer
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get accounts
      x-summary-source: derived
    post:
      operationId: postAccounts
      tags:
      - Accounts
      security:
      - session: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                type:
                  type: string
                  minLength: 1
                subtype:
                  type: string
                currentBalance:
                  type: string
                  pattern: ^-?\d+(?:\.\d{1,2})?$
                currency:
                  type: string
                  minLength: 2
                  maxLength: 12
                  pattern: ^[A-Za-z0-9]+$
                visibility:
                  default: household
                  type: string
                  enum:
                  - household
                  - private
              required:
              - name
              - type
              - currency
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post accounts
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/reorder:
    patch:
      operationId: patchAccountsReorder
      tags:
      - Accounts
      security:
      - session: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              anyOf:
              - type: object
                properties:
                  orderedIds:
                    minItems: 1
                    type: array
                    items:
                      type: string
                      format: uuid
                      pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  reset:
                    type: boolean
                    const: false
                required:
                - orderedIds
              - type: object
                properties:
                  reset:
                    type: boolean
                    const: true
                  orderedIds:
                    type: array
                    items:
                      type: string
                      format: uuid
                      pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                required:
                - reset
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Patch accounts reorder
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/{id}:
    patch:
      operationId: patchAccountsId
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        required: false
        description: 'The record''s ETag, or "<epoch-ms>" of its updatedAt. The write applies only while the record still has that version; otherwise 412 PRECONDITION_FAILED and nothing changes. Optional for compatibility: without it the write applies unconditionally.'
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                nickname:
                  anyOf:
                  - type: string
                    maxLength: 80
                  - type: 'null'
                isHidden:
                  type: boolean
                name:
                  type: string
                  maxLength: 200
                currentBalance:
                  type: string
                  pattern: ^-?\d+(?:\.\d{1,2})?$
                excludeFromSync:
                  type: boolean
                displayOrder:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                visibility:
                  type: string
                  enum:
                  - household
                  - private
      responses:
        '200':
          description: Success
          headers:
            ETag:
              description: The record's new version; send it as If-Match on the next write.
              schema:
                type: string
        '412':
          description: The record changed since the If-Match version. Fetch it again and retry.
          content:
            application/problem+json: {}
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Patch accounts id
      x-summary-source: derived
    delete:
      operationId: deleteAccountsId
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        required: false
        description: 'The record''s ETag, or "<epoch-ms>" of its updatedAt. The write applies only while the record still has that version; otherwise 412 PRECONDITION_FAILED and nothing changes. Optional for compatibility: without it the write applies unconditionally.'
        schema:
          type: string
      responses:
        '200':
          description: Success
        '412':
          description: The record changed since the If-Match version. Fetch it again and retry.
          content:
            application/problem+json: {}
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Delete accounts id
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/{id}/funding-config:
    get:
      operationId: getAccountsIdFundingConfig
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get accounts id funding config
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/{id}/funding-link/auth-intent:
    post:
      operationId: postAccountsIdFundingLinkAuthIntent
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                email:
                  type: string
                  maxLength: 254
                  format: email
                  pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
              required:
              - email
              additionalProperties: false
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post accounts id funding link auth intent
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/{id}/funding-link/complete:
    post:
      operationId: postAccountsIdFundingLinkComplete
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                authIntentId:
                  type: string
                  pattern: ^lai_[A-Za-z0-9_]+$
                cryptoCustomerId:
                  type: string
                  pattern: ^crc_[A-Za-z0-9_]+$
              required:
              - authIntentId
              - cryptoCustomerId
              additionalProperties: false
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post accounts id funding link complete
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/{id}/funding-link/status:
    get:
      operationId: getAccountsIdFundingLinkStatus
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get accounts id funding link status
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/{id}/funding-quote:
    post:
      operationId: postAccountsIdFundingQuote
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                amount:
                  type: string
                  pattern: ^\d{1,5}(?:\.\d{1,2})?$
              required:
              - amount
              additionalProperties: false
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post accounts id funding quote
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/{id}/funding-sessions:
    get:
      operationId: getAccountsIdFundingSessions
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get accounts id funding sessions
      x-summary-source: derived
    post:
      operationId: postAccountsIdFundingSessions
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                idempotencyKey:
                  type: string
                  format: uuid
                  pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                amount:
                  type: string
                  pattern: ^\d{1,5}(?:\.\d{1,2})?$
                paymentToken:
                  type: string
                  pattern: ^cpt_[A-Za-z0-9_]+$
              required:
              - idempotencyKey
              - amount
              - paymentToken
              additionalProperties: false
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post accounts id funding sessions
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
  /accounts/{id}/funding-sessions/{sessionId}/checkout:
    post:
      operationId: postAccountsIdFundingSessionsSessionIdCheckout
      tags:
      - Accounts
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: sessionId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties: {}
              additionalProperties: false
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post accounts id funding sessions session id checkout
      x-summary-source: derived
    servers:
    - url: https://api.betteroff.finance
components:
  schemas:
    ProblemDetails:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        type:
          type: string
          description: Always "about:blank"; branch on `code`.
        title:
          type: string
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        detail:
          type: string
        code:
          type: string
          description: Stable UPPER_SNAKE code.
        error:
          type: string
          description: Older clients' copy of `detail`.
        message:
          type: string
          description: Older clients' copy of `detail`.
        requestId:
          description: Diagnostic only; quote it to support.
          type: string
        instance:
          type: string
        details:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
      required:
      - type
      - title
      - status
      - detail
      - code
      - error
      - message
      additionalProperties: {}
      description: RFC 9457 problem details. Some refusals add fields; ignore ones you don't know.
  securitySchemes:
    session:
      type: http
      scheme: bearer
      description: 'The BetterOff app acting for its signed-in user. Not available to integrations: Better Auth session tokens and browser session cookies are rejected. Use an API token or agent OAuth.'
    apiToken:
      type: http
      scheme: bearer
      description: Personal API token (bo_pat_), created in BetterOff settings with the scopes it may use.
    agentOAuth:
      type: openIdConnect
      openIdConnectUrl: https://app.betteroff.finance/api/auth/.well-known/openid-configuration
      description: Agent OAuth grant; the same token and scopes as /mcp.
x-refined-from:
- betteroff-finance-openapi.json
- betteroff-finance-public.json