Skip to main content

REST API v2

Documentation for the yetipay Pay at Counter REST API (v2).

info

REST API v2 offers additional transaction types and improved APIs. Use v2 or v1 based on what your integration supports. See What changed from v1 below.

View the full interactive API reference

Overview

The PAC REST API v2 allows POS systems to initiate and manage card transactions on yetipay terminals.

All endpoints require Basic Auth and Software-House-Id / Installer-Id headers.

Base URL: https://connect.yeti.host

Endpoints

MethodPathDescription
GET/pac/terminalsList all connected terminals
GET/pac/terminals/{tid}Get a specific terminal
POST/pac/terminals/{tid}/transactionsStart a transaction
GET/pac/terminals/{tid}/transactions/{requestId}Poll transaction status
DELETE/pac/terminals/{tid}/transactions/{requestId}Cancel a transaction
POST/pac/terminals/{tid}/reportsRequest a report
GET/pac/terminals/{tid}/reports/{requestId}Retrieve report results

Transaction Types

TypeDescription
SALEStandard sale transaction
REFUNDRefund transaction
DUPLICATEDuplicate of a previous transaction
PRE_AUTHPre-authorization hold
COMPLETIONCompletion of a pre-auth
ACCOUNT_VERIFICATIONVerify card without charging

What changed from v1

v2 introduces several improvements over v1:

  • New transaction types: PRE_AUTH, COMPLETION, and ACCOUNT_VERIFICATION for pre-authorisation and card verification flows.
  • Updated identifiers: Terminal identifiers use tid instead of tpi in path parameters.
  • Required headers: Software-House-Id and Installer-Id headers are required for traceability.
  • Improved API design: Clearer request/response schemas and error handling.