Cashless voucher redemption status file
Information
No | Item | Value | Example |
1 | File Type | alipay.intl.promotion.voucher.file.voucherUseDetail | |
2 | File Version | 2.1.0 | |
3 | Provider | Alipay | |
4 | File format | csv | |
5 | Directory | /AlipayHK/vourcher_daily/<merchantId>/<BIZ_DATE>/ | /AlipayHK/vourcher_daily/21601200345678/20210525/ |
6 | Filename | <merchantId>_ALIPAY_VOUCHER_USE_DETAIL_HKD_YYMMDD_HHMMSS.csv | 21601200345678_ALIPAY_VOUCHER_USE_DETAIL_HKD_20210525_160404.csv |
7 | Schedule | daily | |
8 | Remarks | The format of the date is YYYYMMDD. |
File body
No | Field | Type | Length | Required | Description | Sample |
1 | voucherId | string | 64 | M | Voucher ID | 2021011819050111540150009999900160350019673599 |
2 | templateId | string | 64 | M | The template of the voucher | 2020133319050111540217777888880160120030759111 |
3 | voucherType | string | 64 | M | The type of voucher | FIXED_VOUCHER |
4 | merchantId | string | 64 | M | MID of write-off merchants | 21601200345678 |
5 | transactionId | string | 64 | M | ipay transaction ID | 2021030421001004680219786774 |
6 | transactionRequestId | string | 64 | M | Merchant transaction ID | 51051001000000000002 |
7 | orderAmount | string | 10 | M | The transaction amount of fund in the order request. | 73.00 |
8 | voucherAmount | string | 10 | M | The voucher amount of fund in the order request. | 2.00 |
9 | currency | string | 3 | M | The voucher currency | HKD |
10 | paymentType | string | 1 | M | The status of voucher decrease： S: decrease successful I: increase successful | S/I |
File example
File name
21601200345678_ALIPAY_VOUCHER_USE_DETAIL_HKD_20210525_160404.csvFile content
voucherId,templateId,voucherType,merchantId,transactionId,transactionRequestId,orderAmount,voucherAmount,currency,paymentType,paymentTime
2021011819050111540150009999900160350019673599,2020133319050111540217777888880160120030759111,FIXED_VOUCHER,21601200345678,51051001000000000002,2021030421001004680219786774,73.00,2.00,HKD,S,2021-03-11 16:05:47
2021011819050111540150009999900160350019673598,2020133319050111540217777888880160120030759112,FIXED_VOUCHER,21601200345679,51051001000000000005,2021030421001004680219786894,53.00,3.00,HKD,I,2021-03-15 16:00:00