REST API v1

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

Use v1 or v2 based on what your integration supports. Both versions are available.

View the full interactive API reference

Overview

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

All endpoints require Basic Auth.

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

Endpoints

Method	Path	Description
GET	/pac/terminals	List all connected terminals
GET	/pac/terminals/{tpi}	Get a specific terminal
POST	/pac/terminals/{tpi}/transactions	Start a transaction
GET	/pac/terminals/{tpi}/transactions/{requestId}	Poll transaction status
DELETE	/pac/terminals/{tpi}/transactions/{requestId}	Cancel a transaction
POST	/pac/terminals/{tpi}/reports	Request a report
GET	/pac/terminals/{tpi}/reports/{requestId}	Retrieve report results

Transaction Types

Type	Description
SALE	Standard sale transaction
REFUND	Refund transaction
DUPLICATE	Duplicate of a previous transaction