CSG Forte REST API — Transactions

naftiko: 1.0.0-alpha2
info:
  label: CSG Forte REST API — Transactions
  description: 'CSG Forte REST API — Transactions. 4 operations. Lead operation: List transactions for a location. Self-contained
    Naftiko capability covering one Csg business surface.'
  tags:
  - Csg
  - Transactions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CSG_API_KEY: CSG_API_KEY
capability:
  consumes:
  - type: http
    namespace: forte-rest-transactions
    baseUri: https://api.forte.net/v3
    description: CSG Forte REST API — Transactions business capability. Self-contained, no shared references.
    resources:
    - name: organizations-organizationId-locations-locationId-transactions
      path: /organizations/{organizationId}/locations/{locationId}/transactions
      operations:
      - name: listtransactions
        method: GET
        description: List transactions for a location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: Organization identifier (org_XXXXX format)
          required: true
        - name: locationId
          in: path
          type: string
          description: Location identifier (loc_XXXXX format)
          required: true
        - name: start_date
          in: query
          type: string
          description: Filter transactions on or after this date (YYYY-MM-DD)
        - name: end_date
          in: query
          type: string
          description: Filter transactions on or before this date (YYYY-MM-DD)
        - name: action
          in: query
          type: string
          description: Filter by transaction action
        - name: response_code
          in: query
          type: string
          description: Filter by response code (A for approved, D for declined, etc.)
        - name: page_index
          in: query
          type: integer
        - name: page_size
          in: query
          type: integer
      - name: createtransaction
        method: POST
        description: Create a payment transaction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organizationId-locations-locationId-transactions-transactionId
      path: /organizations/{organizationId}/locations/{locationId}/transactions/{transactionId}
      operations:
      - name: gettransaction
        method: GET
        description: Get transaction details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: transactionId
          in: path
          type: string
          required: true
      - name: updatetransaction
        method: PUT
        description: Update a transaction (void or capture)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: transactionId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.CSG_USER}}'
      password: '{{env.CSG_PASS}}'
  exposes:
  - type: rest
    namespace: forte-rest-transactions-rest
    port: 8080
    description: REST adapter for CSG Forte REST API — Transactions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/locations/{locationid}/transactions
      name: organizations-organizationid-locations-locationid-transactions
      description: REST surface for organizations-organizationId-locations-locationId-transactions.
      operations:
      - method: GET
        name: listtransactions
        description: List transactions for a location
        call: forte-rest-transactions.listtransactions
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          start_date: rest.start_date
          end_date: rest.end_date
          action: rest.action
          response_code: rest.response_code
          page_index: rest.page_index
          page_size: rest.page_size
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createtransaction
        description: Create a payment transaction
        call: forte-rest-transactions.createtransaction
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/locations/{locationid}/transactions/{transactionid}
      name: organizations-organizationid-locations-locationid-transactions-transactionid
      description: REST surface for organizations-organizationId-locations-locationId-transactions-transactionId.
      operations:
      - method: GET
        name: gettransaction
        description: Get transaction details
        call: forte-rest-transactions.gettransaction
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          transactionId: rest.transactionId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatetransaction
        description: Update a transaction (void or capture)
        call: forte-rest-transactions.updatetransaction
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          transactionId: rest.transactionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: forte-rest-transactions-mcp
    port: 9090
    transport: http
    description: MCP adapter for CSG Forte REST API — Transactions. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-transactions-location
      description: List transactions for a location
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: forte-rest-transactions.listtransactions
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        start_date: tools.start_date
        end_date: tools.end_date
        action: tools.action
        response_code: tools.response_code
        page_index: tools.page_index
        page_size: tools.page_size
      outputParameters:
      - type: object
        mapping: $.
    - name: create-payment-transaction
      description: Create a payment transaction
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: forte-rest-transactions.createtransaction
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-transaction-details
      description: Get transaction details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: forte-rest-transactions.gettransaction
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        transactionId: tools.transactionId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-transaction-void-capture
      description: Update a transaction (void or capture)
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: forte-rest-transactions.updatetransaction
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        transactionId: tools.transactionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.