/
CL
clinicos
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
ApiKeys
7
AppointmentConfirmation
2
Appointments
25
AppointmentTypes
10
AutomatedEmailTemplates
4
BillableItems
5
Breeds
5
BulkClientExport
2
BulkPatientExport
2
CareQueue
2
CaseMilestones
6
Cases
5
ChatExport
1
ClientAccount
1
ClientCredit
2
ClientExport
3
Clients
6
ClientStatement
1
ClinicalAddenda
2
ClinicConfig
41
ClinicSettings
2
Clocking
6
Compliance
1
ConsentDocuments
2
DeaBooks
10
DeaExport
2
DentalCharts
9
DeviceFormHandoffs
4
DevicePush
3
Devices
5
DeviceSelf
1
DiagnosisTerms
1
DischargeSignOff
2
Disclaimers
7
DiscountCodes
7
Drafts
7
EdgePrinters
3
EdgePrintJobs
2
EmailVerification
2
EmergencyIntake
2
Erx
6
Estimates
30
ExamTemplates
6
Expenses
6
Featurebase
2
FeatureFlags
1
Flowboard
10
FormHandoffs
6
GroupCodes
7
GroupVisits
6
Health
1
HomeAgain
4
HospitalStays
18
IntegrationCredentials
18
InternalPrescribing
1
InternalWidget
1
Inventory
25
InventoryApprovals
5
InventoryLocations
7
Invoices
29
JourneyMilestones
6
Kiosk
4
LabPanels
5
Labs
21
LineItemNotes
5
LocationClosures
4
Locations
11
Logos
7
MedicationRequests
7
MentorMetrics
5
MessageAttachments
4
Metrics
31
NpsAnalytics
3
NvsIntegration
11
OnlineBookingReadiness
1
Partners
6
PatientGroups
9
PatientMasses
6
PatientProblems
4
PatientRecordExport
3
Patients
21
Payments
22
get
/Payments
Get a paginated list of payments with optional filters
get
/Payments/{id}
Get a specific payment by ID
get
/Payments/estimate/{invoiceId}
Get payment summary for an estimate
post
/Payments/cash
post
/Payments/mark-as-paid
post
/Payments/store-credit
post
/Payments/deposit
get
/Payments/deposits/attention
post
/Payments/{id}/deposit-review
post
/Payments/check
post
/Payments/ach
post
/Payments/card-on-file
post
/Payments/text2pay
post
/Payments/terminal
post
/Payments/terminal/auth-only
Add a card on file by reading the card at the terminal and tokenizing it. Uses the gateway's token-only endpoint: the card is never authorized or charged, so — unlike a real auth — there is no hold to release afterwards and nothing to void.
post
/Payments/{id}/refund
post
/Payments/{id}/reverse
Reverse a payment - tries void first (for unsettled transactions), falls back to refund. This is the recommended endpoint for canceling payments as it automatically picks the right method.
get
/Payments/reconciliation/summary
Get reconciliation summary for a specific date
get
/Payments/reconciliation/summary/range
Get reconciliation summaries for a date range (max 365 days)
post
/Payments/reconciliation/close
post
/Payments/batch/close
Close the current open batch in XplorPay, settling all unsettled transactions. This initiates the batch-out process with the payment processor.
post
/Payments/refund/blind
Process a blind (standalone) terminal refund. This refund is not tied to a previous transaction - customer presents card at terminal. Used when the original transaction was processed elsewhere or cannot be found.
PaymentTokens
5
Pep
5
Pharmacies
5
Phones
2
PriceRules
6
Printers
7
PrintJobs
4
PtoRequests
6
PublicDevicePairing
1
PublicEmailUnsubscribe
2
PublicFileLinks
2
PublicFormHandoffs
1
PublicNps
2
PublicPriceList
5
PublicQuestionnaires
4
PublicSmsConsent
2
PurchaseOrders
11
QiEvents
9
QuestionnaireResponses
7
Questionnaires
18
RabiesTags
10
RdvmPortal
22
Recordings
9
RecurringExpenses
5
ReferralMessages
2
Referrals
20
Reminders
14
Reports
2
RetailItems
11
Roles
6
RoomDayAssignments
3
RxGovernance
26
SavedReports
5
ScheduleItems
10
ServiceCatalog
5
Shifts
5
ShiftSwaps
8
SlotConfigurations
6
SmsConsent
9
Species
5
StaffAvailability
1
Subscriptions
10
SurgicalRecords
11
TagAssignments
4
Tags
5
TelnyxCallControl
1
Templates
16
TenantKnowledge
5
TimeEntries
5
Transparency
3
Users
14
Vaccinations
12
VaccineAdministration
3
VaccineCertificateRecords
6
VaccineCertificates
2
VaccineTypes
5
Vendors
6
Vitals
2
VitalTypes
6
Widget
18
WidgetChatbot
4
WorkItemRules
5
WorkTasks
13
Payments
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to POST /Payments/deposit
post
/Payments/deposit
Sep 17, 2026
d4ae30be0619
Revision changes
info
endpoint added