Augustus Account Programs API

The Account Programs API from Augustus — 3 operation(s) for account programs.

Operations 3

GET /v1/account_programs List account programs #
GET /v1/account_programs/{id}/balance Retrieve account program balance #
GET /v1/account_programs/{id} Retrieve account program #

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/augustus:augustus-account-programs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

augustus-account-programs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Augustus Banking Account Programs API
  description: Augustus Banking API
  version: 0.1.0
  contact:
    name: Augustus
    url: https://docs.augustus.com
    email: developer@augustus.com
servers:
- url: https://api.augustus.com
  description: Production
- url: https://api.sandbox.augustus.com
  description: Sandbox
security:
- BearerAuth: []
tags:
- name: Account Programs
paths:
  /v1/account_programs:
    get:
      description: Lists account programs for the merchant with cursor-based pagination.
      operationId: AccountProgramsController_list
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results per page (1-100). Defaults to 10.
        schema:
          minimum: 1
          maximum: 100
          default: 10
          type: integer
      - name: cursor
        required: false
        in: query
        description: Opaque cursor from a previous next_cursor.
        schema:
          type: string
      responses:
        '200':
          description: Paginated list of account programs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAccountProgramsResponseDto'
      summary: List account programs
      tags:
      - Account Programs
  /v1/account_programs/{id}/balance:
    get:
      description: Returns the aggregated available balance of all accounts under the account program.
      operationId: AccountProgramsController_retrieveBalance
      parameters:
      - name: id
        required: true
        in: path
        description: Unique identifier of the account program.
        schema:
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440002
          type: string
      - name: as_of
        required: false
        in: query
        description: ISO 8601 UTC timestamp to retrieve balance at. Must be at least 5 minutes in the past.
        schema:
          format: date-time
          example: '2026-01-15T10:40:00Z'
          type: string
      responses:
        '200':
          description: Account program balance snapshot
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountProgramBalanceResourceDto'
      summary: Retrieve account program balance
      tags:
      - Account Programs
  /v1/account_programs/{id}:
    get:
      description: Retrieves an account program by ID.
      operationId: AccountProgramsController_retrieve
      parameters:
      - name: id
        required: true
        in: path
        description: Unique identifier of the account program.
        schema:
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440002
          type: string
      responses:
        '200':
          description: The account program resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountProgramResourceDto'
      summary: Retrieve account program
      tags:
      - Account Programs
components:
  schemas:
    AccountProgramResourceDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the account program.
          example: 550e8400-e29b-41d4-a716-446655440002
        type:
          type: string
          description: Resource type discriminator.
          enum:
          - account_program
        label:
          type: string
          description: Human-readable label for the account program.
          example: Primary FBO program
        status:
          type: string
          enum:
          - active
          - frozen
          description: Account program lifecycle status. Closed programs are not returned by this endpoint.
        created_at:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp when the account program was created.
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp when the account program was last updated.
          example: '2026-01-15T10:35:00Z'
      required:
      - id
      - type
      - label
      - status
      - created_at
      - updated_at
      additionalProperties: false
    ListAccountProgramsResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: Unique identifier of the account program.
                example: 550e8400-e29b-41d4-a716-446655440002
              type:
                type: string
                description: Resource type discriminator.
                enum:
                - account_program
              label:
                type: string
                description: Human-readable label for the account program.
                example: Primary FBO program
              status:
                type: string
                enum:
                - active
                - frozen
                description: Account program lifecycle status. Closed programs are not returned by this endpoint.
              created_at:
                type: string
                format: date-time
                description: ISO 8601 UTC timestamp when the account program was created.
                example: '2026-01-15T10:30:00Z'
              updated_at:
                type: string
                format: date-time
                description: ISO 8601 UTC timestamp when the account program was last updated.
                example: '2026-01-15T10:35:00Z'
            required:
            - id
            - type
            - label
            - status
            - created_at
            - updated_at
            additionalProperties: false
        has_more:
          type: boolean
        next_cursor:
          type: string
          example: eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0
          nullable: true
        has_previous:
          type: boolean
        previous_cursor:
          type: string
          example: eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0
          nullable: true
      required:
      - data
      - has_more
      - next_cursor
      - has_previous
      - previous_cursor
      additionalProperties: false
    AccountProgramBalanceResourceDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the account program.
          example: 550e8400-e29b-41d4-a716-446655440002
        type:
          type: string
          description: Resource type discriminator.
          enum:
          - account_program_balance
        amount:
          type: object
          properties:
            available:
              type: string
              description: Available balance as a string decimal (e.g. "100.50").
              example: '100.50'
            pending:
              type: string
              description: Pending balance as a string decimal (e.g. "7.50").
              example: '100.50'
          required:
          - available
          - pending
          additionalProperties: false
        currency:
          type: string
          enum:
          - EUR
          - GBP
          - USD
          description: ISO 4217 currency code.
          example: USD
        as_of:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp when this balance snapshot was produced.
          example: '2026-01-15T10:40:00Z'
      required:
      - id
      - type
      - amount
      - currency
      - as_of
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Bearer token for authentication with Augustus Banking API
x-provenance:
  method: harvested
  publisher: Augustus
  source: https://api.augustus.com/openapi/2026-05-01.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)