Cents Company
Company APIs is organized into distinct groups, each serving a specific aspect of the platform's functionality. This structured approach ensures that companies can easily navigate and utilize the API based on their particular needs. Here's an overview of the key groups within the API:
-
Info: provides endpoints related to the company's details. Endpoints are designed to be accessible after authentication.
-
Charities: includes endpoints that offer information about various charities associated with the platform and the company. Companies can access details about each charity, including their causes and impact areas. Additionally, there are endpoints for viewing the charities selected by the company for their programs. These paths can be either public or authenticated, depending on the level of detail and functionality provided.
-
Transactions: includes endpoints related to transaction management. It provides comprehensive details about individual transactions, pre-transactions, and the processes for creating and updating transactions. Companies can access authenticated paths to manage transactions specific to their consumer users, ensuring secure and accurate handling of financial data.
-
Subscriptions: contains endpoints for managing consumer user subscriptions. Companies can create new subscriptions, edit existing ones, and retrieve detailed information about active subscriptions. These endpoints are authenticated to protect user information and subscription details.
-
Consumer Users: offer information about consumer users associated with the company. Companies can create new consumer user profiles, edit existing profiles, and access detailed information about their consumer users. These authenticated paths ensure that sensitive user data is securely managed.
-
Round-up Sources: focused on managing sources for the round-up method, which includes various round-up sources such as credit cards, debit cards, prepaid cards, main accounts, and saving accounts. Companies can use these endpoints to add, edit, and manage payment methods for their consumer users, facilitating seamless round-up transactions. These paths require authentication to maintain the security and integrity of payment information.
Company APIs are designed with both public and authenticated paths to balance accessibility and security. Public paths allow general access to non-sensitive information, enabling broader use without compromising security. Authenticated paths, on the other hand, require proper authorization to access and manage sensitive data, ensuring that only authorized users can perform certain actions.
Company API documentation aims to provide companies the tools they need to effectively manage and utilize the platform's features, from company details and charity information to transaction management and user subscriptions.
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
Contact
License
Apache 2.0