Stripe Topups API — Topups

naftiko: 1.0.0-alpha2
info:
  label: Stripe Topups API — Topups
  description: 'Stripe Topups API — Topups. 5 operations. Lead operation: Topups. Self-contained Naftiko capability covering
    one Stripe business surface.'
  tags:
  - Stripe
  - Topups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STRIPE_API_KEY: STRIPE_API_KEY
capability:
  consumes:
  - type: http
    namespace: topups-topups
    baseUri: https://api.stripe.com
    description: Stripe Topups API — Topups business capability. Self-contained, no shared references.
    resources:
    - name: v1-topups
      path: /v1/topups
      operations:
      - name: gettopups
        method: GET
        description: <p>Returns a list of top-ups.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: amount
          in: query
          type: string
          description: A positive integer representing how much to transfer.
        - name: created
          in: query
          type: string
          description: 'A filter on the list, based on the object `created` field. The value can be a string with an integer
            Unix timestamp, or it can be a dictionary with a number of '
        - name: ending_before
          in: query
          type: string
          description: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 ob
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default
            is 10.
        - name: starting_after
          in: query
          type: string
          description: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list.
            For instance, if you make a list request and receive 100 o
        - name: status
          in: query
          type: string
          description: Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: posttopups
        method: POST
        description: <p>Top up the balance of an account</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-topups-topup
      path: /v1/topups/{topup}
      operations:
      - name: gettopupstopup
        method: GET
        description: <p>Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that
          was returned from your previous request, and Stripe will return the corresponding top-up information.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: expand
          in: query
          type: array
          description: Specifies which fields in the response should be expanded.
        - name: topup
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: posttopupstopup
        method: POST
        description: <p>Updates the metadata of a top-up. Other top-up details are not editable by design.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topup
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-topups-topup-cancel
      path: /v1/topups/{topup}/cancel
      operations:
      - name: posttopupstopupcancel
        method: POST
        description: <p>Cancels a top-up. Only pending top-ups can be canceled.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topup
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.STRIPE_API_KEY}}'
  exposes:
  - type: rest
    namespace: topups-topups-rest
    port: 8080
    description: REST adapter for Stripe Topups API — Topups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/topups
      name: v1-topups
      description: REST surface for v1-topups.
      operations:
      - method: GET
        name: gettopups
        description: <p>Returns a list of top-ups.</p>
        call: topups-topups.gettopups
        with:
          amount: rest.amount
          created: rest.created
          ending_before: rest.ending_before
          expand: rest.expand
          limit: rest.limit
          starting_after: rest.starting_after
          status: rest.status
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: posttopups
        description: <p>Top up the balance of an account</p>
        call: topups-topups.posttopups
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/topups/{topup}
      name: v1-topups-topup
      description: REST surface for v1-topups-topup.
      operations:
      - method: GET
        name: gettopupstopup
        description: <p>Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that
          was returned from your previous request, and Stripe will return the corresponding top-up information.</p>
        call: topups-topups.gettopupstopup
        with:
          expand: rest.expand
          topup: rest.topup
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: posttopupstopup
        description: <p>Updates the metadata of a top-up. Other top-up details are not editable by design.</p>
        call: topups-topups.posttopupstopup
        with:
          topup: rest.topup
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/topups/{topup}/cancel
      name: v1-topups-topup-cancel
      description: REST surface for v1-topups-topup-cancel.
      operations:
      - method: POST
        name: posttopupstopupcancel
        description: <p>Cancels a top-up. Only pending top-ups can be canceled.</p>
        call: topups-topups.posttopupstopupcancel
        with:
          topup: rest.topup
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: topups-topups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Stripe Topups API — Topups. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: p-returns-list-top-ups-p
      description: <p>Returns a list of top-ups.</p>
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: topups-topups.gettopups
      with:
        amount: tools.amount
        created: tools.created
        ending_before: tools.ending_before
        expand: tools.expand
        limit: tools.limit
        starting_after: tools.starting_after
        status: tools.status
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: p-top-up-balance-account-p
      description: <p>Top up the balance of an account</p>
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: topups-topups.posttopups
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: p-retrieves-details-top-up-that
      description: <p>Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that
        was returned from your previous request, and Stripe will return the corresponding top-up information.</p>
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: topups-topups.gettopupstopup
      with:
        expand: tools.expand
        topup: tools.topup
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: p-updates-metadata-top-up-other
      description: <p>Updates the metadata of a top-up. Other top-up details are not editable by design.</p>
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: topups-topups.posttopupstopup
      with:
        topup: tools.topup
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: p-cancels-top-up-only-pending
      description: <p>Cancels a top-up. Only pending top-ups can be canceled.</p>
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: topups-topups.posttopupstopupcancel
      with:
        topup: tools.topup
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.