WildApricot Admin API — Finances.Refunds

naftiko: 1.0.0-alpha2
info:
  label: WildApricot Admin API — Finances.Refunds
  description: 'WildApricot Admin API — Finances.Refunds. 5 operations. Lead operation: WildApricot Get List of Refunds by
    Criteria.. Self-contained Naftiko capability covering one Wildapricot business surface.'
  tags:
  - Wildapricot
  - Finances.Refunds
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WILDAPRICOT_API_KEY: WILDAPRICOT_API_KEY
capability:
  consumes:
  - type: http
    namespace: admin-finances-refunds
    baseUri: https://api.wildapricot.org/v2.2
    description: WildApricot Admin API — Finances.Refunds business capability. Self-contained, no shared references.
    resources:
    - name: accounts-accountId-refunds
      path: /accounts/{accountId}/refunds
      operations:
      - name: getrefundslist
        method: GET
        description: WildApricot Get List of Refunds by Criteria.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contactId
          in: query
          type: integer
          description: Identifier of contact to whom the refund was made.
        - name: eventId
          in: query
          type: integer
          description: Identifier of event. When specified API returns collection of refunds settled to invoices associated
            with event registrations for the event.
        - name: idsOnly
          in: query
          type: boolean
          description: When set to true, API returns only collection of identifiers instead of collection of refunds.
        - name: StartDate
          in: query
          type: string
          description: Limits result to refunds created since StartDate.
        - name: EndDate
          in: query
          type: string
          description: Limits result to refunds created before EndDate.
        - name: unsettledOnly
          in: query
          type: boolean
          description: When set to true, API returns only unsettled refunds.
        - name: ids
          in: query
          type: string
          description: You can filter the refunds by specifying a set of refund IDs.
      - name: createrefund
        method: POST
        description: WildApricot Creates a New Refund.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: accounts-accountId-refunds-refundId
      path: /accounts/{accountId}/refunds/{refundId}
      operations:
      - name: getrefunddetails
        method: GET
        description: WildApricot Retrieve Information About Specific Refund
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: refundId
          in: path
          type: integer
          description: Unique refund identifier
          required: true
      - name: updaterefund
        method: PUT
        description: WildApricot Update Existing Refund Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: refundId
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleterefund
        method: DELETE
        description: WildApricot Delete Existing Refund
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: refundId
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.WILDAPRICOT_API_KEY}}'
  exposes:
  - type: rest
    namespace: admin-finances-refunds-rest
    port: 8080
    description: REST adapter for WildApricot Admin API — Finances.Refunds. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/accounts/{accountid}/refunds
      name: accounts-accountid-refunds
      description: REST surface for accounts-accountId-refunds.
      operations:
      - method: GET
        name: getrefundslist
        description: WildApricot Get List of Refunds by Criteria.
        call: admin-finances-refunds.getrefundslist
        with:
          contactId: rest.contactId
          eventId: rest.eventId
          idsOnly: rest.idsOnly
          StartDate: rest.StartDate
          EndDate: rest.EndDate
          unsettledOnly: rest.unsettledOnly
          ids: rest.ids
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrefund
        description: WildApricot Creates a New Refund.
        call: admin-finances-refunds.createrefund
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/accounts/{accountid}/refunds/{refundid}
      name: accounts-accountid-refunds-refundid
      description: REST surface for accounts-accountId-refunds-refundId.
      operations:
      - method: GET
        name: getrefunddetails
        description: WildApricot Retrieve Information About Specific Refund
        call: admin-finances-refunds.getrefunddetails
        with:
          refundId: rest.refundId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterefund
        description: WildApricot Update Existing Refund Information
        call: admin-finances-refunds.updaterefund
        with:
          refundId: rest.refundId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterefund
        description: WildApricot Delete Existing Refund
        call: admin-finances-refunds.deleterefund
        with:
          refundId: rest.refundId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-finances-refunds-mcp
    port: 9090
    transport: http
    description: MCP adapter for WildApricot Admin API — Finances.Refunds. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: wildapricot-get-list-refunds-criteria
      description: WildApricot Get List of Refunds by Criteria.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-finances-refunds.getrefundslist
      with:
        contactId: tools.contactId
        eventId: tools.eventId
        idsOnly: tools.idsOnly
        StartDate: tools.StartDate
        EndDate: tools.EndDate
        unsettledOnly: tools.unsettledOnly
        ids: tools.ids
      outputParameters:
      - type: object
        mapping: $.
    - name: wildapricot-creates-new-refund
      description: WildApricot Creates a New Refund.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: admin-finances-refunds.createrefund
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: wildapricot-retrieve-information-about-specific
      description: WildApricot Retrieve Information About Specific Refund
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-finances-refunds.getrefunddetails
      with:
        refundId: tools.refundId
      outputParameters:
      - type: object
        mapping: $.
    - name: wildapricot-update-existing-refund-information
      description: WildApricot Update Existing Refund Information
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: admin-finances-refunds.updaterefund
      with:
        refundId: tools.refundId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: wildapricot-delete-existing-refund
      description: WildApricot Delete Existing Refund
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: admin-finances-refunds.deleterefund
      with:
        refundId: tools.refundId
      outputParameters:
      - type: object
        mapping: $.