Loyalty cards

Get loyalty card

GET https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/loyaltycards/:loyaltyCardNumber

Path Parameters

Name	Type	Description
	string

200

{
    loyaltyCardId: string,
    created?: Date,
    expiryDate?: Date,
    startDate?: Date,
    seriesNumber: string,
    account: {
        amountNet: number,
        amountOriginal: number,
        amountFloor: number,
        amountAuthorized: number 
    },
    customer: CustomerData,
    statusCode: 0 = New | 1 = Open | 2 = Closed | 4 = Canceled
}

Issue loyalty card

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/loyaltycards/:loyaltyCardNumber/_issue

Path Parameters

Name	Type	Description
	string

200

{
    loyaltyCardId: string,
    created?: Date,
    expiryDate?: Date,
    startDate?: Date,
    seriesNumber: string,
    account: {
        amountNet: number,
        amountOriginal: number,
        amountFloor: number,
        amountAuthorized: number 
    },
    customer: CustomerData,
    statusCode: 0 = New | 1 = Open | 2 = Closed | 4 = Canceled
}

Un-issue loyalty card

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/loyaltycards/:loyaltyCardNumber/_unissue

Path Parameters

Name	Type	Description
	string

200

{
    loyaltyCardId: string,
    created?: Date,
    expiryDate?: Date,
    startDate?: Date,
    seriesNumber: string,
    account: {
        amountNet: number,
        amountOriginal: number,
        amountFloor: number,
        amountAuthorized: number 
    },
    customer: CustomerData,
    statusCode: 0 = New | 1 = Open | 2 = Closed | 4 = Canceled
}

Request payment

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/loyaltycards/:loyaltyCardNumber/_pay

Request a payment of the given amount. The request may be approved, denied, or partially approved for a lower amount.

Path Parameters

Name	Type	Description
loyaltyCardNumber	string	The loyalty card to request payment from
loyaltyGroup	string	The loyalty group ID

Request Body

Name	Type	Description
workstationData	object	{ storeId?: number, workstationId?: number, operatorId?: string, transactionId: Guid, reason: string }
amount	number	The amount to request

200

{
    instrumentId: string, // the loyalty card ID
    seriesId: string,
    authCode: string, // use this to commit or cancel
    amount: number,   // check the actual approved amount here
    slips: {
        name: string,
        slipText: string
    }[],
    status: 0 = approved | 1 = committed | 2 = cancelled
}

Cancel payment

POST https://centara.online/loyalty/api/v1/pos/loyaltyGroups/:loyaltyGroup/merchant/:merchantId/loyaltycards/:loyaltyCardNumber/_voidPayment

Path Parameters

Name	Type	Description
	string

200

Guid