Account Management Microservices
  • Dark
    Light
  • PDF

Account Management Microservices

  • Dark
    Light
  • PDF

Empower your customer care and retail store agent experience by using our out of the box Account Management microservices. Choose from over 71 APIs which allow management of a customer's account from creation to modification including address changes, inventory selection and also help provide information on payment plan information and tax exemptions.


APIs

accountGetByFilter

The accountGetByFilter API retrieves the details of a customer's account based on the applied filter criteria. For example, if a ServiceExternalId is used as the filtering criterion, the API response includes the customer service information in the Services attribute for the matching services.

accountGetById

Every customer is mapped to a customer account ID. A validation check is performed on the customer search based on the specified account ID. This API retrieves the details of a customer's account based on the unique customer account ID.

accountSegmentGet

During the shopping process, the customers’ needs to specify certain values and in this case it is the account segment value which along with the rest trigger an address validation check. The purpose of this API is to retreive the details of all the account segments associated with a customer's account.

accountUpdate

Every customer is mapped to a customer account ID. This API updates the information of a customer's existing account based on the unique customer account ID and the extended data list.

applyTaxExemption

In scenarios where a tax exemption should be given to a customer against an order, a validation check is performed and if it is a valid scenario, this API may be used to apply the eligible tax exemption as requested to the customer's account on the basis of the request. This is generally via a Contact Center call.

cancelServiceResume

In the event of cancellation of service and to also cancel any future dated resumption this API may be used to integrate with an external application to achieve this via the usage of specific variable values.

cancelServiceSuspend

In the event of cancellation of service and to also cancel any future dated suspensions this API may be used to integrate with an external application to achieve this via the usage of specific variable values. It extends also to the future dated resumptions of the same service which are on and after the suspension date.

cfsGetByFilter

Customer facing services are exposed to customers to ensure that the services, represented as product offerings, fulfills the customer requirement. This API retrieves the customer facing service information based on the filter criteria passed in the query parameter.

cfsGetById

Services or product offerings exposed to customers are based on the unique service internal ID. This API retrieves the details of the service provided to the customer based on the account internal ID, service internal ID, and service internal ID resets.

cfsStatusesFind

This API retrieves the current status details of the customer facing service provided to the customer based on the account internal ID, service internal ID, and service internal ID resets.

cfsSubscriberHistoryFind

Customers can fetch the history of the subscribed services for a CFS account. This API fetches the details of the subscriber history for a particular customer facing service account, which includes the recharge charges, usage charges, MTR, and recurring charges.

createAccountAlert

Alerts are created for the customer's account to make sure that an appropriate action is taken in a timely manner. Customers can create different alerts for the linked account. This API creates different alert notifications for a customer's account based on the account internal ID and alert information specified in the query parameter.

createAccountExtId

To generate an interaction event, an account-level external ID is created. This API creates a new external ID for the customer's account based on the unique account ID.

createAddress

Customers can generate the address and address association for a customer's account. This API generates an address and address association for a customer's account.

createAddressAssoc

Customers can generate an address association for a customer's account using this API

createBlocklistedAddress

If the customers are marked as blocklisted, they are not allowed to place orders. This API generates the details of the blocklisted address and configures the status of the blocklisted address.

createChargeRedirection

Customers can create a charge redirection rule applied at the account-level. This API creates a charge redirection rule for a customer's account.

deactivateAccountExtId

To remove a specific interaction event, an account-level external ID is deleted. This API deactivates an external ID associated with a customer's account based on the unique account ID.

deleteAddress

Customers can remove the details of the customer's delivery address on the basis of the required parameters. This API removes the details of a customer's delivery address based on the account ID, address ID, and address type ID.

expireChargeRedirection

Customers can expire the charge redirection rules applied at the account-level. This API configures the inactive date for a redirection rules applied to a customer's account.

findChargeRedirections

Customers can search for the charge redirection rules applied on a customer's account. This API searches for the charge redirection rules applied to a customer's account based on a filter criterion.

findServiceAddress

Every customer needs to share the address details to avail the services of the product. This API fetches the details of a customer's service address based on the unique account identifier.

findSubscriberHistory

Customers can check the history of the subscribed services. This API fetches the details of the subscriber history for a particular customer facing service, which includes recharge charges, usage charges, MTR, and recurring charges.

findTaxExemption

Tax exemptions are applied to the customer's account to exempt the customer from paying certain taxes. This API retrieves the details of the tax exemption applied on a customer's account.

findTaxExemptionsByFilter

Tax exemptions applied on a customer's account can be filtered based on the input parameters. This API retrieves the details of all the tax exemptions applied on a customer's account as per the search criteria.

getAddress

Customers can fetch the information about the customer's delivery address on the basis of the account ID. This API retrieves the details of the customer's delivery address based on the account ID.

getAlertsByAccountId

Different alert notifications are created for a customer's account. This API fetches the details about different alerts created for a customer's account based on the applied filter criteria.

getCfsExtIds

Customers can search for the external IDs associated with the CFS. This API searches for the external identifiers of the services based on the applied filter criteria. Allows filters and field support in search response.

getChargeRedirections

Customers can fetch the charge redirection rules applied at the account-level. This API retrieves the details on the existing charge redirection rules applied to a customer's account.

getcreditscore

Credit score is applied on a customer's account to check the financial report of the customer. This API retrieves the details of the credit score for a customer's account.

getExtIdsByAccId

The API retrieves the details of a customer's account external identifiers based on the based on the account ID and optional filters.

getSummaryById

Every customer is mapped to an account internal ID. This API retrieves information based on the account internal ID and provides a summary of the balances for the customer mapped to the account ID. The AccountInternalId parameter is the mandatory field.

invElementRecover

During the transition period, customers can update the post recovery information of the inventory item. This API updates the transitional details of a customer's inventory element post recovery.

inventoryFindByFilters

While shopping, customers can search for the available inventory items. This API searches for an inventory element with a specified inventoryTypeId that exists in the system for the specified datetime and/or other filter values. This API also retrieves the details of the equipment that are awaiting in the returned state.

inventoryFindReserve

While shopping, customers can choose and reserve the inventory items assigned to a CFS. This API retrieves and saves the details of an inventory element, assigned to a customer facing service.

inventoryFindReserveSecure

While shopping, customers can choose and reserve the inventory items assigned to a customer's account. This API retrieves and saves the details of an inventory element, assigned to a customer's account.

InventoryServiceFindById

The details of the inventory items are displayed based on the unique input parameters. This API retrieves the details on the inventory items based on the service internal ID and service internal ID resets.

modifyCfsExtIds

Customers can modify the service external IDs associated with the CFS. This API updates the details of the service external ID for a customer's account.

modifyInvElement

To enhance the inventory element, the customer updates the extended data. A validation check is performed on the extended data to update the inventory element for the appropriate parameter ID. This API updates the details of an inventory element in the database based on the inventory ID, inventory ID resets, and inventory element. inventoryId, inventoryIdResets, and invElement are the mandatory fields.

modifyTaxExemption

A customer can update an existing tax exemption, which can either be in pending, approve, or declined state. This API updates the details of the tax exemptions applied on a customer's account, in order to satisfy the caller's request.

productInstAccountFindById

The detailed summary of the available products can be searched based on the filter criteria. This API searches the product summary associated with a customer's account based on the applied filter criteria.

productInstAccountFindByPackage

The details of the product packages are displayed based on the unique identifiers. This API retrieves the details on the product package based on the account internal ID, package installation ID, and package installation service ID.

productInstServiceFindById

The details of the product instances are displayed based on the unique input parameters. This API retrieves the details on the product instance based on the service internal ID and service internal ID resets.

productInstServiceFindByPackage

The details of the product packages are displayed based on the unique parameters. This API retrieves the details on the product package based on the service internal ID, service internal ID resets, package installation ID, and package installation service ID.

releaseInvReserved

During the shopping process, a customer can choose and reserve the
inventory items in the cart. This API releases a reserved inventory through viewId.

releaseInvReservedSecure

During the shopping process, customer's can choose and reserve the inventory items for a customer's account. This API releases the reserved inventory items for a customer's account through viewId.

resumeMultipleServices

Customers can resume multiple CFS on the basis of the unique service
identifiers. This API resumes multiple customer facing services associated with a customer's account.

retrieveAccountScores

Customers can fetch the score value for a specific shopping cart. This API retrieves the account score details of the selected shopping cart.

retrieveAppliedProducts

While shopping, customers can choose and reserve the product instances associated with a customer's account. This API retrieves and saves the details of a product instance, associated with a customer's account.

retrievecontractdetails

The contract information of a customer's account is saved in the database. This API fetches the details of a customer's contract.

retrievePaymentPlans

To avail the services, customers should have an active payment plan. The API retrieves the details of the customer's payment plan and current status on the basis of the account internal ID, service ID, and offer ID. AccountInternalId is the mandatory field.

retrieveSubscriberHistoryEvents

Customers can check the history of the events associated with the subscribed services. This API retrieves the details of the subscriber history events for a particular customer facing service, which includes recharge charges, usage charges, MTR, and recurring charges from FX.

scoreRetrieve

Customers can check and verify the details of the credit history. This API retrieves the details of the credit score history of a customer's account.

scoreUpdate

Customers can define the credit score value for a specific customer's account. This API applies the credit score on a particular customer's account based on the financial reports of the customer.

searchCustomerByKey

Customers can search for the information related to the customer's account depending on the search key. This API fetches the details of a customer's account based on a search key element, which can be customer account internal ID, order ID, service external ID.

serviceResume

This API enables the external applications to resume a CFS based on the service ID. The client specifies the CFS identifier with resumeDt, along with other fields to resume the service.

serviceSuspend

This API allows an external application to suspend and resume (optionally) the customer facing service. The client specifies the CFS identifier with suspendDt and resumeDt, along with the other fields to suspend or resume CFS.

serviceUpdate

This API enables the external applications to update the customer facing service details. The client specifies the CFS identifier and the fields updates in the payload request. This API also updates the customer facing service extended data.

suspendMultipleServices

Customers can suspend multiple CFS on the basis of the unique service identifiers. This API suspends multiple customer facing services associated with a customer's account.

updateAccountAlert

Customers can update the existing details of an alert by adding a note content. This API updates the signature information for a new ESB service to update an alert notification for a customer's account.

updateAccountScore

Customers can add the account score value for a specific shopping cart. This API introduces the account score details of the selected shopping cart.

updateAddress

Customers can update an existing address via this API.

updateAddressAssoc

Customers can update an existing address association via this API.

updateBlocklistedAddress

Customers can update the blocklisted state of an existing address. This API updates the blocklisted state of an existing blocklisted address.

updateExtId

To generate a specific interaction event, an account-level external ID is updated. This API updates the details of the existing external ID associated with a customer's account on the basis of the unique account ID.

updateServiceAddress

Customers can update the existing service address information. This API updates the details of a customer's existing service address based on the unique account ID.

validateBlocklistedAddresses

For every customer, it is mandatory to share the address details. Based on the specified address details, a serviceability check is performed to validate the address. This API validates the blocklisted status of a specified address.

validateExtIdUniqueness

Every customer is provided with a unique external ID, which is validated for the authentication purpose. This API authenticates the uniqueness of the external ID of a customer.

validateInventoryCustOwned

While shopping, customers can check the specific inventory items owned by the customer. This API validates a particular customer owned inventory item.

Discover how we can help your Business

Get in touch with us today


Was this article helpful?