canopypay-io API

openapi: 3.1.0
info:
  title: canopypay-io API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 11 operation(s) read from 20 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; canopypay-io has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 8
    pages-with-code: 6
    pages-read: 20
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.canopypay.io/reference
  - https://www.canopypay.io/quickstart
  - https://www.canopypay.io/sdk/events
  - https://www.canopypay.io/errors/not_found
  - https://www.canopypay.io/errors/invalid_request
  - https://www.canopypay.io/errors/invalid_json
  - https://www.canopypay.io/errors/payload_too_large
  - https://www.canopypay.io/errors/idempotency_key_reuse
  - https://www.canopypay.io/errors/rate_limited
  - https://www.canopypay.io/errors/source_inbox_unavailable
  - https://www.canopypay.io/errors/source_inbox_refused
  - https://www.canopypay.io/errors/source_inbox_not_active
  - https://www.canopypay.io/errors/customer_not_bound
  - https://www.canopypay.io/agents/headless
  - https://www.canopypay.io/agents/checkout-inline
  - https://www.canopypay.io/agents/checkout-popup
  - https://www.canopypay.io/agents/mcp
  - https://docs.portalhq.io/resources/authentication/overview
  - https://www.canopypay.io/guides/multi-network-deposits
  - https://www.canopypay.io/concepts/payment-intents
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://www.canopypay.io/agents/checkout-inline
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sD- -o /dev/null  \"{CANOPY_ORIGIN}/customer-pay?merchant=$PK&intent={ANY_INTENT_ID}\"  | grep -o \"frame-ancestors[^;]*\"\
          \ \n done \n ``` \n Read the pair, not either line alone: \n | Real key | Bogus key | Verdict | \n | ---------------------------------\
          \ | --------- | -------------------------------------------------------------------------------------------------------------------------------------"
  /api/checkout/session:
    post:
      operationId: post_api_checkout_session
      tags:
      - Api
      summary: One endpoint in your app — say POST /api/checkout/session — that creates a Canopy intent for the current user and returns only
        the intentId.
      x-source: https://www.canopypay.io/agents/checkout-inline
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCheckoutSessionResponse'
      x-evidence:
        kind: documentation
  /api/mcp:
    post:
      operationId: post_api_mcp
      tags:
      - Api
      summary: 'Transport is Streamable HTTP : stateless, POST only, JSON responses.'
      x-source: https://www.canopypay.io/agents/mcp
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/intents:
    get:
      operationId: get_api_v1_intents
      tags:
      - Api
      summary: listPaymentIntents List payment intents
      x-source: https://www.canopypay.io/reference
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Maximum number of intents to return
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: Opaque cursor for pagination
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1IntentsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_intents
      tags:
      - Api
      summary: POST /api/v1/intents
      x-source: https://www.canopypay.io/reference
      parameters:
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1IntentsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1IntentsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl TypeScript curl \"https://www.canopypay.io/api/v1/intents?limit=20&cursor=1042\"  -H \"Authorization: Bearer cnpy_REDACTED_STRIPE_KEY_<64\
          \ hex chars>\"  -H \"Canopy-Version: 2026-09-01\" 200 OK json { \n \" object \" : \"list\" , \n \" data \" : [ \n { \n \" intentId \"\
          \ : \"6f1b9c2e4d8a4f1b8c2e4d8a4f1b8c2e\" , \n \" inboxAddress \" : \"0x9f2a1c7b3e5d8a604c1f2b9e7d3a5c8b6e4f1d20\" , \n \" created \"\
          \ : false \n } \n ], \n \" has_mo"
  /api/v1/intents/{id}/source-inbox:
    post:
      operationId: post_api_v1_intents_id_source_inbox
      tags:
      - Api
      summary: createIntentSourceInbox Issue a source deposit inbox for an intent
      x-source: https://www.canopypay.io/reference
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1IntentsIdSourceInboxRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1IntentsIdSourceInboxResponse'
      x-evidence:
        kind: documentation
  /api/v1/intents/{id}/view:
    post:
      operationId: post_api_v1_intents_id_view
      tags:
      - Api
      summary: recordIntentView Report that an intent is on screen
      x-source: https://www.canopypay.io/reference
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1IntentsIdViewRequest'
      responses:
        '202':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1IntentsIdViewResponse'
      x-evidence:
        kind: documentation
  /api/v3/auth/methods:
    get:
      operationId: get_api_v3_auth_methods
      tags:
      - Api
      summary: GET /api/v3/auth/methods
      x-source: https://docs.portalhq.io/resources/authentication/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request GET  --url https://api.portalhq.io/api/v3/auth/methods  --header 'x-portal-auth-environment-id: <AUTH_ENVIRONMENT_ID>'\
          \ \n The Auth Environment ID identifies an environment, it does not authenticate a\ncaller. Treat it as public, the way you would an\
          \ OAuth client ID. This is why\nPortal checks every magic link request against your Redirect URL allow list,\nyour verified sending\
          \ domains, "
  /auth/magic-links:
    post:
      operationId: post_auth_magic_links
      tags:
      - Auth
      summary: POST /auth/magic-links sends an email magic link to a user.
      description: Initiates a sign‑in by sending an email magic link; optional isAccountAbstracted flag controls gas sponsorship for the client.
      x-source: https://docs.portalhq.io/resources/authentication/overview
      parameters:
      - name: x-portal-auth-environment-id
        in: header
        required: true
        schema:
          type: string
        description: Auth Environment ID identifying the environment.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthMagicLinksRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /auth/methods:
    get:
      operationId: get_auth_methods
      tags:
      - Auth
      summary: GET /auth/methods returns the available sign‑in methods and autoCreateWallet flag.
      description: Retrieves the list of enabled authentication methods for the environment and indicates if wallet auto‑creation is enabled.
      x-source: https://docs.portalhq.io/resources/authentication/overview
      parameters:
      - name: x-portal-auth-environment-id
        in: header
        required: true
        schema:
          type: string
        description: Auth Environment ID identifying the environment.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthMethodsResponse'
      x-evidence:
        kind: documentation
  /auth/oauth/urls:
    get:
      operationId: get_auth_oauth_urls
      tags:
      - Auth
      summary: GET /auth/oauth/urls returns the provider authorize URL for Google or Apple OAuth.
      description: Provides the OAuth authorization URL for Google or Apple sign‑in; optional isAccountAbstracted query parameter controls gas
        sponsorship.
      x-source: https://docs.portalhq.io/resources/authentication/overview
      parameters:
      - name: x-portal-auth-environment-id
        in: header
        required: true
        schema:
          type: string
        description: Auth Environment ID identifying the environment.
      - name: isAccountAbstracted
        in: query
        required: false
        schema:
          type: string
        description: Literal "true" or "false" to indicate gas sponsorship for the client.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthOauthUrlsResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiCheckoutSessionResponse:
      type: object
      properties:
        intentId:
          type: string
          description: 32 lowercase hex characters identifying the created intent
    GetApiV1IntentsResponse:
      type: object
      properties:
        object:
          type: string
          description: Always "list"
        data:
          type: array
          description: Array of intent objects
        has_more:
          type: boolean
          description: Whether more results are available
        next_cursor:
          type: string
          description: Cursor for the next page
    PostApiV1IntentsRequest:
      type: object
      properties:
        merchantReference:
          type: string
        metadata:
          type: object
          properties:
            userId:
              type: string
    PostApiV1IntentsResponse:
      type: object
      properties:
        ' object ':
          type: string
        ' data ':
          type: array
          items:
            type: object
            properties:
              ' intentId ':
                type: string
              ' inboxAddress ':
                type: string
              ' created ':
                type: boolean
        ' has_more ':
          type: boolean
        ' next_cursor ':
          type: string
    PostApiV1IntentsIdSourceInboxRequest:
      type: object
      properties:
        chainId:
          type: integer
          description: EVM chain identifier
        namespace:
          type: string
          description: Solana namespace
        reference:
          type: string
          description: Solana reference
        mint:
          type: string
          description: Solana mint address
    PostApiV1IntentsIdSourceInboxResponse:
      type: object
      properties:
        address:
          type: string
        caip10:
          type: string
    PostApiV1IntentsIdViewRequest:
      type: object
      properties:
        selection:
          type: object
          description: Optional token selection hint
    PostApiV1IntentsIdViewResponse:
      type: object
      properties:
        recorded:
          type: boolean
    PostAuthMagicLinksRequest:
      type: object
      properties:
        isAccountAbstracted:
          type: boolean
          description: If true, the created client will use gas sponsorship.
    GetAuthMethodsResponse:
      type: object
      properties:
        autoCreateWallet:
          type: boolean
          description: Indicates whether a wallet is auto‑created for the user.
    GetAuthOauthUrlsResponse:
      type: object
      properties:
        url:
          type: string
          description: The OAuth provider authorize URL to redirect the user to.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Auth