Product files contain the information about the products including voucher content. Product files are named to include a version number. They are occasionally updated with product content changes and when this happens the version number will change. Product files are available from the Now Prepay server. Data in the file includes product descriptions, parameters required to form the API request for purchase, as well as the static data for post transactional presentation to the user. Several types of product files are available.
Product FileType 10 contains all products available specific to an eGift partner.
Product FileType 11 contains all products available to a non-eGift partner in JSON format.
Product FileType 12 contains all products available to a non-eGift partner in XLSX format.
Product FileType 13 contains all products available to a non-eGift partner in XML format.
Each purchase transaction response includes the product file version that is available on the server. If the version number has changed from the one last downloaded, issue a download request to obtain the new product file. The product file version field to monitor in responses depends upon the FileType used.
For FileType 10 the product version field in the response is <ProductVer>.
For FileType(s) 11, 12, 13 the product version field in the response is <BosVer>.
<RequestXml>
<Type>FileDownload</Type>
<FileType>10</FileType>
<TerminalId>BA12111112</TerminalId>
<Password>*</Password>
</RequestXml>
<ResponseXml>
<StatusCode>0</StatusCode>
<StatusDescription>Product file 10 download</StatusDescription>
<ReportMenu>
082506iEnday15tEnd of the Day2206iSumry08tSummary02ad2706iClerk13tClerk Report02ad2806iDtail14tDetail
Report02ad2408iNewInvc12tNew Invoice2508iLstInvc13tLast Invoice3211iLst2ndInvc17t2nd Last Invoice3211iLst3rdInvc17t3rd
Last Invoice
</ReportMenu>
<FileData>...FILE CONTENT HERE...</FileData>
<MerchantId>NPPTESTSTORE</MerchantId>
<Company>NPP Convenience</Company>
<CompanyCity>Vancouver</CompanyCity>
<CompanyPhone>5551234567</CompanyPhone>
<CompanyDbaName>NPP Convenience Mart</CompanyDbaName>
<TransDate>2019-02-05</TransDate>
<TransTime>11:37:24</TransTime>
<ProductVer>0340255</ProductVer>
<PromoVer>0340009</PromoVer>
<SoftVer />
<InvoiceNumber />
</ResponseXml>
<FileData> returned in the response is the product file. For example, Product FileType 10 is an Excel XLS file. Download example Type 10 file.
Version Numeric version of the file. Increments each time the file content changes.
CreatedDate Date this file was created
MerchantID The merchant ID Now Prepay has associated to this file
UPC The UPC for this ProductCode + ValueCode combination. For Variable value products, the UPC is the same for the value range.
ProductName Name of the product, e.g. "Rogers Wireless"
ProductCode The six character code assigned by Now Prepay and used in transaction requests.
ValueCode Face value(s) for ProductCode. For fixed value products, multiple values are often offered. For variable value products, the value codes can represent tiers with the variable range (between MinValue and MaxValue), and each tier may have a different user fee or the commission value. The ValueCode is the minimum value for that tier. Most variable value products are a single tier and therefore only one ValueCode is noted for the entire variable range.
MinValue The lowest product value for this ProductCode + ValueCode combination.
MaxValue The largest product value for this ProductCode + ValueCode combination.
StoreGUI The GUI used for this product.
AmountType Defined if the product is fixed value "F" or variable value "V".
Region Notes the regionality of the product, e.g. "National", "All but QC, "BC, AB, MB", etc. Product can only be offered in the region(s) noted.
Category The product category, e.g. "Mobile". Used for reporting or classification.
RetailValue Retail value, the amount charged to the customer. This includes any fees, and does not include any applicable taxes. For variable products, the value shown is either blank or shows "varies", as the value is the sum of Amount in the transaction request, plus any Fee, if applicable.
Earns The commission/dollar amount earned by the selling merchant, if fixed or a percentage of a fixed value.
Rate The commission/percentage earned in decimal, e.g. 0.025 for 2.5%, if specified as a percentage earning.
CommissionType Two character code indicating the product value type (fixed or variable) and commission rating method (Fixed or variable) for this product.
FF - Fixed amounts and fixed commission
FP - Fixed amounts and percentage commission
VF - Variable product value with fixed commission
VP - Variable product value with percentage commission
FeeFixed The fee portion for this product if a fixed value. This fee is in addition to the Amount requested in the transaction, e.g. $2.95.
FeePercent The fee percentage (in decimal) for this product if a percentage of the requested amount. This fee is in addition to the Amount requested in the transaction, e.g. 0.025 for 2.5%
TermsEnglish User terms and conditions, user instruction, etc. in English language.
TermsFrench User terms and conditions, user instruction, etc. in French language.
ProductImage URL access to the product logo or image. Use this URL to retrieve the file and store locally. Do not access this file during each transaction.
Discontinued (Future) Date the product is discontinued, if applicable. Products are removed from this file after the discontinued date.
InfoUpdated Last date any of the product data was updated, excluding the rate data.
RateUpdated Last date any of the rate data was updated, excluding the product data.
GST Indicates if Federal tax (GST or HST) is applied on the revenue portion of a transaction on the invoice generated by Now Prepay.