Skip to main content
Before you configure your account or start building, take a few minutes to understand the core concepts that structure everything in Orbt. These building blocks - workspaces, projects, member roles, and API credentials - appear throughout the platform and the API, so a clear mental model now will save you time later.

​
Partner

A partner is a business that has signed up for an Orbt account. Partners use the Orbt API to distribute digital value to their own end users. As a partner, you load funds into your Orbt wallet and control how those funds are distributed to consumers.

​
Consumer

A consumer is an end user created by a partner. Consumers don’t sign up on Orbt directly — they are registered by you via the API or Manually on behalf of your users. Each consumer can hold one or more wallets and use their balance to redeem gift cards through the Orbt consumer experience.

​
Wallet

A wallet holds a consumer’s balance in a specific currency. A consumer can have multiple wallets. For example, one in USD and one in EUR, or one standard wallet and multiple campaign wallet. When you credit a consumer, you are adding funds to a specific wallet. All credits are drawn from your partner balance.

​
API Credentials

API keys allow external tools, services, and automation workflows to interact with your workspace programmatically. Each key is scoped to a specific workspace and can be restricted to either read-only or read-write access, so you can grant integrations only the permissions they actually need.
Treat API keys as secrets. Never commit them to source control or share them in chat. If a key is exposed, rotate it immediately from API & Security; the old key is invalidated the moment you generate a replacement.
1

Standard Wallet

A general-purpose wallet. Funds can be used to redeem any available gift card. Using the standard wallet, consumers can redeem their balances on any brand that is enabled to the account. 
2

Campaign Wallet

A wallet scoped to a specific campaign (e.g. “Employee of the Month”, “Summer Promotion”, “Christmas Gift”, “Marketing Campaign”). Funds in a campaign wallet can only be used within that campaign’s context, such as enabled brands and allocated funds.

​
Campaign

A campaign is a named promotion that scopes a wallet. For example, you might create a “Q4 Loyalty Reward” campaign and credit consumers with campaign wallets tied to it. This lets you track and control how specific budgets are distributed and spent.

​
Transaction

A transaction is any credit or debit applied to a consumer’s wallet. Every transaction requires a unique referenceId that you provide; this is your idempotency key. If you submit the same referenceId twice with the same payload, the transaction is safely deduplicated. If you reuse a referenceId with a different payload, the API will return an error.

​
Voucher / Gift card

A voucher is the digital code a consumer redeems at checkout with a brand (e.g. Amazon, Apple, Starbucks, Nintendo, Playstation, etc). Vouchers are fulfilled from Orbt’s catalog of 1,000+ brands across 150+ countries. The consumer selects and redeems vouchers themselves; as a partner, you fund the wallets; Orbt handles the fulfillment.

​
Customization

Orbt supports white-label customization per partner. You can configure your own logo, brand colors, and email templates so that the consumer-facing experience reflects your brand rather than Orbt’s. Contact your account manager to set this up.