LogoLogo
  • Transaction API
    • Overview
    • Authentication
    • Payment Methods
    • Integrations
      • POS (In-Store)
      • E-commerce
    • Payment Flows
      • Create a transaction
        • Examples for POS (In-Store)
          • Basic Payment Request
          • Payment request with products
          • Payment request with callback
          • Payment request with POS Data
          • SMS Payment Request
          • Email Payment Request
          • Payment request with invoice
          • Payment request with receipt generated by SensePass
          • Payment request with receipt generated by the POS
        • Examples for e-commerce
          • Basic Payment Request
          • iFrame Example
          • Payment request with products
          • Payment request with callback
          • Payment request with website custom data
          • SMS Payment Request
          • Email Payment Request
          • Payment request with invoice
          • Payment request with receipt generated by SensePass
          • Payment request with receipt generated by the e-commerce platform
      • Transaction status
      • Authorization
      • Tokenization
      • Subscription
        • Fetch a subscription
        • Update a subscription
        • Subscription callbacks
      • Cancel a pending transaction
      • Refund a transaction
      • Pay by Credit Card
      • Credit by Credit Card
      • Payment Commit
      • Update a Transaction
    • Other Flows
      • Tags Pairing
      • Receipts
      • Customer Input
      • Token Migration
      • Create Dynamic QR
    • Terminal Agent
      • Installation
      • Pairing
      • Usage
        • Synchronous Payment
        • Real-time product information update
        • Get Last Transaction Status
        • Get Device ID
    • Settlement
    • API Notifications
      • Socket.IO Websockets
      • Callback/Webhook
      • Post Message
    • Flow Charts
      • Payment Flow
      • Transaction Status Flow
    • SDK & iFrames
      • JavaScript UI SDK
        • API
        • Commit Transaction
        • Custom SDK Style
        • Simulator
        • Manual Capture (deprecated)
      • E-commerce iFrame
      • POS iFrame
      • Credit Card iFrame
    • Models
      • Receipts Model
      • Metadata Model
      • SDK Theme Config Model
      • SDK Credit Card Field Model
      • Invoice Model
      • Product Model
      • Payment Details Model
      • Receipt Notifications Model
      • Payment Commit Model
      • Confirmation Model
      • Settlement Model
      • Subscription Model
      • Transaction Page Model
      • Transaction Model
      • Customer Input Model
      • Settlement Report Model
      • Customer Shipping/Billing Details Model
      • Additional Data Model
    • SOAP and XML
      • SOAP
      • XML
    • Testing
    • Postman
  • Partner API
    • Models
      • Onboarding Model
      • Onboarding Configuration Pages
      • Onboarding Status Model
    • SDK & iFrames
      • Onboarding iFrame
    • Flows
      • Create onboarding
      • Get Onboarding Configuration Page
      • Onboarding status
Powered by GitBook
On this page
  • Advantages:
  • Synchronous payment request
  • Usage Flow:
  • Last Transaction Status
  • Usage Flow:
  • Terminal Agent Key Features

Was this helpful?

Export as PDF
  1. Transaction API

Terminal Agent

Last updated 4 months ago

Was this helpful?

Terminal Agent is a SensePass software designed to connect platforms to SensePass network with a range of EMV pinpads and to simplify the integration process, allowing for quick setup and deployment.

Terminal Agent also works as a proxy to all SensePass cloud API describes in this portal.

In addition, Terminal agent allows you to use specific API's created for the Terminal Agent software to reduce the integration time.

Advantages:

  1. Pairing of tags and EMV devices is already implemented

    Terminal Agent handles the pairing process for all types of terminals and tags using SensePass UI

  2. Storing API keys, Device ID's and EMV ID's is already implemented

    Terminal Agent stores all the credentials and authentication keys and append them automatically to all of your requests

  3. Implementing Web-sockets or Callback endpoint is already implemented

    Terminal Agent internal logic works with Socket.IO websockets securely, according to SensePass interface and returns to your platform

  4. Integrating using Terminal Agent enables you to support new features and releases without any change on your end

    Most of the new features that will be released to our API will be available to you seamlessly by updating the Terminal Agent software on the POS, without having to change one line of code on your platform

  5. Integration with the Cancel API is already implemented

    Terminal Agent detects the cancel event of the HTTP request for and calls internally to the "Cancel" API in order to revoke the pending payment request

  6. Realtime product update already implemented for EMV Pinpad and SensePass tags Terminal Agent detects product update API calls and creates a "Setup" transaction with the product information, once the POS is ready to accept a payment - an "Init" call should be sent as usual without any additional params. Terminal Agent detects the relation between the previous "Setup" transaction and makes all the API calls transparently.

  7. Terminal Agent software is already certified by SensePass

    Integration using Terminal Agent reduces most of the certifcation process for your platform

System Requirements: Operating System: Compatible with Windows 7, 8, 10, and newer versions.

Synchronous payment request

Terminal Agent expose synchronous payment request call that reduce the integration time and logics.

Usage Flow:

  1. DeviceId field is not required - Terminal agent will append it automatically

  2. Cancelling the payment request can be done using cancelling the HTTP request from #1

  3. On final result (Approve, timeout or Cancel) - you will get response to this request

Last Transaction Status

in event of error or closed connection, you can use this API to fetch the current status of the last transaction created.

Usage Flow:

  1. Call GET request to: http://localhost:8003/api/transactions/last Without any request payload

  2. DeviceId field is not required - Terminal agent will append it automatically

Terminal Agent Key Features

  • Reduces the intergation time: Pairing, cancelling request and working with websockets logics are already embeded inside terminal agent

  • Compatibility with Various Pinpads: Terminal Agent supports a wide array of EMV pinpad models and manufacturers, enhancing its utility in diverse environments.

  • Easy Integration: Designed for effortless setup, enabling quick deployment across multiple terminals.

  • Real-time Monitoring: Ensures continuous operation with live monitoring capabilities.

  • Automatic Updates: Keeps the system up-to-date with the latest features and security patches without manual intervention.

Call POST request to: Use the same schema as -

Terminal Agent expose an API to recover from network issue while using the,

Reponse will return immediately according to schema

synchronous response
Synchronous Payment API
http://localhost:8003/api/transactions/init/sync
Create a transaction
See full docs about sync payment request
Sync payment API
Transaction Status
See full docs about last transaction status API