Documentation

Merchant Create Bearer Token

This API generates a bearer token for merchant authentication. The token is used to securely authorize subsequent API requests made on behalf of the merchant

Typical Use Cases

Securing merchant API access
Session-based authentication
Token-based authorization flows

API Reference: Merchant Create Bearer Token

Merchant Add API Processor

Processor: (TSYS, First Data Omaha, First Data Bypass, Priority Payments, EPX, Postilion, Payroc, Worldpay)

This API is used to configure and associate a payment processor with a merchant account. It securely stores processor credentials and routing configuration required for transaction processing

Typical Use Cases

Onboarding merchants to specific processors
Multi-processor routing support
Processor credential management

API Reference: Merchant Add

Merchant Update

This API updates merchant profile details such as business information, contact details, or configuration settings.

Typical Use Cases

Merchant profile maintenance
Business detail updates
Configuration changes

API Reference: Merchant Update

Merchant Get

This API retrieves detailed information for a specific merchant based on the merchant identifier.

Typical Use Cases

Merchant profile viewing
Support and troubleshooting
Configuration validation

API Reference: Merchant Get Details

Merchant Delete

This API permanently removes a merchant account and its associated configurations from the system.

Typical Use Cases

Merchant offboarding
Compliance and data cleanup

API Reference: Merchant Delete

Merchant Operator Create

This API creates an operator (user) under a merchant account with assigned roles and permissions.

Typical Use Cases

Merchant staff access management
Role-based access control

API Reference: Merchant Operator Create

Sub-ISO Operator Create

This API creates an operator under a Sub-ISO account with defined access permissions.

Typical Use Cases

Sub-ISO team management
Delegated operational access

API Reference: Sub-ISO Operator Create

Merchant Status

This API retrieves the current operational status of a merchant (active, inactive, suspended, etc.).

Typical Use Cases

Merchant monitoring
Compliance checks

API Reference: Merchant Status

Merchant View

This API provides a read-only view of merchant details and configurations.

Typical Use Cases

Dashboard display
Reporting and audits

API Reference: Merchant View

Merchant List

This API returns a list of merchants with optional filtering and pagination.

Typical Use Cases

Merchant management portals
Reporting and exports

API Reference: Merchant List

Copy Parameter API

This API copies configuration parameters from one merchant, store, or EPI to another.

Typical Use Cases

Faster merchant onboarding
Configuration standardization

API Reference: Copy Parameter API

Check Credentials

This API validates provided credentials for processors, merchants, or APIs before activation.

Typical Use Cases

Credential verification
Preventing misconfiguration

API Reference: Check-Credential

Store Add

This API creates a new store location under a merchant account.

Typical Use Cases

Multi-store merchants
Location-based reporting

API Reference: Store Add

Create Ticket

This API creates a support or onboarding ticket linked to a merchant, store, or ISO.

Typical Use Cases

Issue tracking
Merchant onboarding workflows

API Reference: Create Ticket

Update Ticket (ISO)

This API updates ticket details or status from the ISO side.

Typical Use Cases

Ticket lifecycle management
ISO support operations

API Reference: Update Ticket

View Ticket

This API retrieves details of a specific ticket.

Typical Use Cases

Support tracking
Audit and history review

API Reference: View Ticket

Store Update

This API updates store-level details such as address, configuration, or status.

Typical Use Cases

Store maintenance
Configuration updates

API Reference: Store Update

Store Sync

This API synchronizes store configuration across systems or devices.

Typical Use Cases

Device configuration sync
Configuration consistency

API Reference: Store Sync

Store Delete

This API removes a store from a merchant account.

Typical Use Cases

Store closure
Data cleanup

API Reference: Store Delete

EPI Add

This API creates a new EPI (Electronic Payment Identifier) and associates it with a store or merchant.

Typical Use Cases

Device onboarding
Payment endpoint configuration

API Reference: EPI Add

EPI Activate

This API activates an EPI, enabling it to process transactions.

Typical Use Cases

Go-live activation
Device enablement

API Reference: EPI Activate

EPI Delete

This API permanently removes an EPI from the system.

Typical Use Cases

Device decommissioning

API Reference: EPI Delete

EPI Detail

This API retrieves detailed configuration and status information for a specific EPI.

Typical Use Cases

Troubleshooting
Configuration review

API Reference: EPI Detail

EPI View

This API provides a read-only view of EPI information.

Typical Use Cases

Dashboards
Reporting

API Reference: EPI View

Assign APP - EPI

This API assigns an application (APP) to a specific EPI for transaction processing.

Typical Use Cases

App-device mapping
POS enablement

API Reference: Assign APP - EPI

Fetch E-Receipt

This API retrieves electronic receipt details for a completed transaction.

Typical Use Cases

Customer receipts
Merchant records

API Reference: Fetch E-Receipt

Transaction List

This API retrieves a list of transactions with optional filters such as date range, EPI, or merchant.

Typical Use Cases

Reporting
Reconciliation

API Reference: Transaction List

EPI Last Transaction

This API retrieves the most recent transaction processed by a specific EPI.

Typical Use Cases

Device health checks
Last activity verification

API Reference: EPI Last Transaction

EPI Update

This API updates configuration details for an existing EPI.

Typical Use Cases

Parameter changes
Device reconfiguration

API Reference: EPI Update

Check EPI

This API verifies the existence and validity of an EPI.

Typical Use Cases

Pre-transaction validation
Configuration checks

API Reference: Check EPI

Sub-ISO Create

This API creates a new Sub-ISO under a parent ISO.

Typical Use Cases

ISO hierarchy management

API Reference: Sub-ISO Create

Device Parameter API

(Hardware, RCKT, Virtual Terminal)

This API manages device-level parameters for physical terminals, RCKT devices, and virtual terminals.

Typical Use Cases

Terminal configuration
Feature enablement

API Reference: Device Parameter API

EPI Status

This API retrieves the current status of an EPI (active, inactive, suspended).

Typical Use Cases

Monitoring
Operations dashboards

API Reference: EPI Status

EPI Deactivate

This API deactivates an EPI, preventing it from processing transactions.

Typical Use Cases

Temporary device disablement
Security actions

API Reference: EPI Deactivate

Fetch APP ID and APP Keys

This API retrieves application credentials required for API authentication and integration.

Typical Use Cases

App configuration
Secure integrations

API Reference: Fetch APP ID and APP Keys

Update Ticket (Merchant)

This API updates ticket details or status from the merchant side.

API Reference: Update Ticket

EPI – Generate API Keys

This API generates API keys for an EPI to enable secure communication with backend services.

Typical Use Cases

Device authentication
Secure API access

API Reference: Generating API Keys

ISO Billing Statement

This API retrieves billing and settlement statements for an ISO.

Typical Use Cases

Financial reporting
ISO reconciliation

API Reference: ISO Billing Statement

ISO Operator Create

This API creates an operator under an ISO account with assigned permissions.

API Reference: ISO Operator Create

Differential Settings – Bulk Update

This API updates differential or pricing-related settings in bulk across merchants or EPIs.