Skip to main content
Chargeworx home page
Search...
⌘K
Search...
Navigation
Using Swagger & ReDoc
Overview
Chargeworx
Architecture
System overview
Component interactions
Data flow
Integration patterns
System architecture
Payment processor integration
Cross-cutting concerns
Entities
Getting started
Local setup
Configuration reference
Environments
Security
IdentityServer
IdentityServer4 authentication
MFA and session
API reference
Addresses
BackgroundProcesses
Companies
CompanyProjects
CompanyProjectKeys
Company Project Users
CompanyUsers
IdentityServer Clients
ImportBatches
KeyStore
ProjectPaymentProcessors
Reports
ReportTransactions
Transactions
TransactionTags
Users
UserInvitations
Whitelist IP
Health
TransactionPayflowInternal
ChargeEvents
CompanyProjectCreditCardPaymentInfo
Admin UI
Admin authentication
Members
Companies
Reports
Tools
Data
Database architecture
Seeding & initializers
Observability
Logging
Request logging
Deployment
Deployment overview
CI/CD pipelines
Environment management
Rollback procedures
CI/CD
Branching and PRs
Workflows
Runbooks
Rotate IdentityServer key
Switch cache backend
Get an API token
Contributing
Dev guide
Using Swagger & ReDoc
Copy page
Explore and authorize requests directly in the UI.
Copy page
Swagger UI lives at the root path and serves both Swagger and OpenAPI documents
ReDoc is available at
/Redoc
Use the OAuth2 authorize button to perform client-credentials flow
⌘I