Centara
  • Introduction to Centara
  • Getting started with Centara
    • Software and hardware requirements
    • getCentara.exe
    • Install Centara Server
    • Centara Configuration
      • RDM overview
      • Create organization structure
      • General settings
      • Layouts and visual components
        • Creating layouts
        • Assigning layouts in configuration
        • Populating layouts with components
        • Applying functionalty to buttons
        • UI component reference
      • Hardware
        • OPOS installation
          • Epson OPOS
        • Centara server configuration
      • POS Receipts
        • Receipt parts
        • Receipt Directives
          • Formatting directives
          • General directives
          • Hospitality directives
          • Fiscal Printers directives
          • Tender slip directives
        • Receipt logo
        • Receipt template
          • Special formatting
      • POS operators and permissions
        • Create operators and permissions
      • Tenders
      • Other configuration
        • Customer configuration
        • Cash management
          • Setting up cash management
          • Balance report
        • Suspend / retrieve
        • Search
          • Applying customer search
          • Applying product search
            • Style search
            • Stock search
          • Applying transaction search
        • Custom settings
    • Install Centara POS
      • Alternative database configurations
      • Centara Licensing
    • Features
      • Conditional sub-layouts
      • Out of stock warning
  • User guides
    • POS User Guide
      • Operator sign on / off
      • Layouts
      • Selling products
      • Paying for products
      • Voiding
      • Customers
      • Suspend / retrieve
      • Cash management
    • Discount Offer module
      • Getting started
      • Basic discounts
      • Package deals
      • Seasonal offers
      • Miscellaneous
      • Working with the filters
      • Making changes to the discounts
      • Time restrictions
      • Selectors
      • Layered discounts
      • Audit Log
      • Glossary of Terms
    • Loyalty system
      • System overview
      • Creating organization stucture
      • Working with loyalty data
        • General handling
          • Adding loyalty data
        • Giftcards
          • Adding gift card data
        • Store credit
          • Instrument handling
        • Coupons
          • How to setup alphanumeric offer coupon
      • Connecting Centara to Loyalty
      • View loyalty data on POS
      • Loyalty operations
    • Snippet manager
  • Integrations
    • Sentry.io
    • Acumatica
      • Acumatica installation
      • Acumatica Connector
        • Customer creation
        • Cashier Groups
        • Avalara Configuration
        • Common configuration errors
        • General inquiries
  • Development
    • APIs
      • External orders
      • Item API
      • Loyalty API
        • Gift cards
        • Loyalty cards
        • Store credit
    • GraphQL
    • XVal
      • XVal List comprehensions
      • XVal operators
      • XVal examples
      • XVal usage
      • XVal testing
  • References
    • Data processes
      • XVal Library
      • Data process examples
    • POS macros
  • FAQ
    • Centara Server
      • Installation
      • Maintenance
    • Centara POS
Powered by GitBook
On this page
  • Retrieve gift card status
  • Issue pre-issued gift card
  • Issue live-printed gift card
  • Un-issue gift card
  • Request payment
  • Commit payment
  • Cancel payment

Was this helpful?

  1. Development
  2. APIs
  3. Loyalty API

Gift cards

Retrieve gift card status

GET https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/giftcards/:giftCardNumber

Retrieve issue status and available amounts for gift cards

Path Parameters

Name
Type
Description

giftCardNumber

string

The gift card number to query

loyaltyGroup

string

The loyalty system ID to query

{
    giftCardId: string,
    created?: DateTime,
    expiryDate?: DateTime,
    startDate?: DateTime,
    seriesNumber: string,
    account: {
        amountNet: number,
        amountOriginal: number,
        amountFloor: number,
        amountAuthorized: number
    },
    customer: CustomerData
}

Issue pre-issued gift card

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/giftcards/:giftCardNumber/_issue

Use this method for merchants that have pre-printed and pre-numbered gift cards.

Path Parameters

Name
Type
Description

loyaltyGroup

string

The loyalty system ID to query

Issue live-printed gift card

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/giftCardSeries/:giftCardSeriesNumber/giftcards/_issue

Use this method for merchants that have gift cards that are not pre-numbered.

Path Parameters

Name
Type
Description

loyaltyGroup

string

The loyalty system ID to query

Un-issue gift card

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/giftcards/:instrumentNumber/_unissue

This operation undoes a gift card issue operation. It can only be used when no financial operations have been performed on the giftcard.

Path Parameters

Name
Type
Description

string

Request payment

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/giftcards/:giftCardNumber/_pay

Path Parameters

Name
Type
Description

string

Payment request must be committed to take full effect or be canceled.

Commit payment

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/giftcards/:giftCardNumber/authorizations/:authCode/_commit

Path Parameters

Name
Type
Description

string

Cancel payment

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/instruments/:instrumentId/authorizations/:authCode/_cancel

Path Parameters

Name
Type
Description

string

PreviousLoyalty APINextLoyalty cards

Last updated 5 years ago

Was this helpful?