Skip to main content

Loyalty

PointsInquiry

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1CIF NumbercustomerIdCustomer unique IDStringMaximum 32 charactersConditional
2Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Total PointstotalPointsTotal PointsStringMaximum 16 characterRequired
2Available PointsavaiPointsAvailable PointsStringMaximum 16 characterRequired
3Redeemed Points of Current MonthredeemedPointsRedeemed Points of Current MonthStringMaximum 16 characterRequired
4Purged Points of Current MonthpurgedPointsPurged Points of Current MonthStringMaximum 16 characterRequired

Redemption

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1CIF NumbercustomerIdCustomer unique IDStringMaximum 32 charactersConditional
2Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
3Purchase Order NOorderNoPurchase Order NOStringMaximum 32 charactersRequired
4Goods Item CodeitemCodeGoods Item CodeStringMaximum 32 charactersOptional
5Goods Item DescitemDescGoods Item DescStringMaximum 60 charactersOptional
6Goods Item PointsitemPointsGoods Item PointsStringMaximum 16 characterOptional
7Goods Item AmountitemAmountGoods Item AmountString16,2Optional
8Goods Item QuantityitemQuantityGoods QuantityStringMaximum 8 characterOptional
9Redeemed PointsredeemedPointsRedeemed PointsStringMaximum 16 characterRequired
10Redeemed AmountredeemedAmountRedeemed AmountString16,2Required
11RemarkremarkRemarkStringMaximum 60 characterOptional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Purchase IdpurchaseIdPurchase IdStringMaximum 32 characterRequired
2Available PointsavaiPointsAvailable PointsStringMaximum 16 characterRequired

RedmptionResv

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Purchase IdpurchaseIdPurchase IdStringMaximum 32 characterRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Available PointsavaiPointsAvailable PointsStringMaximum 16 characterRequired

PointsHistory

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1CIF NumbercustomerIdCustomer unique IDStringMaximum 32 charactersConditional
2Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
3Start DatestartDateStart DateStringYYYYMMDDRequired
4End DateendDateEnd DateStringYYYYMMDDRequired
5Page SizepageSizePage SizeStringMaximum 2 characterRequired
6Page NumberpageNumPage NumberStringMaximum 8 characterRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Total RecordstotalRecordTotal RecordsStringMaximum 8 characterRequired
2Total PagestotalPageTotal PagesStringMaximum 8 characterRequired
3Record NumberrecordNumRecord NumberStringMaximum 8 characterRequired
4Record ListrecordListeach element is a complex element that includes the following sub-elements:
1sub-elements of each element in the listprogramCodeLoyalty Program CodeStringMaximum 4 characterRequired
2mtnTypeLoyalty Maintenance TypeString Maximum 1 charactersRequired
3pointspointsString Maximum 16 charactersOptional
4effectiveDateEffective DateString 8 charactersRequiredYYYYMMDD
5purgedDatePurged DateString 8 charactersRequiredYYYYMMDD
6cardNumberCard NumberStringMaximum 19 characterOptional
7tranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
8tranAmountTransaction AmountString16,2Required

RedemptionHistory

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1CIF NumbercustomerIdCustomer unique IDStringMaximum 32 charactersConditional
2Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
3Start DatestartDateStart DateStringYYYYMMDDRequired
4End DateendDateEnd DateStringYYYYMMDDRequired
5Page SizepageSizePage SizeStringMaximum 2 characterRequired
6Page NumberpageNumPage NumberStringMaximum 8 characterRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Total RecordstotalRecordTotal RecordsStringMaximum 8 characterRequired
2Total PagestotalPageTotal PagesStringMaximum 8 characterRequired
3Record NumberrecordNumRecord NumberStringMaximum 8 characterRequired
4Record ListrecordListeach element is a complex element that includes the following sub-elements:
1sub-elements of each element in the listpurchaseIdPurchase IdStringMaximum 32 characterRequired
2tranDateTransaction DateString 8 charactersRequiredYYYYMMDD
3redeemedPointsRedeemed PointsStringMaximum 16 characterRequired
4redeemedAmountRedeemed AmountString16,2Required
5orderNoPurchase Order NOStringMaximum 32 charactersRequired

RedemptionDetail

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Purchase IdpurchaseIdPurchase IdStringMaximum 32 characterRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Purchase Order NOorderNoPurchase Order NOStringMaximum 32 charactersRequired
2Goods Item CodeitemCodeGoods Item CodeStringMaximum 32 charactersOptional
3Goods Item DescitemDescGoods Item DescStringMaximum 60 charactersOptional
4Goods Item PointsitemPointsGoods Item PointsStringMaximum 16 characterOptional
5Goods Item AmountitemAmountGoods Item AmountString16,2Optional
6Goods Item QuantityitemQuantityGoods QuantityStringMaximum 8 characterOptional
7Redeemed PointsredeemedPointsRedeemed PointsStringMaximum 16 characterRequired
8Redeemed AmountredeemedAmountRedeemed AmountString16,2Required
9RemarkremarkRemarkStringMaximum 60 characterOptional