VTex Payment Provider Protocol API — Configuration Flow

naftiko: 1.0.0-alpha2
info:
  label: VTex Payment Provider Protocol API — Configuration Flow
  description: 'VTex Payment Provider Protocol API — Configuration Flow. 3 operations. Lead operation: VTex Get credentials.
    Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Configuration Flow
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: payment-provider-protocol-configuration-flow
    baseUri: https://{providerApiEndpoint}
    description: VTex Payment Provider Protocol API — Configuration Flow business capability. Self-contained, no shared references.
    resources:
    - name: authorization-credentials
      path: /authorization/credentials
      operations:
      - name: getcredentials
        method: GET
        description: VTex Get credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: authorizationCode
          in: query
          type: string
          description: Code generate by affiliation that will be used to identify the merchant authorization.
          required: true
    - name: authorization-redirect
      path: /authorization/redirect
      operations:
      - name: providerauthentication
        method: GET
        description: VTex Provider authentication
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: token
          in: query
          type: string
          description: You must generate a token that will be used to identify the same context when we redirect the merchant
            to your application.
          required: true
    - name: authorization-token
      path: /authorization/token
      operations:
      - name: createauthorizationtoken
        method: POST
        description: VTex Create authorization token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: payment-provider-protocol-configuration-flow-rest
    port: 8080
    description: REST adapter for VTex Payment Provider Protocol API — Configuration Flow. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/authorization/credentials
      name: authorization-credentials
      description: REST surface for authorization-credentials.
      operations:
      - method: GET
        name: getcredentials
        description: VTex Get credentials
        call: payment-provider-protocol-configuration-flow.getcredentials
        with:
          authorizationCode: rest.authorizationCode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/authorization/redirect
      name: authorization-redirect
      description: REST surface for authorization-redirect.
      operations:
      - method: GET
        name: providerauthentication
        description: VTex Provider authentication
        call: payment-provider-protocol-configuration-flow.providerauthentication
        with:
          token: rest.token
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/authorization/token
      name: authorization-token
      description: REST surface for authorization-token.
      operations:
      - method: POST
        name: createauthorizationtoken
        description: VTex Create authorization token
        call: payment-provider-protocol-configuration-flow.createauthorizationtoken
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: payment-provider-protocol-configuration-flow-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Payment Provider Protocol API — Configuration Flow. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: vtex-get-credentials
      description: VTex Get credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payment-provider-protocol-configuration-flow.getcredentials
      with:
        authorizationCode: tools.authorizationCode
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-provider-authentication
      description: VTex Provider authentication
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payment-provider-protocol-configuration-flow.providerauthentication
      with:
        token: tools.token
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-authorization-token
      description: VTex Create authorization token
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: payment-provider-protocol-configuration-flow.createauthorizationtoken
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.