Lithic Developer API — External Payments

naftiko: 1.0.0-alpha2
info:
  label: Lithic Developer API — External Payments
  description: 'Lithic Developer API — External Payments. 7 operations. Lead operation: List external payments. Self-contained
    Naftiko capability covering one Lithic business surface.'
  tags:
  - Lithic
  - External Payments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LITHIC_API_KEY: LITHIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: lithic-external-payments
    baseUri: https://sandbox.lithic.com
    description: Lithic Developer API — External Payments business capability. Self-contained, no shared references.
    resources:
    - name: v1-external_payments
      path: /v1/external_payments
      operations:
      - name: getexternalpayments
        method: GET
        description: List external payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: category
          in: query
          type: string
          description: External Payment category to be returned.
        - name: financial_account_token
          in: query
          type: string
          description: Globally unique identifier for the financial account or card that will send the funds. Accepted type
            dependent on the program's use case.
        - name: business_account_token
          in: query
          type: string
        - name: result
          in: query
          type: string
          description: External Payment result to be returned.
        - name: status
          in: query
          type: string
          description: Book transfer status to be returned.
      - name: postexternalpayments
        method: POST
        description: Create external payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-external_payments-external_payment_token
      path: /v1/external_payments/{external_payment_token}
      operations:
      - name: getexternalpayment
        method: GET
        description: Get external payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: external_payment_token
          in: path
          type: string
          description: Globally unique identifier for the external payment
          required: true
    - name: v1-external_payments-external_payment_token-cancel
      path: /v1/external_payments/{external_payment_token}/cancel
      operations:
      - name: cancelexternalpayment
        method: POST
        description: Cancel external payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: external_payment_token
          in: path
          type: string
          description: Globally unique identifier for the external payment
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-external_payments-external_payment_token-release
      path: /v1/external_payments/{external_payment_token}/release
      operations:
      - name: releaseexternalpayment
        method: POST
        description: Release external payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: external_payment_token
          in: path
          type: string
          description: Globally unique identifier for the external payment
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-external_payments-external_payment_token-reverse
      path: /v1/external_payments/{external_payment_token}/reverse
      operations:
      - name: reverseexternalpayment
        method: POST
        description: Reverse external payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: external_payment_token
          in: path
          type: string
          description: Globally unique identifier for the external payment
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-external_payments-external_payment_token-settle
      path: /v1/external_payments/{external_payment_token}/settle
      operations:
      - name: settleexternalpayment
        method: POST
        description: Settle external payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: external_payment_token
          in: path
          type: string
          description: Globally unique identifier for the external payment
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LITHIC_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: lithic-external-payments-rest
    port: 8080
    description: REST adapter for Lithic Developer API — External Payments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/external-payments
      name: v1-external-payments
      description: REST surface for v1-external_payments.
      operations:
      - method: GET
        name: getexternalpayments
        description: List external payments
        call: lithic-external-payments.getexternalpayments
        with:
          category: rest.category
          financial_account_token: rest.financial_account_token
          business_account_token: rest.business_account_token
          result: rest.result
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postexternalpayments
        description: Create external payment
        call: lithic-external-payments.postexternalpayments
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/external-payments/{external-payment-token}
      name: v1-external-payments-external-payment-token
      description: REST surface for v1-external_payments-external_payment_token.
      operations:
      - method: GET
        name: getexternalpayment
        description: Get external payment
        call: lithic-external-payments.getexternalpayment
        with:
          external_payment_token: rest.external_payment_token
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/external-payments/{external-payment-token}/cancel
      name: v1-external-payments-external-payment-token-cancel
      description: REST surface for v1-external_payments-external_payment_token-cancel.
      operations:
      - method: POST
        name: cancelexternalpayment
        description: Cancel external payment
        call: lithic-external-payments.cancelexternalpayment
        with:
          external_payment_token: rest.external_payment_token
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/external-payments/{external-payment-token}/release
      name: v1-external-payments-external-payment-token-release
      description: REST surface for v1-external_payments-external_payment_token-release.
      operations:
      - method: POST
        name: releaseexternalpayment
        description: Release external payment
        call: lithic-external-payments.releaseexternalpayment
        with:
          external_payment_token: rest.external_payment_token
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/external-payments/{external-payment-token}/reverse
      name: v1-external-payments-external-payment-token-reverse
      description: REST surface for v1-external_payments-external_payment_token-reverse.
      operations:
      - method: POST
        name: reverseexternalpayment
        description: Reverse external payment
        call: lithic-external-payments.reverseexternalpayment
        with:
          external_payment_token: rest.external_payment_token
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/external-payments/{external-payment-token}/settle
      name: v1-external-payments-external-payment-token-settle
      description: REST surface for v1-external_payments-external_payment_token-settle.
      operations:
      - method: POST
        name: settleexternalpayment
        description: Settle external payment
        call: lithic-external-payments.settleexternalpayment
        with:
          external_payment_token: rest.external_payment_token
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: lithic-external-payments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Lithic Developer API — External Payments. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-external-payments
      description: List external payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: lithic-external-payments.getexternalpayments
      with:
        category: tools.category
        financial_account_token: tools.financial_account_token
        business_account_token: tools.business_account_token
        result: tools.result
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: create-external-payment
      description: Create external payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: lithic-external-payments.postexternalpayments
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-external-payment
      description: Get external payment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: lithic-external-payments.getexternalpayment
      with:
        external_payment_token: tools.external_payment_token
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-external-payment
      description: Cancel external payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: lithic-external-payments.cancelexternalpayment
      with:
        external_payment_token: tools.external_payment_token
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: release-external-payment
      description: Release external payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: lithic-external-payments.releaseexternalpayment
      with:
        external_payment_token: tools.external_payment_token
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: reverse-external-payment
      description: Reverse external payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: lithic-external-payments.reverseexternalpayment
      with:
        external_payment_token: tools.external_payment_token
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: settle-external-payment
      description: Settle external payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: lithic-external-payments.settleexternalpayment
      with:
        external_payment_token: tools.external_payment_token
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.