Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developer:api_specification:hpp_subscription_features [2019/07/18 08:09]
thiago123 [Request Body Fields]
developer:api_specification:hpp_subscription_features [2019/07/18 08:12] (current)
Line 62: Line 62:
 <​searchtable>​ <​searchtable>​
 ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^ ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^
-| CUSTOMER_REF_NUMBER | N | Text type field with max length of 48 characteres. This number is defined by the cardmember. It is entered by the merchant at the point of sale. See **ND004** for more details. | +| CUSTOMER_REF_NUMBER | N | Text type field with max length of 48 characteres. This number is defined by the cardmember. It is entered by the merchant at the point of sale. See **ND002** for more details. | 
-| TAX_AMOUNT ​ | N | Value type field, with max length of 13 algarisms. A value of zero is required in order to indicate tax exempt transactions. See **ND004** for more details. | +| TAX_AMOUNT ​ | N | Value type field, with max length of 13 algarisms. A value of zero is required in order to indicate tax exempt transactions. See **ND002** for more details. | 
-| SHIPPING_FULL_NAME ​ | N | Text type field with max length of 50 characteres. See **ND004** for more details. | +| SHIPPING_FULL_NAME ​ | N | Text type field with max length of 50 characteres. See **ND002** for more details. | 
-| SHIPPING_ADDRESS1 ​ | N | Text type field with max length of 50 characteres. See **ND004** for more details. | +| SHIPPING_ADDRESS1 ​ | N | Text type field with max length of 50 characteres. See **ND002** for more details. | 
-| SHIPPING_ADDRESS2 | N | Text type field with max length of 50 characteres. Always optional regardless compulsory setting. See **ND004** for more details. | +| SHIPPING_ADDRESS2 | N | Text type field with max length of 50 characteres. Always optional regardless compulsory setting. See **ND002** for more details. | 
-| SHIPPING_CITY | N | Text type field, between 1 and 128 characteres. See **ND004** for more details. | +| SHIPPING_CITY | N | Text type field, between 1 and 128 characteres. See **ND002** for more details. | 
-| SHIPPING_REGION | N | Text type field, between 1 and 128 characteres. See **ND004** for more details. | +| SHIPPING_REGION | N | Text type field, between 1 and 128 characteres. See **ND002** for more details. | 
-| SHIPPING_POSTCODE ​ | N | Text type field, between 1 and 50 characteres. See **ND004** for more details. | +| SHIPPING_POSTCODE ​ | N | Text type field, between 1 and 50 characteres. See **ND002** for more details. | 
-| SHIPPING_COUNTRY ​ | N | Text type field, with 2 characteres. ISO ALPHA-2 Country Code. See **ND004** for more details. | +| SHIPPING_COUNTRY ​ | N | Text type field, with 2 characteres. ISO ALPHA-2 Country Code. See **ND002** for more details. | 
-| TOTAL_DISCOUNT_AMOUNT | N | Total discount amount provided to the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND006** for more details. | +| TOTAL_DISCOUNT_AMOUNT | N | Total discount amount provided to the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND003** for more details. | 
-| TOTAL_FREIGHT_AMOUNT | N | Total freight amount applied to the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND006** for more details. | +| TOTAL_FREIGHT_AMOUNT | N | Total freight amount applied to the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND003** for more details. | 
-| TOTAL_DUTY_AMOUNT | N | Total discount amount applied to the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND006** for more details. | +| TOTAL_DUTY_AMOUNT | N | Total discount amount applied to the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND003** for more details. | 
-| LINE_ITEM_’N’_PRODUCT_CODE | N | This is the merchant’s identifier for the product, also known as Universal Product code (UPC). Subfield of a line item. You can add as much items as see fit, using a sequential instead of '​N'​ to identify its fields. Its value can be up to 45 chars. See **ND006** for more details. | +| LINE_ITEM_’N’_PRODUCT_CODE | N | This is the merchant’s identifier for the product, also known as Universal Product code (UPC). Subfield of a line item. You can add as much items as see fit, using a sequential instead of '​N'​ to identify its fields. Its value can be up to 45 chars. See **ND003** for more details. | 
-| LINE_ITEM_’N’_COMMODITY_CODE | N | Item's commodidy code, defined for trade tariff. Widely used by corporate purchasing organizations to segment and manage their total spend across diverse product lines. Defined at government or commercial aggrements level. Consult your Acquirer for more details. Subfield of a line item. You can add as much items as see fit, using a sequential instead of '​N'​ to identify its fields. Its value can be up to 45 chars. See **ND006 - Level 3 Data Validation**. | +| LINE_ITEM_’N’_COMMODITY_CODE | N | Item's commodidy code, defined for trade tariff. Widely used by corporate purchasing organizations to segment and manage their total spend across diverse product lines. Defined at government or commercial aggrements level. Consult your Acquirer for more details. Subfield of a line item. You can add as much items as see fit, using a sequential instead of '​N'​ to identify its fields. Its value can be up to 45 chars. See **ND003 - Level 3 Data Validation**. | 
-| LINE_ITEM_’N’_DESCRIPTION ​ | N | This is the merchant’s description for the product. Subfield of a line item. You can add as much items as see fit, using a sequential instead of '​N'​ to identify its fields. Its value can be up to 250 chars. See **ND006** for more details. | +| LINE_ITEM_’N’_DESCRIPTION ​ | N | This is the merchant’s description for the product. Subfield of a line item. You can add as much items as see fit, using a sequential instead of '​N'​ to identify its fields. Its value can be up to 250 chars. See **ND003** for more details. | 
-| LINE_ITEM_’N’_QUANTITY | N | Quantity of the specific item for the sale. See **ND006** for more details. | +| LINE_ITEM_’N’_QUANTITY | N | Quantity of the specific item for the sale. See **ND003** for more details. | 
-| LINE_ITEM_’N’_UNIT_OF_MEASURE | N | Measure unit used for this specific item type to sell it in parts, units or sets. Subfield of a line item. You can add as much items as see fit, using a sequential instead of '​N'​ to identify its fields. Its value can be up to 45 chars. See **ND006** for more details. | +| LINE_ITEM_’N’_UNIT_OF_MEASURE | N | Measure unit used for this specific item type to sell it in parts, units or sets. Subfield of a line item. You can add as much items as see fit, using a sequential instead of '​N'​ to identify its fields. Its value can be up to 45 chars. See **ND003** for more details. | 
-| LINE_ITEM_’N’_UNIT_PRICE | N | Unit price applied for that specific type of item and measure unit, within the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND006** for more details. | +| LINE_ITEM_’N’_UNIT_PRICE | N | Unit price applied for that specific type of item and measure unit, within the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND003** for more details. | 
-| LINE_ITEM_’N’_DISCOUNT_RATE | N | A % of discount applied to the item total (quantity x unit price) before taxes. Max of 100%. See **ND006** for more details. | +| LINE_ITEM_’N’_DISCOUNT_RATE | N | A % of discount applied to the item total (quantity x unit price) before taxes. Max of 100%. See **ND003** for more details. | 
-| LINE_ITEM_’N’_TAX_RATE | N | A % of tax applied to the item total (quantity x unit price) after discounts. Max of 100%. See **ND006** for more details. | +| LINE_ITEM_’N’_TAX_RATE | N | A % of tax applied to the item total (quantity x unit price) after discounts. Max of 100%. See **ND003** for more details. | 
-| LINE_ITEM_’N’_TOTAL_AMOUNT | N | Final item value based on total (quantity x unit price), after discount and tax applied. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND006** for more details. |+| LINE_ITEM_’N’_TOTAL_AMOUNT | N | Final item value based on total (quantity x unit price), after discount and tax applied. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. See **ND003** for more details. |
 </​searchtable>​ </​searchtable>​
  
Line 107: Line 107:
 \\ \\
  
 +**ND002 - Level 2 Data Validation**
 +
 +These fields are associate with of the Transaction`s Level 2 Enhanced Data. To be used, it's necessary that your terminal has the enhanced data enabled and set to LEVEL 2 or LEVEL 3. 
 +All of its fields, except for SHIPPING_ADDRESS2,​ are necessary if you want to have a better chance to qualify for Level 2 with your acquirer, but no field is actually mandatory.
 +
 +<WRAP 100%>
 +**This feature is only available for specific acquirers (contact our support team for more details).**
 +</​WRAP>​
 +\\
 +
 +**ND003 - Level 3 Data Validation**
 +
 +These fields are associate with of the Transaction`s Level 3 Enhanced Data. To be used, it's necessary that your terminal has the enhanced data enabled and set to LEVEL 3. To be valid, these fields need to be added to the transaction together with the Level II fields. Also, consider that the enhanced data fields are not mandatory, but if you send any Level 3 data fields, your application must send at least one item, and this item must contain at least the unit price, quantity and final amount. This feature is only available for specific acquirers (contact our support team for more details).
 ==== Examples for a Request ==== ==== Examples for a Request ====
  
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International