Shopify API — Sessions

naftiko: 1.0.0-alpha2
info:
  label: Shopify  API — Sessions
  description: 'Shopify  API — Sessions. 6 operations. Lead operation: Shopify Creates A Payment On A Checkout Using The Session
    Id Returned By The Card Vault. Self-contained Naftiko capability covering one Shopify business surface.'
  tags:
  - Shopify
  - Sessions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_API_KEY: SHOPIFY_API_KEY
capability:
  consumes:
  - type: http
    namespace: shopify-sessions
    baseUri: ''
    description: Shopify  API — Sessions business capability. Self-contained, no shared references.
    resources:
    - name: admin-api-2020-01-checkouts-token-payments.json
      path: /admin/api/2020-01/checkouts/{token}/payments.json
      operations:
      - name: deprecated202001createcheckoutsparamtokenpayments
        method: POST
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: token
          in: path
          type: string
          description: token
          required: true
        - name: "amount\n                  required"
          in: query
          type: string
          description: The amount of the payment.
        - name: "request_details\n                  required"
          in: query
          type: string
          description: 'The details of the request, including the following attributes:'
        - name: "session_id\n                  required"
          in: query
          type: string
          description: A session ID provided by the card vault when creating a payment session.
        - name: "unique_token\n                  required"
          in: query
          type: string
          description: A unique idempotency token generated by your app. This can be any value, but must be unique across
            all payment requests.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-04-checkouts-token-payments.json
      path: /admin/api/2020-04/checkouts/{token}/payments.json
      operations:
      - name: deprecated202004createcheckoutsparamtokenpayments
        method: POST
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: token
          in: path
          type: string
          description: token
          required: true
        - name: "amount\n                  required"
          in: query
          type: string
          description: The amount of the payment.
        - name: "request_details\n                  required"
          in: query
          type: string
          description: 'The details of the request, including the following attributes:'
        - name: "session_id\n                  required"
          in: query
          type: string
          description: A session ID provided by the card vault when creating a payment session.
        - name: "unique_token\n                  required"
          in: query
          type: string
          description: A unique idempotency token generated by your app. This can be any value, but must be unique across
            all payment requests.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-07-checkouts-token-payments.json
      path: /admin/api/2020-07/checkouts/{token}/payments.json
      operations:
      - name: deprecated202007createcheckoutsparamtokenpayments
        method: POST
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: token
          in: path
          type: string
          description: token
          required: true
        - name: "amount\n                  required"
          in: query
          type: string
          description: The amount of the payment.
        - name: "request_details\n                  required"
          in: query
          type: string
          description: 'The details of the request, including the following attributes:'
        - name: "session_id\n                  required"
          in: query
          type: string
          description: A session ID provided by the card vault when creating a payment session.
        - name: "unique_token\n                  required"
          in: query
          type: string
          description: A unique idempotency token generated by your app. This can be any value, but must be unique across
            all payment requests.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2020-10-checkouts-token-payments.json
      path: /admin/api/2020-10/checkouts/{token}/payments.json
      operations:
      - name: createcheckoutsparamtokenpayments
        method: POST
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: token
          in: path
          type: string
          description: token
          required: true
        - name: "amount\n                  required"
          in: query
          type: string
          description: The amount of the payment.
        - name: "request_details\n                  required"
          in: query
          type: string
          description: 'The details of the request, including the following attributes:'
        - name: "session_id\n                  required"
          in: query
          type: string
          description: A session ID provided by the card vault when creating a payment session.
        - name: "unique_token\n                  required"
          in: query
          type: string
          description: A unique idempotency token generated by your app. This can be any value, but must be unique across
            all payment requests.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-2021-01-checkouts-token-payments.json
      path: /admin/api/2021-01/checkouts/{token}/payments.json
      operations:
      - name: deprecated202101createcheckoutsparamtokenpayments
        method: POST
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: token
          in: path
          type: string
          description: token
          required: true
        - name: "amount\n                  required"
          in: query
          type: string
          description: The amount of the payment.
        - name: "request_details\n                  required"
          in: query
          type: string
          description: 'The details of the request, including the following attributes:'
        - name: "session_id\n                  required"
          in: query
          type: string
          description: A session ID provided by the card vault when creating a payment session.
        - name: "unique_token\n                  required"
          in: query
          type: string
          description: A unique idempotency token generated by your app. This can be any value, but must be unique across
            all payment requests.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: admin-api-unstable-checkouts-token-payments.json
      path: /admin/api/unstable/checkouts/{token}/payments.json
      operations:
      - name: deprecatedunstablecreatecheckoutsparamtokenpayments
        method: POST
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: token
          in: path
          type: string
          description: token
          required: true
        - name: "amount\n                  required"
          in: query
          type: string
          description: The amount of the payment.
        - name: "request_details\n                  required"
          in: query
          type: string
          description: 'The details of the request, including the following attributes:'
        - name: "session_id\n                  required"
          in: query
          type: string
          description: A session ID provided by the card vault when creating a payment session.
        - name: "unique_token\n                  required"
          in: query
          type: string
          description: A unique idempotency token generated by your app. This can be any value, but must be unique across
            all payment requests.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: shopify-sessions-rest
    port: 8080
    description: REST adapter for Shopify  API — Sessions. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/admin/api/2020-01/checkouts/{token}/payments-json
      name: admin-api-2020-01-checkouts-token-payments-json
      description: REST surface for admin-api-2020-01-checkouts-token-payments.json.
      operations:
      - method: POST
        name: deprecated202001createcheckoutsparamtokenpayments
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        call: shopify-sessions.deprecated202001createcheckoutsparamtokenpayments
        with:
          token: rest.token
          ? "amount\n                  required"
          : "rest.amount\n                  required"
          ? "request_details\n                  required"
          : "rest.request_details\n                  required"
          ? "session_id\n                  required"
          : "rest.session_id\n                  required"
          ? "unique_token\n                  required"
          : "rest.unique_token\n                  required"
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-04/checkouts/{token}/payments-json
      name: admin-api-2020-04-checkouts-token-payments-json
      description: REST surface for admin-api-2020-04-checkouts-token-payments.json.
      operations:
      - method: POST
        name: deprecated202004createcheckoutsparamtokenpayments
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        call: shopify-sessions.deprecated202004createcheckoutsparamtokenpayments
        with:
          token: rest.token
          ? "amount\n                  required"
          : "rest.amount\n                  required"
          ? "request_details\n                  required"
          : "rest.request_details\n                  required"
          ? "session_id\n                  required"
          : "rest.session_id\n                  required"
          ? "unique_token\n                  required"
          : "rest.unique_token\n                  required"
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-07/checkouts/{token}/payments-json
      name: admin-api-2020-07-checkouts-token-payments-json
      description: REST surface for admin-api-2020-07-checkouts-token-payments.json.
      operations:
      - method: POST
        name: deprecated202007createcheckoutsparamtokenpayments
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        call: shopify-sessions.deprecated202007createcheckoutsparamtokenpayments
        with:
          token: rest.token
          ? "amount\n                  required"
          : "rest.amount\n                  required"
          ? "request_details\n                  required"
          : "rest.request_details\n                  required"
          ? "session_id\n                  required"
          : "rest.session_id\n                  required"
          ? "unique_token\n                  required"
          : "rest.unique_token\n                  required"
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2020-10/checkouts/{token}/payments-json
      name: admin-api-2020-10-checkouts-token-payments-json
      description: REST surface for admin-api-2020-10-checkouts-token-payments.json.
      operations:
      - method: POST
        name: createcheckoutsparamtokenpayments
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        call: shopify-sessions.createcheckoutsparamtokenpayments
        with:
          token: rest.token
          ? "amount\n                  required"
          : "rest.amount\n                  required"
          ? "request_details\n                  required"
          : "rest.request_details\n                  required"
          ? "session_id\n                  required"
          : "rest.session_id\n                  required"
          ? "unique_token\n                  required"
          : "rest.unique_token\n                  required"
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/2021-01/checkouts/{token}/payments-json
      name: admin-api-2021-01-checkouts-token-payments-json
      description: REST surface for admin-api-2021-01-checkouts-token-payments.json.
      operations:
      - method: POST
        name: deprecated202101createcheckoutsparamtokenpayments
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        call: shopify-sessions.deprecated202101createcheckoutsparamtokenpayments
        with:
          token: rest.token
          ? "amount\n                  required"
          : "rest.amount\n                  required"
          ? "request_details\n                  required"
          : "rest.request_details\n                  required"
          ? "session_id\n                  required"
          : "rest.session_id\n                  required"
          ? "unique_token\n                  required"
          : "rest.unique_token\n                  required"
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/api/unstable/checkouts/{token}/payments-json
      name: admin-api-unstable-checkouts-token-payments-json
      description: REST surface for admin-api-unstable-checkouts-token-payments.json.
      operations:
      - method: POST
        name: deprecatedunstablecreatecheckoutsparamtokenpayments
        description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
        call: shopify-sessions.deprecatedunstablecreatecheckoutsparamtokenpayments
        with:
          token: rest.token
          ? "amount\n                  required"
          : "rest.amount\n                  required"
          ? "request_details\n                  required"
          : "rest.request_details\n                  required"
          ? "session_id\n                  required"
          : "rest.session_id\n                  required"
          ? "unique_token\n                  required"
          : "rest.unique_token\n                  required"
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shopify-sessions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify  API — Sessions. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: shopify-creates-payment-checkout-using
      description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shopify-sessions.deprecated202001createcheckoutsparamtokenpayments
      with:
        token: tools.token
        ? "amount\n                  required"
        : "tools.amount\n                  required"
        ? "request_details\n                  required"
        : "tools.request_details\n                  required"
        ? "session_id\n                  required"
        : "tools.session_id\n                  required"
        ? "unique_token\n                  required"
        : "tools.unique_token\n                  required"
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-creates-payment-checkout-using-2
      description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shopify-sessions.deprecated202004createcheckoutsparamtokenpayments
      with:
        token: tools.token
        ? "amount\n                  required"
        : "tools.amount\n                  required"
        ? "request_details\n                  required"
        : "tools.request_details\n                  required"
        ? "session_id\n                  required"
        : "tools.session_id\n                  required"
        ? "unique_token\n                  required"
        : "tools.unique_token\n                  required"
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-creates-payment-checkout-using-3
      description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shopify-sessions.deprecated202007createcheckoutsparamtokenpayments
      with:
        token: tools.token
        ? "amount\n                  required"
        : "tools.amount\n                  required"
        ? "request_details\n                  required"
        : "tools.request_details\n                  required"
        ? "session_id\n                  required"
        : "tools.session_id\n                  required"
        ? "unique_token\n                  required"
        : "tools.unique_token\n                  required"
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-creates-payment-checkout-using-4
      description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shopify-sessions.createcheckoutsparamtokenpayments
      with:
        token: tools.token
        ? "amount\n                  required"
        : "tools.amount\n                  required"
        ? "request_details\n                  required"
        : "tools.request_details\n                  required"
        ? "session_id\n                  required"
        : "tools.session_id\n                  required"
        ? "unique_token\n                  required"
        : "tools.unique_token\n                  required"
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-creates-payment-checkout-using-5
      description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shopify-sessions.deprecated202101createcheckoutsparamtokenpayments
      with:
        token: tools.token
        ? "amount\n                  required"
        : "tools.amount\n                  required"
        ? "request_details\n                  required"
        : "tools.request_details\n                  required"
        ? "session_id\n                  required"
        : "tools.session_id\n                  required"
        ? "unique_token\n                  required"
        : "tools.unique_token\n                  required"
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: shopify-creates-payment-checkout-using-6
      description: Shopify Creates A Payment On A Checkout Using The Session Id Returned By The Card Vault
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shopify-sessions.deprecatedunstablecreatecheckoutsparamtokenpayments
      with:
        token: tools.token
        ? "amount\n                  required"
        : "tools.amount\n                  required"
        ? "request_details\n                  required"
        : "tools.request_details\n                  required"
        ? "session_id\n                  required"
        : "tools.session_id\n                  required"
        ? "unique_token\n                  required"
        : "tools.unique_token\n                  required"
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.