Polygon Labs Deposit Addresses API

openapi: 3.2.0
info:
  title: Polygon Labs Deposit Addresses 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: Deposit Addresses
paths:
  /deposit-addresses:
    get:
      operationId: get_deposit_addresses
      tags:
      - Deposit Addresses
      summary: List Deposit Addresses
      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/GetDepositAddressesResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_deposit_addresses
      tags:
      - Deposit Addresses
      summary: Create a Deposit Address
      x-source: https://docs.polygon.technology/api-reference/overview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDepositAddressesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostDepositAddressesResponse'
      x-evidence:
        kind: documentation
  /deposit-addresses/{depositaddressid}:
    get:
      operationId: get_deposit_addresses_depositaddressid
      tags:
      - Deposit Addresses
      summary: Retrieve a Deposit Address
      x-source: https://docs.polygon.technology/api-reference/overview
      parameters:
      - name: depositaddressid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDepositAddressesDepositaddressidResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_deposit_addresses_depositaddressid
      tags:
      - Deposit Addresses
      summary: Update a Deposit Address
      x-source: https://docs.polygon.technology/api-reference/overview
      parameters:
      - name: depositaddressid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchDepositAddressesDepositaddressidRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchDepositAddressesDepositaddressidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetDepositAddressesDepositaddressidResponse:
      type: object
      properties:
        depositAddressId:
          type: string
          description: Identifier of the deposit address.
        status:
          type: string
          description: Current status of the deposit address.
        depositInstructions:
          type: string
          description: On‑chain address for incoming funds.
    GetDepositAddressesResponse:
      type: object
      properties:
        depositAddresses:
          type: string
          description: Array of deposit address objects.
    PostDepositAddressesRequest:
      type: object
      properties:
        customerId:
          type: string
          description: Customer owning the deposit address.
        expectedSourceAsset:
          type: string
          description: Asset expected to be deposited.
        expectedSourceNetwork:
          type: string
          description: Network of the expected source asset.
        destinationExternalAccountId:
          type: string
          description: Registered bank external account to receive payouts.
      required:
      - customerId
      - expectedSourceAsset
      - expectedSourceNetwork
      - destinationExternalAccountId
    PatchDepositAddressesDepositaddressidResponse:
      type: object
      properties:
        depositAddressId:
          type: string
          description: Identifier of the updated deposit address.
        status:
          type: string
          description: Updated status.
    PostDepositAddressesResponse:
      type: object
      properties:
        depositAddressId:
          type: string
          description: Identifier of the created deposit address.
        depositInstructions:
          type: string
          description: On‑chain inlet address (null until provisioning completes).
    PatchDepositAddressesDepositaddressidRequest:
      type: object
      properties:
        destinationExternalAccountId:
          type: string
          description: New external account to receive payouts.