Documentation
Service VIN developer & AI platformGetting startedAuthenticationPaginationIdempotencyRate limitsErrorsWebhooks & signature verificationConnecting ClaudeRecipesMCP servers & the Claude connectorREST resource referenceCapability indexCustomers capabilitiesVehicles capabilitiesLeads capabilitiesWarranties capabilitiesQuotes capabilitiesInvoices capabilitiesPayments capabilitiesServices capabilitiesJobs capabilitiesCalendar capabilitiesScheduling capabilitiesStaff capabilitiesInventory capabilitiesComms capabilitiesTasks capabilitiesShop capabilitiesDocuments capabilitiesKnowledge capabilitiesReports capabilitiesBooking capabilitiesForms capabilitiesMarketing capabilitiesReviews capabilitiesAutomations capabilitiesIntegrations capabilitiesChangelogSearch
Domain
Payments capabilities
8 capabilities, all acting on a payment. A reference to one from another domain is spelled
payment_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.| Capability | What it does | Effect |
|---|---|---|
| payments.listPOST /api/v1/payments/list | List payments the shop has taken, by invoice, customer or date | read-only |
| payments.getPOST /api/v1/payments/get | Get one payment record and what is left of it | read-only |
| payments.deposit_statusPOST /api/v1/payments/deposit_status | Check which booked jobs still owe their deposit payment | read-only |
| payments.accepted_methodsPOST /api/v1/payments/accepted_methods | Check which payment methods this shop accepts from a customer | read-only |
| payments.payout_summaryPOST /api/v1/payments/payout_summary | Check the shop's card balance and its recent payments out | read-only |
| payments.tips_collectedPOST /api/v1/payments/tips_collected | Total the gratuities the shop's payments carried in a period | read-only |
| payments.disputesPOST /api/v1/payments/disputes | List the chargebacks disputing payments this shop took | read-only |
| payments.disputePOST /api/v1/payments/dispute | Get the chargeback on one payment and its evidence deadline | read-only |