/
CL
clinicos
/
PawthosX.Business.API | v1
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 8h ago · Updated 4d ago
Details
View markdown
AdminS3
2
ApiKeys
7
Appointments
21
AppointmentTypes
10
BillableItems
5
Breeds
5
BulkClientExport
2
BulkPatientExport
2
CareQueue
2
CaseMilestones
6
Cases
5
ChatExport
1
ClientAppInvite
3
ClientExport
3
Clients
5
ClinicConfig
29
ClinicSettings
2
Clocking
6
Compliance
1
ConsentDocuments
2
DeaBooks
9
DeaExport
2
DiagnosisTerms
1
DiscountCodes
7
Drafts
7
EdgePrinters
3
EdgePrintJobs
2
EmailVerification
2
Estimates
25
ExamTemplates
5
Expenses
6
Featurebase
2
FeatureFlags
1
Flowboard
10
GroupCodes
5
GroupVisits
6
Health
1
HomeAgain
4
IntegrationCredentials
15
InternalPrescribing
1
InternalWidget
1
Inventory
23
InventoryApprovals
5
InventoryLocations
7
Invoices
24
JourneyMilestones
6
Kiosk
4
LabPanels
5
Labs
16
LocationClosures
4
Locations
11
Logos
7
MedicationRequests
7
MentorMetrics
5
Metrics
31
NpsAnalytics
3
Partners
6
PatientGroups
9
PatientMasses
6
PatientProblems
4
PatientRecordExport
3
Patients
20
Payments
18
get
Get a paginated list of payments with optional filters
get
Get a specific payment by ID
get
Get payment summary for an estimate
post
/Payments/cash
post
/Payments/mark-as-paid
post
/Payments/check
post
/Payments/ach
post
/Payments/card-on-file
post
/Payments/text2pay
post
/Payments/terminal
post
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
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
Get reconciliation summary for a specific date
get
Get reconciliation summaries for a date range (max 365 days)
post
/Payments/reconciliation/close
post
Close the current open batch in XplorPay, settling all unsettled transactions. This initiates the batch-out process with the payment processor.
post
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
Pharmacies
5
Phones
2
PriceRules
6
Printers
6
PrintJobs
4
PtoRequests
6
PublicNps
2
PublicPriceList
5
PublicQuestionnaires
2
PublicSmsConsent
2
PurchaseOrders
11
QiEvents
9
QuestionnaireResponses
6
Questionnaires
10
RabiesTags
10
RdvmPortal
22
Recordings
7
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
Subscriptions
8
SurgicalRecords
8
TagAssignments
4
Tags
5
TelnyxCallControl
1
Templates
10
TenantKnowledge
4
TimeEntries
5
Transparency
3
Users
11
Vaccinations
9
VaccineAdministration
3
VaccineCertificateRecords
6
VaccineCertificates
2
VaccineTypes
5
Vendors
6
Vitals
2
VitalTypes
6
Widget
17
WidgetChatbot
4
WorkItemRules
5
WorkTasks
13
Payments
Close the current open batch in XplorPay, settling all unsettled transactions. This initiates the batch-out process with the payment processor.
post
/Payments/batch/close
Response
OK
BatchCloseResponseDto
required
Response from closing a payment processor batch.
success
boolean
confirmationCode
string
nullable
dateOpened
string
date-time
nullable
netAmount
union
refundCount
union
refundTotal
union
salesCount
union
salesTotal
union
settlementStatus
string
nullable
transactionCount
union