Glossary

💻 Payments

Amount

The value involved in a transaction. Amounts can be filtered and ordered in the Transaction overview list.

Authorisation

The step where a payment is approved by the issuer and made ready for capture.

Automatic capture

A setting that captures a payment immediately after it’s authorised. If not enabled, the user must capture it manually.

Cancel

The action that releases funds by stopping an authorised transaction before it is captured. Cannot be undone.

Capture

The action that finalises an authorised transaction, allowing the funds to be collected.

Captured

A transaction status used when the payment is confirmed, and the specified amount is captured from the customer's account, ready for submission to the schemes.

Chargeback

A transaction status that means the money was returned to the cardholder after a dispute was resolved in their favour. Applies only when using Planet Acquiring.

Checkout

The customer-facing page opened through a payment link, where the customer enters payment details and completes the transaction.

Cleared

A transaction status used when the transaction has passed through the acquirer and been sent to the card schemes. Used with Planet Acquiring.

Completed

The link has received all allowed payments or expired after at least one successful payment.

Created

The date and time when a user, transaction, or payment link was created in the system.

Currency

The type of money used in a transaction, such as EUR, USD, or CHF.

Currency option

Specifies if the transaction used services like DCC (Dynamic Currency Conversion), which allows customers to pay in their own currency, or MCP (Multi-Currency Processing), which lets businesses accept payments in different currencies.

Date

A filterable field that refers to when a transaction, user, or link was created or last updated. Can be adjusted using pre-set or custom ranges.

Declined

A transaction status used when the transaction is rejected by the acquirer or payment processor.

Disputed

A transaction status that means the cardholder has contested the transaction and a dispute process is in progress. Applies only with Planet Acquiring.

Dynamic Currency Conversion (DCC)

A service that allows international customers to pay in their own currency.

E-commerce (ECOM)

Payments made through online channels, outside of physical POS environments.

Expired

The payment link expired without any successful payments.

Failed

A transaction status used when the transaction cannot be completed due to a technical issue.

Sent for funding

A transaction status that means the transaction amount was successfully transferred to the merchant's account. Only applicable with Planet Acquiring.

In Progress

A transaction status used when a payment link has at least one successful payment but is still open for more.

Merchant

A business entity that processes payments using Planet’s platform. A merchant can include multiple units within the platform.

Partial refund

A refund where only part of the original transaction amount is returned.

Partially refunded

A transaction status used when only a portion of the transaction amount has been returned to the customer.

Pay by Link

A feature that allows you to create and share payment links with customers. These links open a standardised checkout experience where customers can pay using a credit card or other payment methods.

Pay by Link flow

The lifecycle of a payment link: it can be Active, In Progress, Completed, Expired, or Cancelled.

Payment

A transaction where money is collected from the customer.

Payment link

A unique URL generated in the portal that leads to a checkout page.

Payment link expiry

A setting that defines how long a payment link remains valid.

Payment link status

Current state of a payment link: Active, In Progress, Completed, Expired, or Cancelled.

Payments allowed

How many successful payments are permitted through a single payment link.

Payout

The transfer of collected funds from Planet to the merchant’s bank account.

POS device

A physical machine used in-store to accept payments from customers.

Refund

The return of money to a customer after a payment is captured.

Refunded

A transaction status used when the full transaction amount has been returned to the customer.

Submitted

A transaction status that means the transaction was submitted to the acquirer for processing.

Token

A secure code that replaces card details for use in payments. Tokens created through the Virtual Terminal are read-only and must be stored externally.

Tokenisation

The process of generating a token that represents a card number.

Transaction

A record of a payment or refund action processed in the portal.

Transaction flow

The full journey of a transaction, from creation to payout or cancellation.

Transaction ID

A unique identifier assigned to each transaction.

Transaction status

The current stage of a transaction (e.g. Pending, Captured, Refunded).

Transaction type

The classification of a transaction as a payment, refund, or verification.

Unreferenced refund

A refund not linked to a specific transaction.

Verification transaction

A 0-value transaction used to verify a card without charging it.

🛠️ Portals & tools

API key

An authentication key used to securely connect to Planet’s APIs.

Bound

A terminal whose serial number is linked to a terminal ID. This means the device is assigned to a unit and ready to process transactions.

Checkout customisation

Options to adjust the layout of the checkout page, such as title, description, colours, and logos.

Create a payment link

Generate a new payment link with a reference, currency, amount, and optional settings.

Device name

An optional name you can assign to a terminal to help identify it more easily.

Filter users

Options to search for users by name, email, role, or date.

Firmware version

The version of the device’s embedded system.

Key name

A custom name created by you or your team to identify an API key.

Linked payments

Payments connected to a specific payment link.

Last sync

The last time a terminal synced data with the system.

Pay by Link creation flow

Step-by-step interface for creating a payment link.

Pay by Link details page

Page where you can view or edit a specific payment link.

Pay by Link filters

Options to search for links by reference, amount, date, and more.

Pay by Link main header

Top section of the details page with link overview and actions.

Pay by Link summary

Shows important info like link status, creation date, and reference.

Refresh button

Updates the data view without clearing filters or sorting selections.

Secure key

The sensitive part of the API key, used to authenticate requests. Always masked for security.

Software version

 The version of the application running on a physical terminal.

Terminal

The manufacturer of the terminal device.

Terminal brand

The manufacturer of the terminal device.

Terminal model

The commercial model name of the terminal.

Terminal serial number

A hardware identifier provided by the manufacturer. Used to track the physical terminal.

User creation flow

Steps to create a new user account in the portal.

Unbound

A terminal whose serial number is not linked to any terminal ID. This means the device is not currently assigned to a unit and cannot process transactions

Virtual Terminal

A tool to manually process card-related operations:
• Payments – Charge a card/token.
• Refunds – Issue unreferenced refunds.
• Tokenisation – Create a read-only token from card data.

🔐 Users & roles

Administrator

Has full access to all portal sections, including user management. This role cannot be changed through the portal.

Create user

Add a user by entering their name, email, role, and organisational unit. Only administrators can perform this action.

Deactivate user

Action that disables a user account and blocks edits. Only administrators can perform this action.

Reset MFA

Reconfigure multi-factor authentication for a user. Only administrators can perform this action.

Reset password

Sends a password reset email with a link to create a new one. Only administrators can perform this action.

Security section

Area in the user details page to reset passwords or MFA.

User details page

Page that shows a user’s full profile and settings.

User email address

The email associated with the user’s account. Used for login and system notifications.

User role

Defines the user's access level. Available roles:
• Administrator – Full access
• Supervisor – Operational features only
• Viewer – Read-only access
Administrator roles can only be changed by contacting support.

User status

Indicates if a user is active or inactive.

Users

People with access to the portal. Each user is assigned a role and an organisational unit.

🏢 Business structure

Inactive

A status for users or links that are no longer active or accessible.

Merchant configuration

Settings tied to each merchant, such as allowed payment methods or regional settings.

Merchant Switcher

A tool that lets you switch between different organisational units to view regional or merchant-level data.

Merchant unit

A store or entity managed by a merchant group.

Organisational unit

A location or segment within the company structure, used to assign access or scope in the portal.

Unit

A specific merchant location within a group. Used to manage data and users.

Unit ID

A unique code that identifies a unit.

Unit name

The display name of a unit shown in the portal.