The ACE API Documentation provides developers with a centralized reference for integrating external applications with ACE. It includes API endpoints, request and response models, authentication requirements, and data schemas for working with accounts, clients, payments, disputes, virtual agents, and other ACE resources.
Accessing the API Documentation
Go to Help → API Documentation.
Image Displays Help -> API Documentation Menu
Using the API Documentation
The API Documentation is organized into sections that make it easy to locate and understand available endpoints.
Section | Description |
|---|---|
API Categories | Browse APIs grouped by functional area, such as Accounts, Clients, Payments, Documents, Virtual Agent, and Users. |
Endpoints | View the operations available for each API, including request parameters, response models, and example payloads. |
Schemas | Review the data structures used for requests and responses. |
Authentication | View authentication requirements and security schemes for secured endpoints. |
Common API Categories
The API Documentation includes endpoints for many areas of ACE, including:
API Category | Purpose |
|---|---|
Account API | Manage accounts, notes, searches, and account-related information. |
Client API | Create, retrieve, update, and manage client information. |
Dispute API | Create, manage, and retrieve dispute records. |
Document API | Upload, retrieve, update, and manage documents. |
Payment API | Create payments and retrieve payment information. |
Preferences API | Retrieve and manage company preference information. |
SCIM API | Manage user provisioning and identity synchronization. |
Transaction API | Create and retrieve transaction information. |
User API | Retrieve user information and goal settings. |
Virtual Agent API | Manage Virtual Agent authentication, messaging, and preferences. |
Understanding HTTP Methods
Most ACE APIs use standard HTTP methods to perform operations.
Method | Purpose |
|---|---|
GET | Retrieve existing information. |
POST | Create a new record or initiate an action. |
PUT | Replace an existing resource with the values supplied in the request. |
PATCH | Update one or more fields of an existing resource without replacing the entire resource. |
DELETE | Remove an existing resource. |
Understanding Schemas
Schemas define the structure of the data accepted and returned by ACE APIs.
Schemas provide:
Required and optional fields
Supported data types
Object relationships
Validation requirements
Request and response formats
Understanding the associated schema helps ensure requests are formatted correctly and responses are interpreted accurately.
Image Displays Schemas Dropdown Menu
Exploring an Endpoint
Selecting an endpoint displays detailed information, including:
Endpoint URL
Supported HTTP method
Required parameters
Request body schema
Response codes
Example requests and responses
Authorization requirements
Use this information when building or troubleshooting integrations with ACE.
Additional Information
The API Documentation is continuously updated as new APIs and enhancements are added to ACE. For complete endpoint details, examples, and schema definitions, refer to the API Documentation available within the application.