B3

B3 Internal API

The Internal API from B3 — 1 operation(s) for internal.

Operations 3

POST /v1/internal/anyspend/order-completed
POST /v1/internal/credits/deposit
POST /v1/internal/subscription/cancel

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/b3-internal-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

b3-internal-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: B3 Internal API
  version: '1.0'
  description: 'Operations tagged Internal across 2 of this provider''s published API definitions: b3-b3os-workflow-openapi.json, b3-internal-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.b3os.org/v1
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Internal
paths:
  /v1/internal/anyspend/order-completed:
    post:
      description: Handle AnySpend order-completed callback
      parameters:
      - description: API key for authentication
        in: header
        name: x-api-key
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
              - $ref: '#/components/schemas/AnySpendOrderCallbackParams'
                summary: body
                description: AnySpend callback payload
        description: AnySpend callback payload
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnySpendOrderCallbackResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Unauthorized
      tags:
      - Internal
  /v1/internal/credits/deposit:
    post:
      description: Handle credits deposit after payment
      parameters:
      - description: API key for authentication
        in: header
        name: x-api-key
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
              - $ref: '#/components/schemas/CreditsDepositParams'
                summary: body
                description: Credits deposit payload
        description: Credits deposit payload
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsDepositResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Unauthorized
      tags:
      - Internal
  /v1/internal/subscription/cancel:
    post:
      description: Cancel subscription and downgrade org (internal)
      parameters:
      - description: API key
        in: header
        name: x-api-key
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
              - $ref: '#/components/schemas/InternalSubscriptionCancelParams'
                summary: body
                description: Cancel params
        description: Cancel params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalSubscriptionCancelResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Unauthorized
      tags:
      - Internal
components:
  schemas:
    github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse:
      properties:
        code:
          type: integer
        details:
          items: {}
          type: array
          uniqueItems: false
        message:
          type: string
        requestId:
          type: string
      type: object
    AnySpendOrderCallbackParams:
      properties:
        callbackMetadata:
          additionalProperties: {}
          type: object
        clientReferenceId:
          type: string
        event:
          type: string
        orderId:
          type: string
        payment:
          $ref: '#/components/schemas/AnySpendPaymentDetails'
        status:
          type: string
        txHash:
          type: string
      type: object
    AnySpendPaymentDetails:
      properties:
        dstAmount:
          type: string
        dstChain:
          type: integer
        dstTokenAddress:
          type: string
        dstTokenDecimals:
          type: integer
        dstTokenSymbol:
          type: string
        recipientAddress:
          type: string
      type: object
    InternalSubscriptionCancelParams:
      properties:
        customerOrgId:
          type: string
      required:
      - customerOrgId
      type: object
    CreditsDepositParams:
      properties:
        amountPaidCents:
          description: optional payment validation
          type: integer
        interval:
          description: from subscription metadata
          type: string
        orgId:
          type: string
        referenceId:
          type: string
        resetBeforeDeposit:
          description: default false = additive
          type: boolean
        source:
          type: string
        stripeCustomerId:
          description: from invoice.paid event
          type: string
        stripeSubscriptionId:
          description: from invoice.paid event
          type: string
        tier:
          type: string
      required:
      - orgId
      - referenceId
      - source
      - tier
      type: object
    CreditsDepositBalanceChange:
      properties:
        new:
          type: number
        old:
          type: number
      type: object
    InternalSubscriptionCancelResponse:
      properties:
        newTier:
          type: string
        oldTier:
          type: string
      type: object
    AnySpendOrderCallbackResponse:
      properties:
        executionId:
          type: string
        runId:
          type: string
      type: object
    CreditsDepositResponse:
      properties:
        aiBalance:
          $ref: '#/components/schemas/CreditsDepositBalanceChange'
        creditsInserted:
          type: boolean
        cuBalance:
          $ref: '#/components/schemas/CreditsDepositBalanceChange'
      type: object
    AnySpendOrderCallbackResponse_2:
      properties:
        runId:
          type: string
      type: object
x-refined-from:
- b3-b3os-workflow-openapi.json
- b3-internal-api-openapi.yml