Adyen Configuration API — paymentInstruments

naftiko: 1.0.0-alpha2
info:
  label: Adyen Configuration API — paymentInstruments
  description: 'Adyen Configuration API — paymentInstruments. 6 operations. Lead operation: Adyen Create a Payment Instrument.
    Self-contained Naftiko capability covering one Adyen business surface.'
  tags:
  - Adyen
  - paymentInstruments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ADYEN_API_KEY: ADYEN_API_KEY
capability:
  consumes:
  - type: http
    namespace: configuration-paymentinstruments
    baseUri: https://balanceplatform-api-test.adyen.com/bcl/v2
    description: Adyen Configuration API — paymentInstruments business capability. Self-contained, no shared references.
    resources:
    - name: paymentInstruments
      path: /paymentInstruments
      operations:
      - name: postpaymentinstruments
        method: POST
        description: Adyen Create a Payment Instrument
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: paymentInstruments-id
      path: /paymentInstruments/{id}
      operations:
      - name: getpaymentinstrumentsid
        method: GET
        description: Adyen Get a Payment Instrument
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the payment instrument.
          required: true
      - name: patchpaymentinstrumentsid
        method: PATCH
        description: Adyen Update a Payment Instrument
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the payment instrument.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: paymentInstruments-id-networkTokens
      path: /paymentInstruments/{id}/networkTokens
      operations:
      - name: getpaymentinstrumentsidnetworktokens
        method: GET
        description: Adyen List Network Tokens
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the payment instrument.
          required: true
    - name: paymentInstruments-id-reveal
      path: /paymentInstruments/{id}/reveal
      operations:
      - name: getpaymentinstrumentsidreveal
        method: GET
        description: Adyen Get the PAN of a Payment Instrument
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the payment instrument.
          required: true
    - name: paymentInstruments-id-transactionRules
      path: /paymentInstruments/{id}/transactionRules
      operations:
      - name: getpaymentinstrumentsidtransactionrules
        method: GET
        description: Adyen Get All Transaction Rules for a Payment Instrument
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the payment instrument.
          required: true
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.ADYEN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: configuration-paymentinstruments-rest
    port: 8080
    description: REST adapter for Adyen Configuration API — paymentInstruments. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/paymentinstruments
      name: paymentinstruments
      description: REST surface for paymentInstruments.
      operations:
      - method: POST
        name: postpaymentinstruments
        description: Adyen Create a Payment Instrument
        call: configuration-paymentinstruments.postpaymentinstruments
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paymentinstruments/{id}
      name: paymentinstruments-id
      description: REST surface for paymentInstruments-id.
      operations:
      - method: GET
        name: getpaymentinstrumentsid
        description: Adyen Get a Payment Instrument
        call: configuration-paymentinstruments.getpaymentinstrumentsid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchpaymentinstrumentsid
        description: Adyen Update a Payment Instrument
        call: configuration-paymentinstruments.patchpaymentinstrumentsid
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paymentinstruments/{id}/networktokens
      name: paymentinstruments-id-networktokens
      description: REST surface for paymentInstruments-id-networkTokens.
      operations:
      - method: GET
        name: getpaymentinstrumentsidnetworktokens
        description: Adyen List Network Tokens
        call: configuration-paymentinstruments.getpaymentinstrumentsidnetworktokens
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paymentinstruments/{id}/reveal
      name: paymentinstruments-id-reveal
      description: REST surface for paymentInstruments-id-reveal.
      operations:
      - method: GET
        name: getpaymentinstrumentsidreveal
        description: Adyen Get the PAN of a Payment Instrument
        call: configuration-paymentinstruments.getpaymentinstrumentsidreveal
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paymentinstruments/{id}/transactionrules
      name: paymentinstruments-id-transactionrules
      description: REST surface for paymentInstruments-id-transactionRules.
      operations:
      - method: GET
        name: getpaymentinstrumentsidtransactionrules
        description: Adyen Get All Transaction Rules for a Payment Instrument
        call: configuration-paymentinstruments.getpaymentinstrumentsidtransactionrules
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: configuration-paymentinstruments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Adyen Configuration API — paymentInstruments. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: adyen-create-payment-instrument
      description: Adyen Create a Payment Instrument
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: configuration-paymentinstruments.postpaymentinstruments
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: adyen-get-payment-instrument
      description: Adyen Get a Payment Instrument
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: configuration-paymentinstruments.getpaymentinstrumentsid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: adyen-update-payment-instrument
      description: Adyen Update a Payment Instrument
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: configuration-paymentinstruments.patchpaymentinstrumentsid
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: adyen-list-network-tokens
      description: Adyen List Network Tokens
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: configuration-paymentinstruments.getpaymentinstrumentsidnetworktokens
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: adyen-get-pan-payment-instrument
      description: Adyen Get the PAN of a Payment Instrument
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: configuration-paymentinstruments.getpaymentinstrumentsidreveal
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: adyen-get-all-transaction-rules
      description: Adyen Get All Transaction Rules for a Payment Instrument
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: configuration-paymentinstruments.getpaymentinstrumentsidtransactionrules
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.