StoneX Payments API — Payments

naftiko: 1.0.0-alpha2
info:
  label: StoneX Payments API — Payments
  description: 'StoneX Payments API — Payments. 3 operations. Lead operation: Create Payment. Self-contained Naftiko capability
    covering one Stonex business surface.'
  tags:
  - Stonex
  - Payments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STONEX_API_KEY: STONEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: payments-payments
    baseUri: https://fx-api.payments.stonex.com
    description: StoneX Payments API — Payments business capability. Self-contained, no shared references.
    resources:
    - name: payments
      path: /payments
      operations:
      - name: createpayment
        method: POST
        description: Create Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listpayments
        method: GET
        description: List Payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter payments by status.
        - name: currency
          in: query
          type: string
          description: Filter by payment currency (ISO 4217).
        - name: from_date
          in: query
          type: string
          description: Start of date range filter (ISO 8601).
        - name: to_date
          in: query
          type: string
          description: End of date range filter (ISO 8601).
        - name: page
          in: query
          type: integer
          description: Page number for pagination.
        - name: page_size
          in: query
          type: integer
          description: Number of results per page.
    - name: payments-paymentId
      path: /payments/{paymentId}
      operations:
      - name: getpayment
        method: GET
        description: Get Payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: paymentId
          in: path
          type: string
          description: Unique payment identifier.
          required: true
    authentication:
      type: bearer
      token: '{{env.STONEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: payments-payments-rest
    port: 8080
    description: REST adapter for StoneX Payments API — Payments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/payments
      name: payments
      description: REST surface for payments.
      operations:
      - method: POST
        name: createpayment
        description: Create Payment
        call: payments-payments.createpayment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listpayments
        description: List Payments
        call: payments-payments.listpayments
        with:
          status: rest.status
          currency: rest.currency
          from_date: rest.from_date
          to_date: rest.to_date
          page: rest.page
          page_size: rest.page_size
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payments/{paymentid}
      name: payments-paymentid
      description: REST surface for payments-paymentId.
      operations:
      - method: GET
        name: getpayment
        description: Get Payment
        call: payments-payments.getpayment
        with:
          paymentId: rest.paymentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: payments-payments-mcp
    port: 9090
    transport: http
    description: MCP adapter for StoneX Payments API — Payments. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-payment
      description: Create Payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: payments-payments.createpayment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-payments
      description: List Payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payments-payments.listpayments
      with:
        status: tools.status
        currency: tools.currency
        from_date: tools.from_date
        to_date: tools.to_date
        page: tools.page
        page_size: tools.page_size
      outputParameters:
      - type: object
        mapping: $.
    - name: get-payment
      description: Get Payment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payments-payments.getpayment
      with:
        paymentId: tools.paymentId
      outputParameters:
      - type: object
        mapping: $.