Account Management

This chapter provides a comprehensive guide to managing accounts within the OCS.io. It covers various aspects of account management, including creating, updating, and retrieving account information. The following sub-chapters are included:

The CreateAccount API allows for the creation of new accounts within the system. This API provides the necessary functionality to set up account details and initial configurations.

The CreateSubscriptionOnAccount API covers the management of transactions related to accounts. This includes recording, updating, and retrieving transaction details to maintain accurate financial records.

The UpdateAccountExternalId API allows for the modification of an account’s external ID. This API provides the necessary functionality to update the external identifier used for account management.

The UpdateAccountCustomName API covers the management of custom names associated with accounts. This includes updating the custom name to reflect changes in account details.

The UpdateAccountCustomAttributes API enables the modification of custom attributes for an account. Custom attributes are implemented as key-value pairs, and the system must provide the full set of key-value pairs in the request.

The UpdateAccountSegment API allows for updating the segment of an account. This attribute is used for categorizing accounts and is crucial for subsequent processes.

The UpdateAccountState API provides access to the historical data of an account. This includes past transactions, changes in account status, and other relevant historical information.

The UpdateAccountBillCycle API allows for querying the current balance of an account. This API is crucial for financial management and ensuring that account balances are up-to-date and accurate.

The CancelAccountBillCycleChange API provides the functionality to remove an account from the system. This API ensures that all associated data is properly handled and that the account is securely deleted.

The UpdateAccountTaxExemption API manages notifications related to account activities. This includes setting up, sending, and managing notifications to keep account holders informed about important events and updates.

The ReadAccount API allows for retrieving detailed information about an account using its unique identifier. This API is essential for accessing account data for management and reporting purposes.

Each sub-chapter provides detailed information on the respective API, including usage examples, parameters, and expected responses. This guide aims to equip developers with the knowledge and tools necessary to effectively manage accounts within the OCS.io.