Entity segments
Last updated: June 12, 2024
Entity segments provide an additional layer of granularity to your account structure. This can help better represent your business structure on your account structure with Checkout.com. You can associate transaction data with an entity segment and manage user access appropriately.
Depending on your business requirements, an entity segment can be a combination of the:
- brand or website the payment came from
- business category of the payment (for example, books)
- location or market region where the payment originated (for example, EU)
Every entity segment is associated with a single entity. Transactions can be associated with an entity segment by associating processing channels.
When users are granted permission to specific entity segments, they can only view the associated transactions. For more information, see the User Permissions section.
To create and edit entity segments, ensure that you have the Administrator user role.
Open the business entity selector. This lists all the entity segments you can access associated with different entities.
When you choose a specific entity segment and select Switch view, the Dashboard is updated to display data related to the chosen entity segment.
Additionally, you can:
- filter information by segments on the Dashboard for transactions, disputes, analytics, and data explorer if you're on a client view or entity view
- add entity segments as an optional column in reports
Go to Settings > Account structure on your Dashboard.
Select Create entity segment.
In the Details page that opens, select the type of data to include and enter the relevant information. Verify the information as you will not be able to update these details after you create the entity segment.
Select Continue.
In the Name page that opens, the Name field is pre-populated with a suggested name. You can choose to edit this if you prefer.
Select Continue.
In the Processing channels page that opens, select the required channels. At least one processing channel must be selected to start associating transactions with the entity segment.
Note
a processing channel can only be associated with one entity segment, but an entity segment can have multiple processing channels associated with it
associating a payment with a segment is permanent and cannot be changed later
entity segments cannot be associated with historical payments
only pay-in and pay-to-card transactions can be associated with entity segments
Select Continue.
In the Review and confirm page, verify the information and select Create entity segment.
Entity segments without an active processing channel to tag payments are disabled. This is because payments can not be associated with them. You can still grant access to inactive entity segments with relevant user permissions and view related data on the Dashboard.
To edit a linked processing channel, you must disassociate it from its current entity segment before you can associate it with a new entity segment.
- Go to Settings > Account structure on your Dashboard.
- Select the entity segment you'd like to edit.
- Select Edit entity segment and make the required changes.
- Select Save entity segment.
Note
The following details can not be updated:
- brand name or website URL
- business category
- market region
If you remove all linked processing channels from an entity segment, no payments will be associated with it. The entity segment will also be marked as Disabled. You can choose to edit the entity segment again and link processing channels at any time.