Collectly

Collectly Payments API

The payments API from Collectly — 3 operation(s) for payments.

GitHub OpenAPI

Operations 3

GET /practices/{practice_id}/payments Get payments information. #
POST /practices/{practice_id}/payments/{payment_id}/refund Refund payment #
GET /practices/{practice_id}/payments/{payments} Get payments information. #

Documentation

📖
Documentation
https://docs.collectly.co/
📖
APIReference
https://docs.collectly.co/reference
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/authentication/collectly-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/openapi/collectly-payments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/json-schema/collectly-patient-checkout-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/json-schema/collectly-appointment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/json-schema/collectly-payment-plan-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/json-schema/collectly-patient-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/json-schema/collectly-payment-method-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/json-schema/collectly-payment-plan-request-schema.json

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/conventions/collectly-conventions.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/asyncapi/collectly-webhooks.yml
🔗
X-MCPServerCandidate
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/mcp/collectly-mcp.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/sandbox/collectly-sandbox.yml
🔗
Components
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/components/collectly-components.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/data-model/collectly-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/lifecycle/collectly-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/conformance/collectly-conformance.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/collectly/refs/heads/main/llms/collectly-llms.txt

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/collectly:collectly-payments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

collectly-payments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '### Pagination

    Requests that return multiple items will be paginated to 100 items by default.

    You can specify further pages with the ?page parameter. For some resources, you can also set a custom

    page size up to 1000 with the ?per_page parameter.


    X-Total-Count – Total number of results

    X-Limit – Number results per page

    X-Page-Last – Number of last page

    X-Page – Current Page Number (starts from 0)'
  title: partners1 Payments API
  version: '1'
servers:
- url: sandbox.collectly.co/api/api/partners/v1
security:
- ApiKey: []
tags:
- name: Payments
paths:
  /practices/{practice_id}/payments:
    get:
      parameters:
      - description: Practice ID in which the requested resource exists
        in: path
        name: practice_id
        required: true
        schema:
          type: string
      - description: Page number of dataset
        in: query
        name: page
        required: false
        schema:
          minimum: 0
          type: integer
      - description: Custom page size of dataset
        in: query
        name: per_page
        required: false
        schema:
          default: 100
          type: integer
      - description: String with a comma-separated list of parameters by which to sort the dataset. To specify a descending order, add a "-" character before the parameter. For example, `?sort=-created_at,id`
        in: query
        name: sort
        required: false
        schema:
          example: ''
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
          description: OK
          headers:
            X-Limit:
              description: Number results per page. Requests that return multiple items will be paginated to 100 items by default. You can specify further pages with the `?page` parameter. For some resources, you can also set a custom page size up to 1000 with the `?per_page` parameter.
              schema:
                type: integer
            X-Page:
              description: Current Page Number (starts from 0)
              schema:
                type: integer
            X-Page-Last:
              description: Number of last page
              schema:
                type: integer
            X-Total-Count:
              description: Total number of results
              schema:
                type: integer
      summary: Get payments information.
      tags:
      - Payments
      operationId: getPracticesByPracticeIdPayments
      x-operation-id-source: derived
  /practices/{practice_id}/payments/{payment_id}/refund:
    post:
      description: 'Refund payment.

        Payment can be refunded both fully and partially.'
      parameters:
      - description: Practice ID in which the requested resource exists
        in: path
        name: practice_id
        required: true
        schema:
          type: string
      - description: Payment ID (Collectly ID)
        in: path
        name: payment_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Payment'
        description: Request Body
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
          description: OK
          headers: {}
      summary: Refund payment
      tags:
      - Payments
      operationId: postPracticesByPracticeIdPaymentsByPaymentIdRefund
      x-operation-id-source: derived
  /practices/{practice_id}/payments/{payments}:
    get:
      parameters:
      - description: Practice ID in which the requested resource exists
        in: path
        name: practice_id
        required: true
        schema:
          type: string
      - description: Resource Identifier
        in: path
        name: payments
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
          description: OK
          headers: {}
      summary: Get payments information.
      tags:
      - Payments
      operationId: getPracticesByPracticeIdPaymentsByPayments
      x-operation-id-source: derived
components:
  schemas:
    Allocation:
      properties:
        amount:
          type: number
        charge_id:
          type:
          - string
          - 'null'
        id:
          readOnly: true
          type: string
        visit_id: {}
      required:
      - amount
      type: object
    Payment:
      properties:
        allocations:
          items:
            $ref: '#/components/schemas/Allocation'
          type: array
        amount:
          type:
          - number
          - 'null'
        collectly_id:
          description: Unique Collectly resource ID
          readOnly: true
          type: string
        collectly_payment_plan_id:
          description: Collectly payment plan ID. It is NOT null in case the payment was charged as a part of the payment plan
          type: string
        collectly_source_payment_id:
          description: Collectly source payment ID. Used only for refunds.
          type: string
        copay_amount:
          type: number
        created_at:
          readOnly: true
        id:
          description: Unique resource ID from your integration
          type: string
        modified_at:
          readOnly: true
        patient_id:
          description: Patient ID from your integration who owns the resource
          type: string
        payment_type:
          enum:
          - payment
          - copay
          - refund
          - part_ref
          - autodeb
          - collect
          type: string
        post_date:
          format: date
          type:
          - string
          - 'null'
        status:
          readOnly: true
          type: string
        transaction_id:
          type:
          - string
          - 'null'
      required:
      - id
      - patient_id
      type: object
  securitySchemes:
    ApiKey:
      in: header
      name: Authorization
      type: apiKey
x-provenance:
  method: searched
  source: https://docs.collectly.co/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.collectly.co/reference/delete_practices-practice-id-insurance-policies-insurance-policies.md
  - https://docs.collectly.co/reference/delete_practices-practice-id-patients-patient-id-checkout-patient-checkout.md
  - https://docs.collectly.co/reference/delete_practices-practice-id-patients-patient-id-payment-methods-payment-methods.md
  - https://docs.collectly.co/reference/delete_practices-practice-id-patients-patient-id-payment-plans-payment-plans.md
  - https://docs.collectly.co/reference/delete_practices-practice-id-patients-patient-id-subscriptions-subscriptions.md
  - https://docs.collectly.co/reference/get_company.md
  - https://docs.collectly.co/reference/get_patient-forms-patient-forms.md
  - https://docs.collectly.co/reference/get_patient-forms.md
  - https://docs.collectly.co/reference/get_practices-info-practices-info.md
  - https://docs.collectly.co/reference/get_practices-info.md
  - https://docs.collectly.co/reference/get_practices-practice-id-appointments-appointments.md
  - https://docs.collectly.co/reference/get_practices-practice-id-appointments.md
  - https://docs.collectly.co/reference/get_practices-practice-id-insurance-companies-insurance-companies.md
  - https://docs.collectly.co/reference/get_practices-practice-id-insurance-companies.md
  - https://docs.collectly.co/reference/get_practices-practice-id-insurance-policies-insurance-policies.md
  - https://docs.collectly.co/reference/get_practices-practice-id-insurance-policies.md
  - https://docs.collectly.co/reference/get_practices-practice-id-locations-locations.md
  - https://docs.collectly.co/reference/get_practices-practice-id-locations.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patient-id-payment-methods-payment-methods.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patient-id-payment-methods.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patient-id-payment-plans-payment-plans.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patient-id-payment-plans.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patient-id-statement-statements.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patient-id-statement.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patient-id-subscriptions-subscriptions.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patient-id-subscriptions.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients-patients.md
  - https://docs.collectly.co/reference/get_practices-practice-id-patients.md
  - https://docs.collectly.co/reference/get_practices-practice-id-payments-payments.md
  - https://docs.collectly.co/reference/get_practices-practice-id-payments.md
  - https://docs.collectly.co/reference/get_practices-practice-id-providers-providers.md
  - https://docs.collectly.co/reference/get_practices-practice-id-providers.md
  - https://docs.collectly.co/reference/get_practices-practice-id-unmapped-patients-unmapped-patients.md
  - https://docs.collectly.co/reference/get_practices-practice-id-unmapped-patients.md
  - https://docs.collectly.co/reference/get_practices-practices.md
  - https://docs.collectly.co/reference/get_practices.md
  - https://docs.collectly.co/reference/get_users-users.md
  - https://docs.collectly.co/reference/get_users.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-appointments-appointments.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-insurance-companies-insurance-companies.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-insurance-policies-insurance-policies.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-locations-locations.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-patients-patient-id-payment-plans-payment-plans.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-patients-patient-id-subscriptions-subscriptions.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-patients-patients.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-providers-providers.md
  - https://docs.collectly.co/reference/patch_practices-practice-id-unmapped-patients-unmapped-patients.md
  - https://docs.collectly.co/reference/patch_practices-practices.md
  - https://docs.collectly.co/reference/patch_users-users.md
  - https://docs.collectly.co/reference/post_login.md
  - https://docs.collectly.co/reference/post_patient-forms-patient-forms-sign.md
  - https://docs.collectly.co/reference/post_patient-forms.md
  - https://docs.collectly.co/reference/post_patient-lookup.md
  - https://docs.collectly.co/reference/post_practices-practice-id-appointments.md
  - https://docs.collectly.co/reference/post_practices-practice-id-insurance-companies.md
  - https://docs.collectly.co/reference/post_practices-practice-id-insurance-policies.md
  - https://docs.collectly.co/reference/post_practices-practice-id-locations.md
  - https://docs.collectly.co/reference/post_practices-practice-id-patients-patient-id-payment-methods-payment-methods-charge.md
  - https://docs.collectly.co/reference/post_practices-practice-id-patients-patient-id-payment-methods.md
  - https://docs.collectly.co/reference/post_practices-practice-id-patients-patient-id-payment-plans-request.md
  - https://docs.collectly.co/reference/post_practices-practice-id-patients-patient-id-payment-plans.md
  - https://docs.collectly.co/reference/post_practices-practice-id-patients-patient-id-statement.md
  - https://docs.collectly.co/reference/post_practices-practice-id-patients-patient-id-subscriptions.md
  - https://docs.collectly.co/reference/post_practices-practice-id-patients.md
  - https://docs.collectly.co/reference/post_practices-practice-id-payments-payment-id-refund.md
  - https://docs.collectly.co/reference/post_practices-practice-id-providers.md
  - https://docs.collectly.co/reference/post_practices-practice-id-store-payment-method.md
  - https://docs.collectly.co/reference/post_practices-practice-id-unmapped-patients.md
  - https://docs.collectly.co/reference/post_practices-practices-post-apply-payment.md
  - https://docs.collectly.co/reference/post_practices.md
  - https://docs.collectly.co/reference/post_users.md
  merge:
    pages: 71
    deduped: 186
    conflicts_kept_first: 0