> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Working with Credits

> Issuing, reading, and redeeming Omneo Credits via the API.

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](/concepts/commerce/credits) for the business context.

## Credit types

| Type                   | Description                                                                      |
| ---------------------- | -------------------------------------------------------------------------------- |
| **Store Credit**       | Issued in exchange for a returned product                                        |
| **Promotional Credit** | Issued from a marketing budget (e.g., welcome credit, loyalty milestone)         |
| **Gift Card**          | Purchased by a customer as a payment instrument for themselves or another person |

## Issuing a credit to a profile

```shell theme={null}
curl -X POST https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/credits \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 25.00,
    "type": "promotional",
    "expires_at": "2026-01-01 00:00:00",
    "note": "Welcome credit — new member"
  }'
```

## Reading credits for a profile

```shell theme={null}
GET /api/v3/profiles/{profileId}/credits
```

Returns a list of all credits associated with the profile including their balance, type, expiry, and status.

## Reading a specific credit

```shell theme={null}
GET /api/v3/profiles/{profileId}/credits/{creditId}
```

## 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.

<Note>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.</Note>

## Voiding a credit

```shell theme={null}
curl -X PUT https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/credits/{creditId} \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "is_void": true
  }'
```

## 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.