Polygon Labs Virtual Accounts API

openapi: 3.2.0
info:
  title: Polygon Labs Virtual Accounts API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 32 operation(s) read from 4 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Polygon Labs has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 30
    pages-with-code: 3
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.polygon.technology/pos/reference/commands.md
  - https://docs.polygon.technology/api-reference/reference/list-supported-networks.md
  - https://docs.polygon.technology/api-reference/overview
  - https://docs.polygon.technology/api-reference/overview.md
servers:
- url: https://sandbox-api.polygon.technology
tags:
- name: Virtual Accounts
paths:
  /virtual-accounts:
    get:
      operationId: get_virtual_accounts
      tags:
      - Virtual Accounts
      summary: List Virtual Accounts
      x-source: https://docs.polygon.technology/api-reference/overview
      parameters:
      - name: customerId
        in: query
        required: false
        schema:
          type: string
        description: Optional filter by customer.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualAccountsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_virtual_accounts
      tags:
      - Virtual Accounts
      summary: Create a Virtual Account
      x-source: https://docs.polygon.technology/api-reference/overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostVirtualAccountsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostVirtualAccountsResponse'
      x-evidence:
        kind: documentation
  /virtual-accounts/{id}/simulate/inbound-transfer:
    post:
      operationId: post_virtual_accounts_id_simulate_inbound_transfer
      tags:
      - Virtual Accounts
      summary: Simulate an inbound transfer for a Virtual Account
      x-source: https://docs.polygon.technology/api-reference/overview
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /virtual-accounts/{virtualaccountid}:
    delete:
      operationId: delete_virtual_accounts_virtualaccountid
      tags:
      - Virtual Accounts
      summary: Delete a Virtual Account
      x-source: https://docs.polygon.technology/api-reference/overview
      parameters:
      - name: virtualaccountid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_virtual_accounts_virtualaccountid
      tags:
      - Virtual Accounts
      summary: Manage Virtual Accounts
      x-source: https://docs.polygon.technology/api-reference/overview
      parameters:
      - name: virtualaccountid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostVirtualAccountsResponse:
      type: object
      properties:
        virtualAccountId:
          type: string
          description: Identifier of the created virtual account.
        bankDetails:
          type: string
          description: Bank account details (null until provisioned).
        status:
          type: string
          description: Current status of the virtual account.
    GetVirtualAccountsResponse:
      type: object
      properties:
        virtualAccounts:
          type: string
          description: Array of virtual account objects.
    PostVirtualAccountsRequest:
      type: object
      properties:
        customerId:
          type: string
          description: Customer owning the virtual account.
        source:
          type: string
          description: Source fiat asset and network (e.g., {"asset":"usd","network":...}).
        walletDestination:
          type: string
          description: Wallet external reference for crypto payout.
        accountHolder:
          type: string
          description: Account holder type, e.g., "customer".
        type:
          type: string
          description: Bank rail type, e.g., "bankUs".
      required:
      - customerId
      - source
      - walletDestination
      - accountHolder
      - type