Loyalty
PointsInquiry
Request:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | CIF Number | customerId | Customer unique ID | String | Maximum 32 characters | Conditional | |
| 2 | Card Token Number | cardToken | Card Token Number | String | Maximum 19 characters | Conditional |
Response:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | Total Points | totalPoints | Total Points | String | Maximum 16 character | Required | |
| 2 | Available Points | avaiPoints | Available Points | String | Maximum 16 character | Required | |
| 3 | Redeemed Points of Current Month | redeemedPoints | Redeemed Points of Current Month | String | Maximum 16 character | Required | |
| 4 | Purged Points of Current Month | purgedPoints | Purged Points of Current Month | String | Maximum 16 character | Required |
Redemption
Request:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | CIF Number | customerId | Customer unique ID | String | Maximum 32 characters | Conditional | |
| 2 | Card Token Number | cardToken | Card Token Number | String | Maximum 19 characters | Conditional | |
| 3 | Purchase Order NO | orderNo | Purchase Order NO | String | Maximum 32 characters | Required | |
| 4 | Goods Item Code | itemCode | Goods Item Code | String | Maximum 32 characters | Optional | |
| 5 | Goods Item Desc | itemDesc | Goods Item Desc | String | Maximum 60 characters | Optional | |
| 6 | Goods Item Points | itemPoints | Goods Item Points | String | Maximum 16 character | Optional | |
| 7 | Goods Item Amount | itemAmount | Goods Item Amount | String | 16,2 | Optional | |
| 8 | Goods Item Quantity | itemQuantity | Goods Quantity | String | Maximum 8 character | Optional | |
| 9 | Redeemed Points | redeemedPoints | Redeemed Points | String | Maximum 16 character | Required | |
| 10 | Redeemed Amount | redeemedAmount | Redeemed Amount | String | 16,2 | Required | |
| 11 | Remark | remark | Remark | String | Maximum 60 character | Optional |
Response:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | Purchase Id | purchaseId | Purchase Id | String | Maximum 32 character | Required | |
| 2 | Available Points | avaiPoints | Available Points | String | Maximum 16 character | Required |
RedmptionResv
Request:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | Purchase Id | purchaseId | Purchase Id | String | Maximum 32 character | Required |
Response:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | Available Points | avaiPoints | Available Points | String | Maximum 16 character | Required |
PointsHistory
Request:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | CIF Number | customerId | Customer unique ID | String | Maximum 32 characters | Conditional | |
| 2 | Card Token Number | cardToken | Card Token Number | String | Maximum 19 characters | Conditional | |
| 3 | Start Date | startDate | Start Date | String | YYYYMMDD | Required | |
| 4 | End Date | endDate | End Date | String | YYYYMMDD | Required | |
| 5 | Page Size | pageSize | Page Size | String | Maximum 2 character | Required | |
| 6 | Page Number | pageNum | Page Number | String | Maximum 8 character | Required |
Response:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | Total Records | totalRecord | Total Records | String | Maximum 8 character | Required | |
| 2 | Total Pages | totalPage | Total Pages | String | Maximum 8 character | Required | |
| 3 | Record Number | recordNum | Record Number | String | Maximum 8 character | Required | |
| 4 | Record List | recordList | each element is a complex element that includes the following sub-elements: | ||||
| 1 | sub-elements of each element in the list | programCode | Loyalty Program Code | String | Maximum 4 character | Required | |
| 2 | mtnType | Loyalty Maintenance Type | String | Maximum 1 characters | Required | ||
| 3 | points | points | String | Maximum 16 characters | Optional | ||
| 4 | effectiveDate | Effective Date | String | 8 characters | Required | YYYYMMDD | |
| 5 | purgedDate | Purged Date | String | 8 characters | Required | YYYYMMDD | |
| 6 | cardNumber | Card Number | String | Maximum 19 character | Optional | ||
| 7 | tranCurrency | Transaction Currency | String | Maximum 3 character | Required | ||
| 8 | tranAmount | Transaction Amount | String | 16,2 | Required |
RedemptionHistory
Request:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | CIF Number | customerId | Customer unique ID | String | Maximum 32 characters | Conditional | |
| 2 | Card Token Number | cardToken | Card Token Number | String | Maximum 19 characters | Conditional | |
| 3 | Start Date | startDate | Start Date | String | YYYYMMDD | Required | |
| 4 | End Date | endDate | End Date | String | YYYYMMDD | Required | |
| 5 | Page Size | pageSize | Page Size | String | Maximum 2 character | Required | |
| 6 | Page Number | pageNum | Page Number | String | Maximum 8 character | Required |
Response:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | Total Records | totalRecord | Total Records | String | Maximum 8 character | Required | |
| 2 | Total Pages | totalPage | Total Pages | String | Maximum 8 character | Required | |
| 3 | Record Number | recordNum | Record Number | String | Maximum 8 character | Required | |
| 4 | Record List | recordList | each element is a complex element that includes the following sub-elements: | ||||
| 1 | sub-elements of each element in the list | purchaseId | Purchase Id | String | Maximum 32 character | Required | |
| 2 | tranDate | Transaction Date | String | 8 characters | Required | YYYYMMDD | |
| 3 | redeemedPoints | Redeemed Points | String | Maximum 16 character | Required | ||
| 4 | redeemedAmount | Redeemed Amount | String | 16,2 | Required | ||
| 5 | orderNo | Purchase Order NO | String | Maximum 32 characters | Required |
RedemptionDetail
Request:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | Purchase Id | purchaseId | Purchase Id | String | Maximum 32 character | Required |
Response:
| Data Element | Field Name | Description | Format | Length | M/O | Remark | |
| 1 | Purchase Order NO | orderNo | Purchase Order NO | String | Maximum 32 characters | Required | |
| 2 | Goods Item Code | itemCode | Goods Item Code | String | Maximum 32 characters | Optional | |
| 3 | Goods Item Desc | itemDesc | Goods Item Desc | String | Maximum 60 characters | Optional | |
| 4 | Goods Item Points | itemPoints | Goods Item Points | String | Maximum 16 character | Optional | |
| 5 | Goods Item Amount | itemAmount | Goods Item Amount | String | 16,2 | Optional | |
| 6 | Goods Item Quantity | itemQuantity | Goods Quantity | String | Maximum 8 character | Optional | |
| 7 | Redeemed Points | redeemedPoints | Redeemed Points | String | Maximum 16 character | Required | |
| 8 | Redeemed Amount | redeemedAmount | Redeemed Amount | String | 16,2 | Required | |
| 9 | Remark | remark | Remark | String | Maximum 60 character | Optional |