TikTok Shop API — Finance

naftiko: 1.0.0-alpha2
info:
  label: TikTok Shop API — Finance
  description: 'TikTok Shop API — Finance. 1 operations. Lead operation: List Payments. Self-contained Naftiko capability
    covering one Tiktok business surface.'
  tags:
  - Tiktok
  - Finance
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TIKTOK_API_KEY: TIKTOK_API_KEY
capability:
  consumes:
  - type: http
    namespace: shop-finance
    baseUri: https://open-api.tiktokglobalshop.com
    description: TikTok Shop API — Finance business capability. Self-contained, no shared references.
    resources:
    - name: finance-202309-payments
      path: /finance/202309/payments
      operations:
      - name: listpayments
        method: GET
        description: List Payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page_size
          in: query
          type: integer
        - name: page_token
          in: query
          type: string
    authentication:
      type: apikey
      key: x-tts-access-token
      value: '{{env.TIKTOK_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: shop-finance-rest
    port: 8080
    description: REST adapter for TikTok Shop API — Finance. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/finance/202309/payments
      name: finance-202309-payments
      description: REST surface for finance-202309-payments.
      operations:
      - method: GET
        name: listpayments
        description: List Payments
        call: shop-finance.listpayments
        with:
          page_size: rest.page_size
          page_token: rest.page_token
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shop-finance-mcp
    port: 9090
    transport: http
    description: MCP adapter for TikTok Shop API — Finance. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-payments
      description: List Payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shop-finance.listpayments
      with:
        page_size: tools.page_size
        page_token: tools.page_token
      outputParameters:
      - type: object
        mapping: $.