Polygon Labs External Accounts API

openapi: 3.2.0
info:
  title: Polygon Labs External 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: External Accounts
paths:
  /external-accounts:
    get:
      operationId: get_external_accounts
      tags:
      - External Accounts
      summary: List with GET /external-accounts?customerId=... (required)
      x-source: https://docs.polygon.technology/api-reference/overview
      parameters:
      - name: customerId
        in: query
        required: true
        schema:
          type: string
        description: Filter external accounts by customer.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExternalAccountsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_external_accounts
      tags:
      - External Accounts
      summary: Register them with POST /external-accounts
      x-source: https://docs.polygon.technology/api-reference/overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostExternalAccountsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostExternalAccountsResponse'
      x-evidence:
        kind: documentation
  /external-accounts/cards:
    post:
      operationId: post_external_accounts_cards
      tags:
      - External Accounts
      summary: Debit cards register through their own endpoint, POST /external-accounts/cards
      x-source: https://docs.polygon.technology/api-reference/overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostExternalAccountsCardsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostExternalAccountsCardsResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostExternalAccountsCardsRequest:
      type: object
      properties:
        owner:
          type: string
          description: Object with kind (customer or counterparty) and corresponding ID.
        type:
          type: string
          description: Must be card.
        card:
          type: string
          description: Object with cardNumber, expiryMonth, expiryYear, cvv, etc.
      required:
      - owner
      - type
      - card
    PostExternalAccountsResponse:
      type: object
      properties:
        id:
          type: string
          description: External account ID (ext_ prefix).
        accountNumberLast4:
          type: string
          description: Last 4 digits of the account number (write‑only on request).
        cardNumberLast4:
          type: string
          description: Last 4 digits of the card number if type is card.
    PostExternalAccountsCardsResponse:
      type: object
      properties:
        id:
          type: string
          description: External account ID (ext_ prefix).
        cardNumberLast4:
          type: string
          description: Last 4 digits of the card number.
    GetExternalAccountsResponse:
      type: object
      properties:
        items:
          type: string
          description: Array of external account objects.
    PostExternalAccountsRequest:
      type: object
      properties:
        owner:
          type: string
          description: Object with kind (customer or counterparty) and corresponding ID.
        type:
          type: string
          description: One of bankUs, bankIban, bankCanada, or walletExternal.
        bankUs:
          type: string
          description: Object with accountNumber, routingNumber, accountType, bankName.
        bankIban:
          type: string
          description: IBAN‑specific fields.
        bankCanada:
          type: string
          description: Canada‑specific fields.
        walletExternal:
          type: string
          description: External wallet fields.
      required:
      - owner
      - type