API
8. Voucher Balance
Description : Voucher balance API is used to get the list of member’s reward or voucher.URL : https://sandbox.goodie.id/api-rest/point-transaction/redemption/voucher
Method : GET
Header :
| No | Key | Value | Requirement | Description |
|---|---|---|---|---|
| 1 | Content-type | application/x-www-form-urlencoded | M | Security Header |
| 2 | authToken | String | M | authentication |
| 3 | deviceUniqueId | String | M | Device Id |
Request Params :
| No | Parameter | Value | Requirement | Description |
|---|---|---|---|---|
| 1 | voucherBalanceId | String | O | User’s Id |
| 2 | memberId | String | M | Member’s Id |
| 3 | merchantId | String | M | Id of the merchant |
| 4 | orderBy | Int | M | Voucher’s order by |
| 5 | orderType | Int | M | Voucher’s order type |
| 6 | nRecords | Int | M | Voucher’s record |
| 7 | page | Int | M | Voucher’s page |
Response :
| No | Parameter | Value | Description |
|---|---|---|---|
| 1 | listVoucherBalance | ||
| 2 | voucherBalanceId | String | Voucher balance id |
| 3 | productName | String | Product name |
| 4 | productImage | String | Product Image |
| 5 | voucherId | String | Voucher id |
| 6 | voucherCode | String | Voucher code |
| 7 | amountValue | Integer | Voucher’s amount value |
| 8 | percentageValue | Integer | Voucher percentage value |
| 9 | expiredDate | Date | Voucher expired date Format : YYYY-MM-DD |
| 10 | redeemDate | Date | Voucher redeem date |
| 11 | redeemStore | String | Voucher redeem store |
| 12 | Status | String | Voucher status |
| 13 | voucherBalanceId | String | Voucher balance id |
| 14 | productName | String | Voucher’s product name |
| 15 | productImage | String | Voucher’s product image |
| 16 | voucherId | String | Voucher Id |
| 17 | voucherCode | String | Voucher code |
| 18 | amountValue | Integer | Value transaction ( fix amount) |
| 19 | percentageValue | Integer | Value transaction ( percentage ) |
| 20 | expireDate | Date | Voucher’s expired date |
| 21 | redeemDate | Date | Voucher’s redeem date |
| 22 | Status | String | Voucher status |
| 23 | recordInfo | ||
| 24 | totalRecords | Integer | Voucher’s total record |
| 25 | Page | Integer | Voucher’s page |
| 26 | nRecords | Integer | Voucher’s record in page |
| 27 | abstractResponse | ||
| 28 | responseStatus | String | See details** |
| 29 | responseMessage | String | See details** |
JSON Format :