# Chargeworx

## Docs

- [Admin authentication](https://docs.chargeworx.com/admin/auth.md): Login, MFA, and API token usage in the Admin portal.
- [Companies](https://docs.chargeworx.com/admin/companies.md): Create and manage companies and projects.
- [Members](https://docs.chargeworx.com/admin/members.md): Manage member records and invitations.
- [Reports](https://docs.chargeworx.com/admin/reports.md): Chargebacks, credit card updater, and transaction reports.
- [Tools](https://docs.chargeworx.com/admin/tools.md): Utilities and one-off helpers.
- [Get Address Suggestions](https://docs.chargeworx.com/api-reference/addresses/get-address-suggestions.md): Queries the SmartyStreets US Street Address API to provide real-time, validated address suggestions as users type. Returns a list of standardized addresses in USPS format for frontend autocomplete/typeahead integration.
- [Cancel Background Process](https://docs.chargeworx.com/api-reference/backgroundprocesses/cancel-background-process.md): Cancels a running or pending background process, stopping its execution and marking it as cancelled.
- [Create Background Process](https://docs.chargeworx.com/api-reference/backgroundprocesses/create-background-process.md): Creates and initiates a new background process for executing long-running operations such as imports or batch jobs.
- [Get Background Processes](https://docs.chargeworx.com/api-reference/backgroundprocesses/get-background-processes.md): Queries all background processes accessible to the authenticated user with optional filtering and pagination.
- [Get Import Batch Entries](https://docs.chargeworx.com/api-reference/backgroundprocesses/get-import-batch-entries.md): Fetches granular details about each record in a batch import process, including processing status, validation errors, and troubleshooting information.
- [Get Last Import Info](https://docs.chargeworx.com/api-reference/backgroundprocesses/get-last-import-info.md): Returns metadata and timestamp information about the most recently completed import operation across all background processes.
- [Get Transaction Report Sync Info](https://docs.chargeworx.com/api-reference/backgroundprocesses/get-transaction-report-sync-info.md): Returns synchronization status and metadata for transaction report data, including last sync timestamp and record counts.
- [Get Chargeback Details](https://docs.chargeworx.com/api-reference/chargeevents/get-chargeback-details.md): Retrieves detailed information about a specific chargeback including dispute reason, amount, and response deadline for dispute management.
- [Get Purchase Refunds](https://docs.chargeworx.com/api-reference/chargeevents/get-purchase-refunds.md): Retrieves a list of purchase refunds filtered by date range, status, or transaction for reconciliation and reporting.
- [Create Company](https://docs.chargeworx.com/api-reference/companies/create-company.md): Establishes a new company account in the Chargeworx system for payment processing and transaction management.
- [Get Companies](https://docs.chargeworx.com/api-reference/companies/get-companies.md): Retrieves a filtered and paginated list of companies based on specified search criteria.
- [Update Company](https://docs.chargeworx.com/api-reference/companies/update-company.md): Updates an existing company's information including name, address, contact details, or status.
- [Assign User to Project](https://docs.chargeworx.com/api-reference/company-project-users/assign-user-to-project.md): Assigns a company user to a project, granting access to project-specific features, transactions, and data with role-based permissions.
- [Get Project User Associations](https://docs.chargeworx.com/api-reference/company-project-users/get-project-user-associations.md): Retrieves user-project associations based on filters, showing which users have access to which projects.
- [Get User Project Assignments](https://docs.chargeworx.com/api-reference/company-project-users/get-user-project-assignments.md): Retrieves all projects assigned to a specific user with role and assignment details.
- [Remove User from Project](https://docs.chargeworx.com/api-reference/company-project-users/remove-user-from-project.md): Revokes user's project access by soft-deleting the association while maintaining audit history.
- [Update Project User Association](https://docs.chargeworx.com/api-reference/company-project-users/update-project-user-association.md): Modifies user-project association to change roles or permissions without recreating the association.
- [Validate Company Ownership](https://docs.chargeworx.com/api-reference/company-project-users/validate-company-ownership.md): Verifies that a user-project association belongs to the specified company for security validation.
- [Create Payment Token](https://docs.chargeworx.com/api-reference/companyprojectcreditcardpaymentinfo/create-payment-token.md): Creates a tokenized credit card payment method for recurring billing or stored payment scenarios.
- [Get Account Updater Results](https://docs.chargeworx.com/api-reference/companyprojectcreditcardpaymentinfo/get-account-updater-results.md): Retrieves account updater results showing which stored cards have been automatically updated by card networks.
- [Get Card Information](https://docs.chargeworx.com/api-reference/companyprojectcreditcardpaymentinfo/get-card-information.md): Retrieves masked credit card details for display purposes such as showing saved payment methods to customers.
- [Get Payment Tokens](https://docs.chargeworx.com/api-reference/companyprojectcreditcardpaymentinfo/get-payment-tokens.md): Retrieves stored credit card payment tokens for the project, returning masked card details for display and selection.
- [Recreate Payment Token](https://docs.chargeworx.com/api-reference/companyprojectcreditcardpaymentinfo/recreate-payment-token.md): Recreates a payment token with updated card information, typically used when updating expired or changed card details.
- [Set Account Updater Priority](https://docs.chargeworx.com/api-reference/companyprojectcreditcardpaymentinfo/set-account-updater-priority.md): Configures account updater priority settings to control which cards are prioritized for automatic updates.
- [Delete API Key](https://docs.chargeworx.com/api-reference/companyprojectkeys/delete-api-key.md): Permanently deletes an API key, immediately revoking its authentication ability. This is irreversible.
- [Generate New API Key](https://docs.chargeworx.com/api-reference/companyprojectkeys/generate-new-api-key.md): Creates a new cryptographically secure API key for a project. The full unmasked key is returned only in this response - store it securely immediately.
- [Get Project API Keys](https://docs.chargeworx.com/api-reference/companyprojectkeys/get-project-api-keys.md): Retrieves a filtered and paginated list of API keys for a specific project or across multiple projects with masked key values for security.
- [Get Unmasked API Key Value](https://docs.chargeworx.com/api-reference/companyprojectkeys/get-unmasked-api-key-value.md): Retrieves the complete unmasked API key value for a specific key. Use with caution as this exposes the full credential.
- [Update API Key Metadata](https://docs.chargeworx.com/api-reference/companyprojectkeys/update-api-key-metadata.md): Modifies API key metadata (name, description, active status) without changing the actual key value.
- [Create Company Project](https://docs.chargeworx.com/api-reference/companyprojects/create-company-project.md): Establishes a new project under an existing company representing a logical division, application, or business unit that processes transactions independently.
- [Get Company Project Details](https://docs.chargeworx.com/api-reference/companyprojects/get-company-project-details.md): Retrieves complete configuration and settings for a specific project including general settings, payment processor configuration, and security settings.
- [Get Company Projects](https://docs.chargeworx.com/api-reference/companyprojects/get-company-projects.md): Retrieves a filtered and paginated list of projects based on company, name, or status criteria.
- [Get Project reCAPTCHA Settings](https://docs.chargeworx.com/api-reference/companyprojects/get-project-recaptcha-settings.md): Retrieves Google reCAPTCHA configuration for a project including site key, secret key, version (v2/v3), and score thresholds.
- [Set Project reCAPTCHA Settings](https://docs.chargeworx.com/api-reference/companyprojects/set-project-recaptcha-settings.md): Configures or updates Google reCAPTCHA settings for bot detection and fraud prevention in payment forms.
- [Update Project General Information](https://docs.chargeworx.com/api-reference/companyprojects/update-project-general-information.md): Modifies a project's basic settings (name, description, URLs, status) without affecting payment processor or security configuration.
- [Update Project Merchant Information](https://docs.chargeworx.com/api-reference/companyprojects/update-project-merchant-information.md): Modifies a project's payment processor configuration (credentials, merchant IDs, gateway settings) without affecting general or security settings.
- [Create Company User](https://docs.chargeworx.com/api-reference/companyusers/create-company-user.md): Creates a new user account associated with a company. After creation, assign users to projects via CompanyProjectUserController for project-level access.
- [Delete Company User](https://docs.chargeworx.com/api-reference/companyusers/delete-company-user.md): Soft deletes a company user by marking them inactive while preserving historical data for audit purposes.
- [Get Company Users](https://docs.chargeworx.com/api-reference/companyusers/get-company-users.md): Retrieves a filtered and paginated list of company users based on specified criteria.
- [Get Users With Projects](https://docs.chargeworx.com/api-reference/companyusers/get-users-with-projects.md): Retrieves company users with their project assignments showing which projects each user can access.
- [Set Last Login Date](https://docs.chargeworx.com/api-reference/companyusers/set-last-login-date.md): Records the last login timestamp for a company user for activity tracking and auditing purposes.
- [Update Company User](https://docs.chargeworx.com/api-reference/companyusers/update-company-user.md): Modifies a company user's profile information, role, or active status with changes taking effect immediately across all projects.
- [Verify User Belongs to Company](https://docs.chargeworx.com/api-reference/companyusers/verify-user-belongs-to-company.md): Validates that a company user belongs to a specific company for security and access control purposes.
- [Get Health Status](https://docs.chargeworx.com/api-reference/health/get-health-status.md): Retrieves the current health status of the API and its dependencies for monitoring and load balancing.
- [Create IdentityServer Client](https://docs.chargeworx.com/api-reference/identityserver-clients/create-identityserver-client.md): Registers a new OAuth/OIDC client with IdentityServer4 enabling applications to request authentication and authorization.
- [Delete IdentityServer Client](https://docs.chargeworx.com/api-reference/identityserver-clients/delete-identityserver-client.md): Removes an OAuth/OIDC client from IdentityServer4 preventing the client application from authenticating or obtaining new tokens.
- [Get IdentityServer Clients](https://docs.chargeworx.com/api-reference/identityserver-clients/get-identityserver-clients.md): Retrieves a filtered list of OAuth/OIDC clients configured in IdentityServer4.
- [Update IdentityServer Client](https://docs.chargeworx.com/api-reference/identityserver-clients/update-identityserver-client.md): Modifies an existing IdentityServer4 client configuration including secrets, scopes, redirect URIs, or token lifetimes.
- [Delete Import Batch Data](https://docs.chargeworx.com/api-reference/importbatches/delete-import-batch-data.md): Deletes old or completed import batch data to free storage space and manage system resources.
- [Download Import Result File](https://docs.chargeworx.com/api-reference/importbatches/download-import-result-file.md): Downloads the CSV result file for a completed import batch showing success/failure status for each imported row.
- [Get Import Batches](https://docs.chargeworx.com/api-reference/importbatches/get-import-batches.md): Retrieves import batch history with flexible filtering for administrative monitoring and management.
- [Upload Import File](https://docs.chargeworx.com/api-reference/importbatches/upload-import-file.md): Uploads a CSV file for bulk data import triggering asynchronous background processing.
- [Create Keystore Entry](https://docs.chargeworx.com/api-reference/keystore/create-keystore-entry.md): Creates a new keystore entry with pre-generated encryption key material for use in encrypting sensitive data.
- [Generate Keystore](https://docs.chargeworx.com/api-reference/keystore/generate-keystore.md): Generates a new AES encryption keystore using cryptographically secure random number generation for immediate use in production encryption.
- [Get Active Keystore](https://docs.chargeworx.com/api-reference/keystore/get-active-keystore.md): Retrieves the currently active keystore used for encryption operations based on current date and activation status.
- [Get Keystore Entries](https://docs.chargeworx.com/api-reference/keystore/get-keystore-entries.md): Retrieves keystore entries matching the specified filter criteria for key rotation planning and audit purposes.
- [Soft Delete Keystore](https://docs.chargeworx.com/api-reference/keystore/soft-delete-keystore.md): Soft-deletes a keystore entry, marking it as inactive and unavailable for new encryption operations while retaining key material for historical data decryption.
- [Create Payment Processor Configuration](https://docs.chargeworx.com/api-reference/projectpaymentprocessors/create-payment-processor-configuration.md): Establishes a new payment processor integration for a project with merchant credentials and gateway settings.
- [Delete Payment Processor Configuration](https://docs.chargeworx.com/api-reference/projectpaymentprocessors/delete-payment-processor-configuration.md): Soft deletes a payment processor configuration, preserving historical transaction references while preventing future use.
- [Get Payment Processor Configurations](https://docs.chargeworx.com/api-reference/projectpaymentprocessors/get-payment-processor-configurations.md): Retrieves a filtered and paginated list of payment processor configurations for one or all projects.
- [Update Payment Processor Configuration](https://docs.chargeworx.com/api-reference/projectpaymentprocessors/update-payment-processor-configuration.md): Updates an existing payment processor configuration including credentials, name, and active status for credential rotation or configuration changes.
- [Update Processor Active Status](https://docs.chargeworx.com/api-reference/projectpaymentprocessors/update-processor-active-status.md): Updates only the active status of a payment processor configuration without modifying credentials or other settings.
- [Get Chargeback Report](https://docs.chargeworx.com/api-reference/reports/get-chargeback-report.md): Generates a chargeback activity report filtered by date range and criteria for dispute management and analysis.
- [Get Credit Card Updater Report](https://docs.chargeworx.com/api-reference/reports/get-credit-card-updater-report.md): Generates a credit card account updater report showing cards that have been updated, expired, or closed by issuing banks.
- [Generate Transaction Reports](https://docs.chargeworx.com/api-reference/reporttransactions/generate-transaction-reports.md): Generates aggregated transaction reports with summary statistics filtered by date range, company, project, or status for administrative dashboards and financial reconciliation.
- [Search Transaction Reports](https://docs.chargeworx.com/api-reference/reporttransactions/search-transaction-reports.md): Searches optimized transaction report data using flexible filters including text search, amount ranges, dates, and status for administrative lookups and analysis.
- [Get Payflow Cancel URL](https://docs.chargeworx.com/api-reference/transactionpayflowinternal/get-payflow-cancel-url.md): Retrieves the cancel URL for a Payflow transaction and redirects the user agent to it when user cancels payment.
- [Get Payflow Return URL](https://docs.chargeworx.com/api-reference/transactionpayflowinternal/get-payflow-return-url.md): Retrieves the return URL for a Payflow transaction and redirects the user agent to it after successful payment.
- [Redirect to Express Checkout](https://docs.chargeworx.com/api-reference/transactionpayflowinternal/redirect-to-express-checkout.md): Redirects a user to the Payflow Express Checkout page for the provided project and transaction identifiers.
- [Create Transaction](https://docs.chargeworx.com/api-reference/transactions/create-transaction.md): Creates a new payment transaction with the specified amount, payment method, customer information, and transaction type for the authenticated project.
- [Create Transaction V2](https://docs.chargeworx.com/api-reference/transactions/create-transaction-v2.md): Creates a new payment transaction using the enhanced v2 request format with additional fields and improved validation for the authenticated project.
- [Get CyberSource Transaction Details](https://docs.chargeworx.com/api-reference/transactions/get-cybersource-transaction-details.md): Retrieves CyberSource-specific transaction details including enhanced fraud management data, decision manager results, and processor-specific fields.
- [Get Payflow Payment Information](https://docs.chargeworx.com/api-reference/transactions/get-payflow-payment-information.md): Retrieves PayPal Payflow-specific payment information including transaction details, processor response codes, and Payflow gateway data.
- [Get Transaction Details](https://docs.chargeworx.com/api-reference/transactions/get-transaction-details.md): Retrieves complete details for a specific transaction including payment method, gateway response, and transaction history.
- [Get Transactions](https://docs.chargeworx.com/api-reference/transactions/get-transactions.md): Retrieves transaction records for the authenticated project with optional filtering by transaction ID for reconciliation and reporting.
- [Process Refund](https://docs.chargeworx.com/api-reference/transactions/process-refund.md): Processes a refund for a captured transaction, returning funds to the customer's original payment method.
- [Reverse Authorization](https://docs.chargeworx.com/api-reference/transactions/reverse-authorization.md): Reverses (voids) an authorized but uncaptured transaction, releasing the hold on the customer's funds.
- [Reverse Authorization](https://docs.chargeworx.com/api-reference/transactions/reverse-authorization-1.md): Reverses a previously authorized transaction, releasing the held funds back to the customer without capturing payment.
- [Search Transactions](https://docs.chargeworx.com/api-reference/transactions/search-transactions.md): Searches transactions filtered by date range, amount, customer, status, or transaction type for administrative review and reporting.
- [Get Transaction Tags](https://docs.chargeworx.com/api-reference/transactiontags/get-transaction-tags.md): Retrieves transaction tags filtered by transaction ID, project, tag name, or other criteria for analysis and reporting.
- [Update Transaction Tags](https://docs.chargeworx.com/api-reference/transactiontags/update-transaction-tags.md): Applies tag updates to one or more transactions, including adding new tags, removing existing tags, or modifying tag metadata.
- [Delete User Invitation](https://docs.chargeworx.com/api-reference/userinvitations/delete-user-invitation.md): Soft deletes (cancels) a pending user invitation, preventing the user from completing registration with this invitation link.
- [Get Pending Invitations by Company](https://docs.chargeworx.com/api-reference/userinvitations/get-pending-invitations-by-company.md): Retrieves all pending (not yet accepted) invitations for a specific company, useful for dashboards showing outstanding invitations.
- [Get User Invitations](https://docs.chargeworx.com/api-reference/userinvitations/get-user-invitations.md): Retrieves a filtered list of user invitations based on company, status, email, or date range for invitation management and auditing.
- [Resend User Invitation](https://docs.chargeworx.com/api-reference/userinvitations/resend-user-invitation.md): Resends an existing invitation email to the invited user, typically when the original email was missed or expired.
- [Send User Invitations](https://docs.chargeworx.com/api-reference/userinvitations/send-user-invitations.md): Sends new user invitations to one or more email addresses, automatically creating invitation records and sending invitation emails.
- [Update Invitation Statuses](https://docs.chargeworx.com/api-reference/userinvitations/update-invitation-statuses.md): Modifies the status of one or more user invitations in batch, typically for marking invitations as cancelled or expired.
- [Validate Invitation Company](https://docs.chargeworx.com/api-reference/userinvitations/validate-invitation-company.md): Verifies whether a user invitation belongs to a specific company for security validation and access control.
- [Create User](https://docs.chargeworx.com/api-reference/users/create-user.md): Creates a new platform user with the specified email, name, password, and profile information for authentication and platform access.
- [Get User Details](https://docs.chargeworx.com/api-reference/users/get-user-details.md): Retrieves detailed information about a specific user including profile data, associated companies, and permission details.
- [Get Users](https://docs.chargeworx.com/api-reference/users/get-users.md): Retrieves a filtered and paginated list of platform users based on specified search criteria including email, name, and active status.
- [Update Member Profile](https://docs.chargeworx.com/api-reference/users/update-member-profile.md): Updates a member user's own profile through a self-service operation with restricted field access for security.
- [Update User](https://docs.chargeworx.com/api-reference/users/update-user.md): Updates an existing user's profile information including name, email, phone number, password, and active status.
- [Validate IP Address](https://docs.chargeworx.com/api-reference/whitelist-ip/validate-ip-address.md): Validates whether an IP address is whitelisted for the specified company or project for access control purposes.
- [Component interactions](https://docs.chargeworx.com/architecture/component-interactions.md): How services communicate and coordinate within the Chargeworx platform.
- [Cross-cutting concerns](https://docs.chargeworx.com/architecture/cross-cutting.md): Logging, caching, security, and platform middleware.
- [Data flow](https://docs.chargeworx.com/architecture/data-flow.md): Payment processing flow and data movement through the Chargeworx platform.
- [Entities](https://docs.chargeworx.com/architecture/entities.md): Core data model entities in Chargeworx
- [Account updater](https://docs.chargeworx.com/architecture/entities/account-updater.md): Credit card account updater data models in Chargeworx
- [Background process](https://docs.chargeworx.com/architecture/entities/background-process.md): Background processing and job queue data models in Chargeworx
- [Batch and import](https://docs.chargeworx.com/architecture/entities/batch-import.md): Batch processing and transaction import data models in Chargeworx
- [Chargeback and refund](https://docs.chargeworx.com/architecture/entities/chargeback-refund.md): Chargeback and refund data models in Chargeworx
- [Company](https://docs.chargeworx.com/architecture/entities/company.md): Top-level organizational unit linking projects, users, and billing details
- [Payment](https://docs.chargeworx.com/architecture/entities/payment.md): Payment method and billing data models in Chargeworx
- [Processor](https://docs.chargeworx.com/architecture/entities/processor.md): Payment processor configuration and result data models in Chargeworx
- [Project](https://docs.chargeworx.com/architecture/entities/project.md): Operational environment for transactions, processors, and API integrations
- [Response and validation](https://docs.chargeworx.com/architecture/entities/response-validation.md): Transaction response and validation data models in Chargeworx
- [Security and auth](https://docs.chargeworx.com/architecture/entities/security-auth.md): Security, authentication, and authorization data models in Chargeworx
- [Transaction](https://docs.chargeworx.com/architecture/entities/transaction.md): Core transaction data models in Chargeworx
- [User](https://docs.chargeworx.com/architecture/entities/user.md): Authenticated individual with role-based access to Chargeworx
- [Integration patterns](https://docs.chargeworx.com/architecture/integration-patterns.md): Common integration scenarios and best practices for the Chargeworx platform.
- [Payment processor integration](https://docs.chargeworx.com/architecture/payment-processors.md): CyberSource and PayPal/Payflow integration patterns.
- [System architecture](https://docs.chargeworx.com/architecture/projects.md): Multi-project structure and layer responsibilities.
- [System overview](https://docs.chargeworx.com/architecture/system-overview.md): High-level architecture and core components of the Chargeworx payment platform.
- [Branching and PRs](https://docs.chargeworx.com/ci-cd/branching-and-prs.md): Our branch strategy and PR checklist.
- [Workflows](https://docs.chargeworx.com/ci-cd/workflows.md): How our composite workflow is invoked.
- [Dev guide](https://docs.chargeworx.com/contributing/dev-guide.md): Local workflow, style, and CI gates.
- [Database architecture](https://docs.chargeworx.com/data/persistence.md): Multi-database structure and persistence layer.
- [Seeding & initializers](https://docs.chargeworx.com/data/seeding-and-initializers.md): How ConsoleImporter seeds data for local and test envs.
- [CI/CD pipelines](https://docs.chargeworx.com/deployment/ci-cd-pipelines.md): GitHub Actions workflows and continuous integration/deployment processes
- [Environment management](https://docs.chargeworx.com/deployment/environment-management.md): Managing deployment environments and configurations
- [Deployment overview](https://docs.chargeworx.com/deployment/overview.md): Overview of the Chargeworx deployment process and infrastructure
- [Rollback procedures](https://docs.chargeworx.com/deployment/rollback-procedures.md): Handling deployment failures and rollback strategies
- [Configuration reference](https://docs.chargeworx.com/getting-started/configuration.md): Key appsettings and how they change runtime behavior.
- [Environments](https://docs.chargeworx.com/getting-started/environments.md): Dev, Staging, Sharpdev, and Prod behaviors.
- [Local setup](https://docs.chargeworx.com/getting-started/local-setup.md): Run API and Admin locally with LocalDB defaults.
- [Chargeworx](https://docs.chargeworx.com/index.md): Unified platform for payments, chargebacks, and program management with secure APIs and an enterprise Admin UI.
- [Logging](https://docs.chargeworx.com/observability/logging.md): log4net provider and configuration.
- [Request logging](https://docs.chargeworx.com/observability/request-logging.md): Middleware behavior and configuration flags.
- [Get an API token](https://docs.chargeworx.com/runbooks/get-api-token.md): Obtain a token via client credentials and call an endpoint.
- [Rotate IdentityServer key](https://docs.chargeworx.com/runbooks/rotate-identityserver-key.md): Dev vs prod key rotation.
- [Switch cache backend](https://docs.chargeworx.com/runbooks/switch-cache-backend.md): Toggle between in-memory and Redis.
- [IdentityServer4 authentication](https://docs.chargeworx.com/security/authentication.md): OAuth2/OIDC implementation and token-based security.
- [IdentityServer](https://docs.chargeworx.com/security/identityserver.md): Token issuance and scopes used by Chargeworx.
- [MFA and session](https://docs.chargeworx.com/security/mfa.md): Admin UI MFA and session controls.

## OpenAPI Specs

- [openapi](https://docs.chargeworx.com/api-reference/openapi.json)