1. Cloud Terminal API
Kushki Docs
English
  • Español
  • English
  • Home
  • Quick Start
    • Frequently Asked Questions
    • Moving to Production
    • Policy for Important API Changes
    • Test Data
    • Error Codes
    • Latest Features
  • Payment Glossary
    • Payments Glossary
  • One-time card payments (Online)
    • Supported card brands
    • Functionalities by business model
    • How do third party commissions work?
    • Integration guide Third Party Commissions
    • Network Tokens
    • One-step Payments
      • How do Card Payments Work?
      • Accept a Card Payment
      • Direct charge (without token)
      • Accept One-Time Payments with OTP
      • OTP Authentication Error Codes
      • Error codes for single card payments
    • Two-steps Payments
      • How do single payments with authorization and capture work?
      • Receive payments with authorization and capture
    • Refunds
      • Returns, cancellations, and refunds
    • 3DS Authentication
      • Introduction to 3DS
      • 3DS API integration
      • 3DS integration with kushki.js library
      • 3DS API integration plus kushki.js library
      • 3DS Error Codes
    • Apple Pay Payments
      • Apple Pay Configuration
      • Apple Pay Sandbox testing
  • Recurring Card Payments (Online)
    • Functionalities by business model
    • External subscriptions to Kushki
    • Authenticate your subscriptions with 3DS
    • Accept one-click payments with 3DS
    • Error codes in recurring charges
    • Apple Pay for Subscriptions
    • Scheduled payments
      • How do Credit or Debit Card Payment Recurring Charges Work?
      • Create a recurring charge
      • Manage your Scheduled Charges
    • OneClick Payments
      • Accepting One-Click Payments
      • How do OneClick payments with authorization and capture work?
      • Receive one-click payments with authorization and capture
  • Card-present payments
    • Card present payments
    • Accept card present payments
    • Test data
    • Webhooks for card present
    • Cloud Terminal API
      • Cloud terminal API overview
      • Take payments
      • Cancel a payment request
      • Check the status of a payment request
      • How to print a customized ticket?
    • App-to-app
      • App-to-app overview
      • Take payments
    • Terminal SDK
      • Terminal SDK Introduction
      • Take payments
    • Raw card-present API
      • Raw card-present API overview
      • Cryptographic key exchange
      • Sample script to encrypt information
      • Take Payments
      • Frequently Asked Questions
      • Error codes for card-present transactions
    • Transactions
      • Transactions
      • Cancel payments
    • Kushki One
      • First Steps
      • Autenticación y Cifrado de Requests
      • Accept payments with Kushki One
      • Amount Format
      • Async services and webhooks
      • Printing on SmartPOS terminal
      • Unified Error Catalog — Kushki ONE Connect
    • Kushki One Payment App
      • Overview
      • Process a payment
      • Split payment on the terminal
      • Refunds and PreAuth & Capture
      • Review Your Transactions
      • Terminal Setup
  • Wire Transfers
    • How do Payments by Wire Transfers Work?
    • Banks and transaction details for bank transfer payments
    • Receive Wire Transfers
    • Check the Status of a Transaction
  • Money Disbursement
    • Wire Transfer
      • How Does a Payment Distribution by Wire Transfer Work?
      • Payment Distribution to Bank Accounts
      • Error codes for transfer dispersions
  • Payment Links
    • Smartlinks
  • Plugins
    • Shopify
      • Shopify
      • Plugin Operation
    • VTEX
      • VTEX Integration Guide
  • Payment forms and buttons
    • Kajita
      • How Does it Work?
      • Payment Kajitas
    • Payment Button
      • Overview
      • Generate a payment button
  • Branch Offices Management
    • How to Onboard Submerchants via API
  • Notifications
    • Webhooks
    • Good Practices
    • Check your Webhooks
    • One-time Payments Webhooks
      • Webhook for One-Time Payments made with a card
      • Webhook for One-Time Payments by Wire Transfer
      • Webhook for One-Time Payments in Cash
    • Recurring Payments Webhooks
      • Webhook for Recurring Payments Made with Card
    • Payment Distribution Webhooks
      • Webhook for payment disbursement through wire transfer
    • Payment button Webhooks
      • Webhooks with Payment Button
    • Smartlinks Webhooks
      • Webhooks with Smartlinks
    • Refunds Webhooks
      • Webhook for Voids and Refunds
      • Chargeback Webhooks
HomeMexico 🇲🇽
Ecuador 🇪🇨Chile 🇨🇱Colombia 🇨🇴Peru 🇵🇪
HomeMexico 🇲🇽
Ecuador 🇪🇨Chile 🇨🇱Colombia 🇨🇴Peru 🇵🇪
Status
Soporte / Support
English
  • Español
  • English
  1. Cloud Terminal API

Cloud terminal API overview

Product in beta version 🔐👨‍
We are working on our beta version. Stay tuned for its official release! You can also contact your account manager for more information.
Cloud Terminal API allows you to easily and securely integrate an Ultra or Ultra P terminal with your point of sale (POS) system through a Rest API. With this integration, you can perform sales or cancellation operations.

Features#

Terminals#

Below is the list of readers supported by Cloud Terminal API integrations:
Ultra
Ultra P

Operations#

These are the operations available for integrations through Cloud Terminal API:
Sale
Tipping
Deferred payments
Transaction search
Voids and refunds
Print a customized ticket

Supported card brands#

The following card networks and brands are accepted through Cloud Terminal API integrations:
Visa
Mastercard
Carnet
American Express
Sodexo
Sí Vale
Edenred

Requirements#

Before you can perform an integration, you must meet the following requirements:
Create a test account.
Have a compatible and configured test terminal.
Have the payment application installed and updated on the terminal. Minimum application version: 4.3.26.
Stable internet connection.
Allow communication with our external services through firewalls and similar services.

Environments#

Test any adjustments to your system in a dev development environment. environment. Remember that no real transactions will be processed in this environment.
You can switch to the live environment to process real transactions when ready.
EnvironmentBase url
devhttps://kushkicollect.billpocket.dev
livehttps://kushkicollect.billpocket.com

Flow#

Learn more about the step-by-step payment process through Cloud Terminal API.
Cloud terminal API Flow

Payment Request#

During this stage of the flow:
1.
Your point of sale system is responsible for making a request to the Kushki API. You must send the request with the payment configuration that will appear in the payment application on the terminal.
2.
The Kushki API receives the request with the payment information for processing.
3.
The API returns a response to the request indicating the status.
4.
If the request is correct, the payment application is displayed with the configuration sent to the terminal.
Remember that for a terminal to be able to receive requests it must be in Integration Mode, be turned on and have a stable internet connection.

Payment process#

During this stage of the flow:
1.
The customer enters the payment information in the terminal.
2.
The terminal is responsible for reading, encrypting and sending the payment information to Kushki to be processed.
3.
Kushki sends a webhook with the result of the operation.
4.
The flow continues according to the result of the operation.
Accept payments
Accept payments with a POS terminal from your point of sale through Cloud terminal API.
Transactions
Get the list of transactions with information relevant to your operations.
Modificado en 2026-10-14 19:44:10
Anterior
Cloud Terminal API
Siguiente
Take payments
Built with