DocuSign REST API — Payments

naftiko: 1.0.0-alpha2
info:
  label: DocuSign REST API — Payments
  description: 'DocuSign REST API — Payments. 3 operations. Lead operation: Docusign Gets payment information for one or more
    payments.. Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - Payments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: docusign-payments
    baseUri: https://www.docusign.net/restapi
    description: DocuSign REST API — Payments business capability. Self-contained, no shared references.
    resources:
    - name: v2-accounts-accountId-billing_payments
      path: /v2/accounts/{accountId}/billing_payments
      operations:
      - name: billingpaymentsgetpaymentlist
        method: GET
        description: Docusign Gets payment information for one or more payments.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: from_date
          in: query
          type: string
          description: Specifies the date/time of the earliest payment in the account to retrieve.
        - name: to_date
          in: query
          type: string
          description: Specifies the date/time of the latest payment in the account to retrieve.
      - name: billingpaymentspostpayment
        method: POST
        description: Docusign Posts a payment to a past due invoice.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-accounts-accountId-billing_payments-paymentId
      path: /v2/accounts/{accountId}/billing_payments/{paymentId}
      operations:
      - name: billingpaymentsgetpayment
        method: GET
        description: Docusign Gets billing payment information for a specific payment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: paymentId
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: docusign-payments-rest
    port: 8080
    description: REST adapter for DocuSign REST API — Payments. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v2/accounts/{accountid}/billing-payments
      name: v2-accounts-accountid-billing-payments
      description: REST surface for v2-accounts-accountId-billing_payments.
      operations:
      - method: GET
        name: billingpaymentsgetpaymentlist
        description: Docusign Gets payment information for one or more payments.
        call: docusign-payments.billingpaymentsgetpaymentlist
        with:
          accountId: rest.accountId
          from_date: rest.from_date
          to_date: rest.to_date
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: billingpaymentspostpayment
        description: Docusign Posts a payment to a past due invoice.
        call: docusign-payments.billingpaymentspostpayment
        with:
          accountId: rest.accountId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/accounts/{accountid}/billing-payments/{paymentid}
      name: v2-accounts-accountid-billing-payments-paymentid
      description: REST surface for v2-accounts-accountId-billing_payments-paymentId.
      operations:
      - method: GET
        name: billingpaymentsgetpayment
        description: Docusign Gets billing payment information for a specific payment.
        call: docusign-payments.billingpaymentsgetpayment
        with:
          accountId: rest.accountId
          paymentId: rest.paymentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: docusign-payments-mcp
    port: 9090
    transport: http
    description: MCP adapter for DocuSign REST API — Payments. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: docusign-gets-payment-information-one
      description: Docusign Gets payment information for one or more payments.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-payments.billingpaymentsgetpaymentlist
      with:
        accountId: tools.accountId
        from_date: tools.from_date
        to_date: tools.to_date
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-posts-payment-past-due
      description: Docusign Posts a payment to a past due invoice.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: docusign-payments.billingpaymentspostpayment
      with:
        accountId: tools.accountId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-gets-billing-payment-information
      description: Docusign Gets billing payment information for a specific payment.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-payments.billingpaymentsgetpayment
      with:
        accountId: tools.accountId
        paymentId: tools.paymentId
      outputParameters:
      - type: object
        mapping: $.