Modern Treasury — IncomingPaymentDetail

naftiko: 1.0.0-alpha2
info:
  label: Modern Treasury — IncomingPaymentDetail
  description: 'Modern Treasury — IncomingPaymentDetail. 4 operations. Lead operation: list incoming payment_details. Self-contained
    Naftiko capability covering one Modern Treasury business surface.'
  tags:
  - Modern Treasury
  - IncomingPaymentDetail
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MODERN_TREASURY_API_KEY: MODERN_TREASURY_API_KEY
capability:
  consumes:
  - type: http
    namespace: modern-treasury-incomingpaymentdetail
    baseUri: http://localhost:3000
    description: Modern Treasury — IncomingPaymentDetail business capability. Self-contained, no shared references.
    resources:
    - name: api-incoming_payment_details
      path: /api/incoming_payment_details
      operations:
      - name: listincomingpaymentdetails
        method: GET
        description: list incoming payment_details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: after_cursor
          in: query
          type: string
        - name: per_page
          in: query
          type: integer
        - name: direction
          in: query
          type: string
          description: One of `credit` or `debit`.
        - name: status
          in: query
          type: string
          description: The current status of the incoming payment order. One of `pending`, `completed`, or `returned`.
        - name: type
          in: query
          type: string
          description: 'One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or `wire`.'
        - name: as_of_date_start
          in: query
          type: string
          description: Filters incoming payment details with an as_of_date starting on or after the specified date (YYYY-MM-DD).
        - name: as_of_date_end
          in: query
          type: string
          description: Filters incoming payment details with an as_of_date starting on or before the specified date (YYYY-MM-DD).
        - name: virtual_account_id
          in: query
          type: string
          description: If the incoming payment detail is in a virtual account, the ID of the Virtual Account.
        - name: subtype
          in: query
          type: string
          description: An additional layer of classification for the type of incoming payment detail. For example, a `type`
            of `stablecoin` may have a `subtype` of `ethereum` or `sola
    - name: api-incoming_payment_details-id
      path: /api/incoming_payment_details/{id}
      operations:
      - name: getincomingpaymentdetail
        method: GET
        description: get incoming payment detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateincomingpaymentdetail
        method: PATCH
        description: update incoming payment detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-simulations-incoming_payment_details-create_async
      path: /api/simulations/incoming_payment_details/create_async
      operations:
      - name: createasyncincomingpaymentdetail
        method: POST
        description: create async incoming payment detail
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Idempotency-Key
          in: header
          type: string
          description: This key should be something unique, preferably something like an UUID.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: basic
      username: '{{env.MODERN_TREASURY_USER}}'
      password: '{{env.MODERN_TREASURY_PASS}}'
  exposes:
  - type: rest
    namespace: modern-treasury-incomingpaymentdetail-rest
    port: 8080
    description: REST adapter for Modern Treasury — IncomingPaymentDetail. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/incoming-payment-details
      name: api-incoming-payment-details
      description: REST surface for api-incoming_payment_details.
      operations:
      - method: GET
        name: listincomingpaymentdetails
        description: list incoming payment_details
        call: modern-treasury-incomingpaymentdetail.listincomingpaymentdetails
        with:
          after_cursor: rest.after_cursor
          per_page: rest.per_page
          direction: rest.direction
          status: rest.status
          type: rest.type
          as_of_date_start: rest.as_of_date_start
          as_of_date_end: rest.as_of_date_end
          virtual_account_id: rest.virtual_account_id
          subtype: rest.subtype
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/incoming-payment-details/{id}
      name: api-incoming-payment-details-id
      description: REST surface for api-incoming_payment_details-id.
      operations:
      - method: GET
        name: getincomingpaymentdetail
        description: get incoming payment detail
        call: modern-treasury-incomingpaymentdetail.getincomingpaymentdetail
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateincomingpaymentdetail
        description: update incoming payment detail
        call: modern-treasury-incomingpaymentdetail.updateincomingpaymentdetail
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/simulations/incoming-payment-details/create-async
      name: api-simulations-incoming-payment-details-create-async
      description: REST surface for api-simulations-incoming_payment_details-create_async.
      operations:
      - method: POST
        name: createasyncincomingpaymentdetail
        description: create async incoming payment detail
        call: modern-treasury-incomingpaymentdetail.createasyncincomingpaymentdetail
        with:
          Idempotency-Key: rest.Idempotency-Key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: modern-treasury-incomingpaymentdetail-mcp
    port: 9090
    transport: http
    description: MCP adapter for Modern Treasury — IncomingPaymentDetail. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-incoming-payment-details
      description: list incoming payment_details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: modern-treasury-incomingpaymentdetail.listincomingpaymentdetails
      with:
        after_cursor: tools.after_cursor
        per_page: tools.per_page
        direction: tools.direction
        status: tools.status
        type: tools.type
        as_of_date_start: tools.as_of_date_start
        as_of_date_end: tools.as_of_date_end
        virtual_account_id: tools.virtual_account_id
        subtype: tools.subtype
      outputParameters:
      - type: object
        mapping: $.
    - name: get-incoming-payment-detail
      description: get incoming payment detail
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: modern-treasury-incomingpaymentdetail.getincomingpaymentdetail
      outputParameters:
      - type: object
        mapping: $.
    - name: update-incoming-payment-detail
      description: update incoming payment detail
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: modern-treasury-incomingpaymentdetail.updateincomingpaymentdetail
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-async-incoming-payment-detail
      description: create async incoming payment detail
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: modern-treasury-incomingpaymentdetail.createasyncincomingpaymentdetail
      with:
        Idempotency-Key: tools.Idempotency-Key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.