Skip to main content

Core Concepts

Before you integrate with yetipay's APIs, it helps to understand how the platform is structured. Everything you'll work with — API keys, sites, terminals, and payments — fits into a simple hierarchy.

How it all fits together​

Merchant (your business)
 └── Site (ecommerce or in-person)
      └── Terminal (in-person only)
      └── Payment

Every payment flows through this structure. Your merchant is your business. Sites are the places or channels where you accept payments — online, at the counter, or at the table. Terminals are the physical devices (or virtual ones for testing) linked to in-person sites. And each payment is tracked with identifiers that let you reconcile, refund, and report.

Key concepts​

Merchants

Your business — the legal entity that accepts payments. API keys, configuration, and payouts all live at the merchant level.

Sites

Distinct locations or channels where payments are processed. Every payment is attributed to a site — ecommerce or in-person.

Terminals

Physical yetipay devices (or virtual ones) used for in-person payments. Each terminal is linked to an in-person site.

Payment Lifecycle

How payments flow through Yeti — authorisation, capture, refunds — and the key identifiers (pspReference, pspModificationReference) you'll see in APIs and webhooks.

Why this matters for integration​

  • API keys are scoped to your merchant. When you create a key in Basecamp, it unlocks access to all sites and terminals under that merchant.
  • The siteId is in the URL. For the ECOM API, every request includes a siteId — that's how Yeti knows where to attribute the payment and how to route it.
  • Terminals belong to sites. For Pay At Counter or Pay At Table, you target a terminal by its identifier, but the transaction settles to the site that terminal is linked to.
  • Payments carry identifiers. You'll store pspReference and pspModificationReference to reconcile webhooks, match provider reports, and handle refunds or support tickets.

Take a few minutes to read through each concept — it'll make the API docs and integration flows much easier to follow.