HomeGuidesAPI Reference
Guides

Terminal Mangement


Overview

What is a Terminal?

A Terminal is a virtual POS device that allows a merchant or user to process card transactions through the EdfaPay SoftPOS system.

SAMA Compliance

Each terminal has unique identifiers provided by SAMA (Saudi Central Bank) and can be configured with specific payment methods, features, and ownership settings.


Creating a Terminal

📘

When creating a terminal, you may need to select the merchant or user (if you are setting it up on their behalf).

If you are logged in as a Merchant, the terminal will be added directly to your account.

Required Fields

Branch – Optional (used for multi-location merchants)
TSRM ID – Mandatory (6-digit identifier from SAMA)
Terminal ID – Mandatory (16-digit unique identifier)

⚠️

TSRM ID and Terminal ID must match exactly what was provided by SAMA.


Bulk Import Terminals

Instead of adding terminals one by one, you can create multiple terminals using a CSV or Excel file.

Steps

  1. Go to Terminal Options → Add Multiple Terminals → Download Template
  2. Fill in the required fields:
       • providerTid – Unique numeric terminal ID
       • trsm – Unique internal identifier
  3. Upload the file
  4. The system validates and creates terminals

Terminal Profile

📊

The Terminal Profile provides a complete overview of terminal configuration and activity.

• Transaction summary
• Total, Purchase, Refund, Reverse

🔒

This view is read-only and reflects the current state of the terminal.


Payment Methods (Card Schemes)

💳

You can enable or disable which card schemes the terminal accepts.

• American Express
• Visa
• Mastercard
• Maestro
• Mada
• UnionPay
• Discover


Terminal Features

Purchase

Standard payment transaction

Refund

Return funds to the customer

Reverse

Cancel a transaction before settlement

Authorization

Pre-authorize transactions

Void

Cancel authorized transactions

Capture

Capture authorized funds


Terminal Actions

🎯

Each terminal includes an Actions menu to manage ownership, connectivity, and configuration.

Unbind Terminal

The Unbind Terminal action disconnects the terminal from the current device.

Use Cases

• Move to another device
• Replace a damaged device
• Reassign terminal

Unbinding does not affect transactions or terminal data.


Change Terminal Owner

Allows transferring a terminal between merchants under the same partner.

When to Use

• Ownership change
• Incorrect assignment
• Reassign between merchants

Steps

  1. Open terminal Actions
  2. Select Change Terminal Owner
  3. Choose new Merchant
  4. Select Branch
  5. Confirm
⚠️

• Merchant must belong to the same partner
• Branch selection is required
• Changes apply immediately
• Historical transactions remain unchanged


Branch Assignment

🏢

Selecting the correct branch ensures:

• Accurate transaction grouping
• Proper reporting
• Correct reconciliation


Key Notes

📘

Important

Terminals are not deleted automatically
Unbinding does not remove configuration
Ownership changes do not affect past transactions
All actions are logged for audit purposes