Viewing in detail the expiring cards file of a shop
- A header record containing task information.
- A variable number of records containing information about tokens and possible recurrences close to expiration.
- A trailer record that allows to verify the consistency of the transmitted file.
For applicable fields, the field name corresponding to the field name used in the payment page form is proposed.
Naming of files specific to a shop
The name of reporting files should follow conservative guidelines and must provide 5 pieces of information all separated by the point character.
Nomenclature | Description |
---|---|
YYYYMM | Represents the date when the file was generated. Example: 201810 |
SHOP_KEY | Represents the shop identifier, an 8-digit number. Example: 87654321 |
EXP_CARDS | Generic name indicating exported cards. |
SHOP_NAME | Shop name (POS = Point Of Sale). Example: My-shop |
z | Letter "z" takes either the value "T" for a file in TEST mode, or "P" for a file in PRODUCTION mode. |
Filename example : 201810.87654321.EXP_CARDS.SHOP_NAME.T.csv
Header record
Pos. | Description | Format | Possible values |
---|---|---|---|
01 | Record code | n2 | 00 |
02 | File type | EXP_CARDS | |
03 | Shop ID | n8 | An 8-digit identifier provided when creating the shop. Equivalent field: vads_site_id |
04 | Environment | a1 | T or P Equivalent field: vads_ctx_mode |
05 | Creation date | n8 | Task start date |
06 | Time of creation | n6 | Task start time |
Details record
Pos. | Description | Format | Possible values |
---|---|---|---|
01 | Record code | n2 | 02 |
02 | Card alias | ans..50 | Ex : 4766113933f945c88bab9324ca08d990 Equivalent field: vads_identifier |
03 | Cardholder name | an..127 | E.g.: Axel Kant Equivalent field: vads_cust_name |
04 | Cardholder’s e-mail | an..127 | Ex : kant@e-mail.com Equivalent field: vads_cust_email |
05 | Card exp. date | n8 | YYYYMMDD |
06 | Unique identifier of the recurrence. | ans..50 | Ex : 6789113933f945c88bab9324ca08d990 Equivalent field: vads_subscription |
07 | Recurrence counter | n3 | Indicates the current recurrence number For example, 1/3 for the first of 3 recurrences associated to the same identifier. Equivalent field: vads_recurrence_number |
08 | Description of the recurrence | Equivalent field: vads_sub_desc | |
09 | Recurring payment start date | n8 | YYYYMMDD Equivalent field: vads_sub_effect_date |
10 | Fix amount of the recurrence. | n..12 | Amount expressed in the smallest currency unit Equivalent field: vads_sub_amount |
11 | Initial amount of the recurrence. | n..12 | Amount expressed in the smallest currency unit Equivalent field: vads_sub_init_amount |
12 | Number of initial occurrences | n..3 | E.g.: 2 Equivalent field: vads_sub_init_amount_number |
End record
Pos. | Description | Format | Possible values |
---|---|---|---|
01 | Record code | n2 | 01 |
02 | Total number of transmitted detail records | n..6 | |
03 | Number of tokens whose cards are close to expiration | n..6 | The total number of tokens whose cards expires for the shop |
04 | End date of processing | n8 | YYYYMMDD |
05 | End time of processing | n6 | HHMMSS |
Example of a file
"00";"EXP_CARDS";"P";"87654321";"20180622";"162416" "02";"91ca494b80d338a67ef06f3450b845cf";"Dupont Durant";"Durant@e-mail.com";"20180630";"REC_91ca494b80d338a67ef06f3450b845cf";"0/12"; "RRULE:FREQ=MONTHLY;COUNT=12;BYMONTHDAY=15";"20180501";"2000";"";"0" "01";"1";"1";"20180622";"162416"