VendorTerminalsApi

All URIs are relative to https://business.apis.kesk.app/v1

Method	HTTP request	Description
cancelTerminalPayment	POST /vendors/`{vendor_id}`/terminals/payments/`{payment_id}`/cancel	Cancel a pending payment
createTerminalPayment	POST /vendors/`{vendor_id}`/terminals/`{terminal_id}`/payments	Create a payment on a terminal
deactivateVendorTerminal	DELETE /vendors/`{vendor_id}`/terminals/`{terminal_id}`	Deactivate a terminal
discoverVendorTerminals	POST /vendors/`{vendor_id}`/terminals/discover	Discover available terminals from a provider
getTerminalPayment	GET /vendors/`{vendor_id}`/terminals/payments/`{payment_id}`	Get payment status
getVendorTerminal	GET /vendors/`{vendor_id}`/terminals/`{terminal_id}`	Get a specific terminal
listTerminalPayments	GET /vendors/`{vendor_id}`/terminals/payments	List payment history
listVendorTerminals	GET /vendors/`{vendor_id}`/terminals	List all terminals for a vendor
refundTerminalPayment	POST /vendors/`{vendor_id}`/terminals/payments/`{payment_id}`/refund	Refund a completed payment
registerVendorTerminal	POST /vendors/`{vendor_id}`/terminals	Register a new terminal
updateVendorTerminal	PUT /vendors/`{vendor_id}`/terminals/`{terminal_id}`	Update a terminal

cancelTerminalPayment

TerminalPaymentResponse cancelTerminalPayment(vendor_id, payment_id)

Cancel a pending payment

Cancels a payment that has been sent to the terminal but not yet completed. Cannot cancel payments that have already succeeded or failed.

Parameters

Name	Type	Description	Notes
vendor_id	Long		[default to null]
payment_id	Long		[default to null]

Return type

TerminalPaymentResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

createTerminalPayment

TerminalPaymentResponse createTerminalPayment(vendor_id, terminal_id, CreateTerminalPaymentRequest)

Create a payment on a terminal

Initiates a payment request on the specified terminal. The terminal will prompt the customer to present their card. Poll the payment status endpoint to track the payment progress.

Parameters

Name	Type	Notes
vendor_id	Long	[default to null]
terminal_id	Long	[default to null]
CreateTerminalPaymentRequest	CreateTerminalPaymentRequest

Return type

TerminalPaymentResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

deactivateVendorTerminal

MessageResponse deactivateVendorTerminal(vendor_id, terminal_id)

Deactivate a terminal

Deactivates a terminal, preventing it from accepting payments. The terminal can be reactivated later by updating its status.

Parameters

Name	Type	Description	Notes
vendor_id	Long		[default to null]
terminal_id	Long		[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

discoverVendorTerminals

List discoverVendorTerminals(vendor_id, DiscoverTerminalsRequest)

Discover available terminals from a provider

Queries the terminal provider API to find available terminals that can be registered to the vendor. Returns a list of discovered terminals with their registration status.

Parameters

Name	Type	Description	Notes
vendor_id	Long		[default to null]
DiscoverTerminalsRequest	DiscoverTerminalsRequest

Return type

List

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

getTerminalPayment

TerminalPaymentResponse getTerminalPayment(vendor_id, payment_id)

Get payment status

Retrieves the current status and details of a terminal payment. Use this to poll for payment completion after creating a payment.

Parameters

Name	Type	Description	Notes
vendor_id	Long		[default to null]
payment_id	Long		[default to null]

Return type

TerminalPaymentResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getVendorTerminal

TerminalResponse getVendorTerminal(vendor_id, terminal_id)

Get a specific terminal

Retrieves detailed information about a specific terminal by its ID.

Parameters

Name	Type	Description	Notes
vendor_id	Long		[default to null]
terminal_id	Long		[default to null]

Return type

TerminalResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

listTerminalPayments

PaginatedResponse_TerminalPaymentResponse listTerminalPayments(vendor_id, terminal_id, status, from_date, to_date, limit, cursor)

List payment history

Retrieves a paginated list of terminal payments for the vendor. Can be filtered by terminal, status, and date range.

Parameters

Name	Type	Description	Notes
vendor_id	Long		[default to null]
terminal_id	Long	Filter by terminal ID	[optional] [default to null]
status	String	Filter by payment status	[optional] [default to null]
from_date	Long	Filter by start date (Unix timestamp)	[optional] [default to null]
to_date	Long	Filter by end date (Unix timestamp)	[optional] [default to null]
limit	Integer	Maximum number of results (default: 20)	[optional] [default to null]
cursor	String	Pagination cursor	[optional] [default to null]

Return type

PaginatedResponse_TerminalPaymentResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

listVendorTerminals

List listVendorTerminals(vendor_id, location_id, payment_method_id, status)

List all terminals for a vendor

Retrieves a list of all payment terminals registered to the vendor. Can be filtered by location, payment method/provider, and status.

Parameters

Name	Type	Description	Notes
vendor_id	Long		[default to null]
location_id	Long	Filter by location ID	[optional] [default to null]
payment_method_id	Long	Filter by payment method ID (e.g., Stripe Terminal, Adyen Terminal)	[optional] [default to null]
status	TerminalStatusEnum	Filter by terminal status	[optional] [default to null] [enum: pending_registration, active, offline, busy, maintenance, deactivated]

Return type

List

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

refundTerminalPayment

TerminalRefundResponse refundTerminalPayment(vendor_id, payment_id, RefundTerminalPaymentRequest)

Refund a completed payment

Initiates a refund for a payment that has been completed successfully. Supports partial refunds if an amount is specified. Full refund is processed if no amount is provided.