Skip to main content

​
Chargeworx

The enterprise platform for payments, chargebacks, and reconciliation. Product and operations teams use Chargeworx to manage transactions end to end: from secure API ingestion to exception handling, reporting, and audit trails.

Run locally

Spin up the stack (API and Admin) with environment presets.

Explore the API

Browse endpoints and auth flows with Swagger.

​
What you can do

Secure authentication

OAuth2 scopes, session cookies, and MFA for Admin users.

Manage companies

Create companies, switch context, and manage access keys.

Invite and onboard

Send invitations and track pending requests in the Admin UI.

​
Product surfaces

​
Admin UI

  • Home: personalized welcome, pending invitation banner, and quick actions
  • Navigation: profile, company switcher, members, tools, and saved reports
  • Runbooks: operational tasks like rotating IdentityServer keys and switching cache backends

Home

Authenticated entry to the Admin portal.

Members & invitations

Accept, decline, and manage invitations in bulk.

Organization settings

Update company details and keys.

​
API

  • OAuth2-protected REST endpoints with Swagger
  • Transaction operations, user and company resources, and request logging
Need a guided path? Start with Configuration, then review Logging and CI/CD.

​
Architecture at a glance

  • Chargeworx.Api — OAuth2 REST API with Swagger
  • Chargeworx.Admin — ASP.NET Core MVC app with MFA, invitations, and reporting
  • Chargeworx.ConsoleImporter — CLI for seeding and migrations

Projects

Components and responsibilities across services.

Cross-cutting concerns

Auth, caching, logging, and request tracing.

​
Security and compliance

  • IdentityServer-based auth with session verification in middleware
  • MFA and email flows integrated into AuthController
  • Auditable logging and request correlation for incident response

Identity & MFA

MFA guide

​
Operate and observe

  • Centralized logging and request logging for troubleshooting
  • Environment profiles: Dev, SharpDev, Staging, Production
  • Runbooks for common operations

Logging

Request logging

Rotate IdentityServer key

​
Next steps

Branching and PRs

Workflows

Pro tip: Use the search functionality to quickly find specific endpoints, configuration options, or troubleshooting guides across the documentation.