VTex Orders API — Payment

naftiko: 1.0.0-alpha2
info:
  label: VTex Orders API — Payment
  description: 'VTex Orders API — Payment. 2 operations. Lead operation: VTex Retrieve payment transaction. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Payment
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: orders-payment
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Orders API — Payment business capability. Self-contained, no shared references.
    resources:
    - name: api-oms-pvt-orders-orderId-payment-transaction
      path: /api/oms/pvt/orders/{orderId}/payment-transaction
      operations:
      - name: getpaymenttransaction
        method: GET
        description: VTex Retrieve payment transaction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
          required: true
        - name: Content-Type
          in: header
          type: string
          description: Type of the content being sent.
          required: true
        - name: orderId
          in: path
          type: string
          description: Order ID is a unique code that identifies an order.
          required: true
    - name: api-oms-pvt-orders-orderId-payments-paymentId-payment-notification
      path: /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification
      operations:
      - name: sendpaymentnotification
        method: POST
        description: VTex Send payment notification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
          required: true
        - name: Content-Type
          in: header
          type: string
          description: Type of the content being sent.
          required: true
        - name: orderId
          in: path
          type: string
          description: Order ID is a unique code that identifies an order.
          required: true
        - name: paymentId
          in: path
          type: string
          description: VTEX payment identifier.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: orders-payment-rest
    port: 8080
    description: REST adapter for VTex Orders API — Payment. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/oms/pvt/orders/{orderid}/payment-transaction
      name: api-oms-pvt-orders-orderid-payment-transaction
      description: REST surface for api-oms-pvt-orders-orderId-payment-transaction.
      operations:
      - method: GET
        name: getpaymenttransaction
        description: VTex Retrieve payment transaction
        call: orders-payment.getpaymenttransaction
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          orderId: rest.orderId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/oms/pvt/orders/{orderid}/payments/{paymentid}/payment-notification
      name: api-oms-pvt-orders-orderid-payments-paymentid-payment-notification
      description: REST surface for api-oms-pvt-orders-orderId-payments-paymentId-payment-notification.
      operations:
      - method: POST
        name: sendpaymentnotification
        description: VTex Send payment notification
        call: orders-payment.sendpaymentnotification
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          orderId: rest.orderId
          paymentId: rest.paymentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-payment-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Orders API — Payment. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: vtex-retrieve-payment-transaction
      description: VTex Retrieve payment transaction
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-payment.getpaymenttransaction
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        orderId: tools.orderId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-send-payment-notification
      description: VTex Send payment notification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-payment.sendpaymentnotification
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        orderId: tools.orderId
        paymentId: tools.paymentId
      outputParameters:
      - type: object
        mapping: $.