The Account Service provides functionality for account onboarding, managing account status, applying treatments and flags, and handling account-level processes such as credit limit adjustments.
The following information offers an overview of the endpoints provided by the Account Service. For detailed technical documentation, refer to the Account Service API Reference.
Endpoints to handle core account operations.
| Endpoint name | Functionality |
|---|---|
| CreateAccount | Creates a new account based on the provided configuration and request data. |
| GetAccount | Retrieves detailed information about an account. |
| GetAccountIdByAccountNumber | Retrieves the account ID (GUID) based on the provided account number. |
Endpoints to manage account statuses.
| Endpoint name | Functionality |
|---|---|
| UpdateAccountStatus | Updates the status of an account (e.g. ChargeOff, Closed). |
| GetAccountStateHistory | Retrieves the history of account state changes, including updates to behaviour settings, treatments, and the status itself. |
| GetAccount | Retrieves detailed information about an account. |
Endpoints to manage account treatments.
| Endpoint name | Functionality |
|---|---|
| GetAvailableAccountTreatmentIndicators | Fetches the account treatment indicators enabled for a product. |
| AddAccountTreatment | Applies a treatment to an account. |
| RemoveAccountTreatment | Removes a treatment from an account. |
| UpdateAccountTreatment | Updates a treatment on an account, including changes to its effective and expiry dates. |
Endpoints to manage account flags.
| Endpoint name | Functionality |
|---|---|
| GetAccountFlagDefinitions | Retrieves the account flag definitions that can be set on an account manually. |
| SetAccountFlag | Updates or adds a flag to an account. |
| RemoveAccountFlag | Removes a flag from an account. |
Endpoints to manage account credit limits.
| Endpoint name | Functionality |
|---|---|
| UpdateCreditLimit | Updates the credit limit on an account. |
| UpdateCreditLimitIncreasePreference | Updates the credit limit increase preference for an account. |
Was this page helpful?