Skip to main content
The Chargeworx API provides comprehensive endpoints for managing payment processing, companies, projects, users, and reporting. The API is organized into several main categories:

​
API Categories

​
Administration (/api/adm)

Core administrative endpoints for managing the platform:
  • Companies - Create and manage company accounts
  • Projects - Configure company projects and settings
  • Users - User and invitation management
  • Keys - API key generation and management
  • Payment Processors - Configure payment processor integrations

​
Payment Operations (/api/pay)

Payment processing and transaction management:
  • Transactions - Create and manage payment transactions
  • Payment Info - Store and manage payment methods
  • Charge Events - Handle chargebacks and refunds

​
Internal Operations (/api/internal)

Internal system operations:
  • Transaction Payflow - PayPal Express Checkout integration
  • Return/Cancel URLs - Payment flow redirects

​
Authentication

All API endpoints require OAuth2 authentication using client credentials flow. See the authentication guide for details on obtaining access tokens.

​
Base URL

https://api.chargeworx.com

​
Common Response Format

All endpoints return responses in a consistent format: 
{
  "success": true,
  "code": "Success",
  "errorMessage": null,
  "entries": []
}

​
Error Handling

Failed requests return a ProblemDetails object with error information: 
{
  "type": "string",
  "title": "Error title",
  "status": 400,
  "detail": "Detailed error message",
  "instance": "string"
}

​
Rate Limiting

API requests are subject to rate limiting. Contact support for current limits and to request increases.

​
Full API Reference

For complete API documentation including all endpoints, request/response schemas, and interactive testing, see the auto-generated API reference pages in the navigation menu or visit the Swagger UI.