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

200 Use account.amountNet to for available amount.

{
    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

200

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

200

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

200

Request payment

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

Path Parameters

Name	Type	Description
	string

200

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

200

Cancel payment

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

Path Parameters

Name	Type	Description
	string

200