Skip to main content
Credits are a payment object in Omneo, not a discount or incentive. When a customer redeems a Credit, it replaces a payment method rather than reducing a price. This means Credits appear at the bottom of the checkout redemption hierarchy: Benefits → Rewards → Credits → Payment Type See Credits concept page for the business context.

​
Credit types

​
Issuing a credit to a profile

​
Reading credits for a profile

Returns a list of all credits associated with the profile including their balance, type, expiry, and status. Each credit includes an is_active field: true when the credit is issued, not expired, and has value_remaining above zero. A credit with no expires_at never expires and can still be active.

​
Filtering by active status

Use filter[active] to return only the credits a profile can spend right now, or only the ones it cannot:
filter[active]=1 returns active credits only. filter[active]=0 returns every other credit (not yet issued, expired, or with no value_remaining left). This filter combines with any other filter[...] parameter, and meta.total reflects the filtered count.

​
Reading a specific credit

​
Redeeming a credit

Credit redemption is typically handled at the point of sale or checkout and is recorded as a payment type on the transaction. Include credits as part of the payments array when creating a transaction, or handle redemption via your POS/eCommerce platform’s Credit integration with Omneo.
Content needed: full credit redemption flow via API, gift card creation and transfer workflow, multi-credit redemption in a single transaction, and currency conversion behaviour.

​
Voiding a credit

​
Gift cards

Gift Cards are a special type of Credit that can be transferred between customers. When a Gift Card is purchased, it is stored against the buyer’s profile until the recipient claims it. Unclaimed Gift Cards can be configured to revert to the purchaser after a defined period. To create a Gift Card credit and generate a virtual card number and PIN, contact your Omneo implementation team. The configuration involves Credit vendor setup specific to your POS or eCommerce platform.