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
Next revision Both sides next revision
developer:api_specification:hpp_payment_features [2019/02/20 13:37]
thiago123 [Notes and Details About the Request]
developer:api_specification:hpp_payment_features [2019/05/17 14:02]
thiago123 [Notes and Details on the Response]
Line 51: Line 51:
 | PHONE | N | Customer phone number, to be stored against transaction. ​ International format and numeric. | | PHONE | N | Customer phone number, to be stored against transaction. ​ International format and numeric. |
 | PAYMENTTYPE | N | Set to CUP_SECUREPAY in order to forward directly to China Union Pay. | | PAYMENTTYPE | N | Set to CUP_SECUREPAY in order to forward directly to China Union Pay. |
-| 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. Also, see Notes **ND004** ​and **ND005** below. | +| 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. | 
-| 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. ​Also, see Notes **ND004** ​and **ND005** below. | +| 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. | 
-| SHIPPING_FULL_NAME ​ | N | Text type field with max length of 50 characteres. See **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_FULL_NAME ​ | 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 **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_ADDRESS1 ​ | N | Text type field with max length of 50 characteres. See **ND004** for more details. | 
-| SHIPPING_ADDRESS2 | N | Text type field with max length of 50 characteres. Always optional regardless compulsory setting. See **ND004 ​- Level 2 Data Validation** 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_CITY | N | Text type field, between 1 and 128 characteres. See **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_CITY | 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 **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_REGION | N | Text type field, between 1 and 128 characteres. See **ND004** for more details. | 
-| SHIPPING_POSTCODE ​ | N | Text type field, between 1 and 50 characteres. See **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_POSTCODE ​ | N | Text type field, between 1 and 50 characteres. See **ND004** for more details. | 
-| SHIPPING_COUNTRY ​ | N | Text type field, with 2 characteres. ISO ALPHA-2 Country Code. Also, see Notes **ND004** ​and **ND005** below. |+| SHIPPING_COUNTRY ​ | N | Text type field, with 2 characteres. ISO ALPHA-2 Country Code. See **ND004** ​for more details. |
 | CUSTOMFIELD | N | Any of the available Custom Fields for the Terminal. If there are Custom Fields enabled for the particular Terminal in use, the Hosted Page is going to show the ones not sent on request and hide the ones sent, pre-populating them with the informed values. Their values are going to be stored and used by the Payment Gateway for the requests sent to the Receipt URL and the Validation URL. To understand more visit the section regarding **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]**. | | CUSTOMFIELD | N | Any of the available Custom Fields for the Terminal. If there are Custom Fields enabled for the particular Terminal in use, the Hosted Page is going to show the ones not sent on request and hide the ones sent, pre-populating them with the informed values. Their values are going to be stored and used by the Payment Gateway for the requests sent to the Receipt URL and the Validation URL. To understand more visit the section regarding **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]**. |
 | OTHERFIELD | N | Any other fields sent in the request will be treated as a custom field. They are not going to be stored, but they are going to be used by the Payment Gateway for the request sent to the Receipt URL. Note that this is subject to the max length of a HTTP GET request which we would conservatively recommend considering to be 2000 characters. | | OTHERFIELD | N | Any other fields sent in the request will be treated as a custom field. They are not going to be stored, but they are going to be used by the Payment Gateway for the request sent to the Receipt URL. Note that this is subject to the max length of a HTTP GET request which we would conservatively recommend considering to be 2000 characters. |
Line 90: Line 90:
 | PHONE | N | Customer phone number, to be stored against transaction. ​ International format and numeric. | | PHONE | N | Customer phone number, to be stored against transaction. ​ International format and numeric. |
 | PAYMENTTYPE | N | Set to CUP_SECUREPAY in order to forward directly to China Union Pay. | | PAYMENTTYPE | N | Set to CUP_SECUREPAY in order to forward directly to China Union Pay. |
-| 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. Also, see Notes **ND004** ​and **ND005** below. | +| 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. | 
-| 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. ​Also, see Notes **ND004** ​and **ND005** below. | +| 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. | 
-| SHIPPING_FULL_NAME ​ | N | Text type field with max length of 50 characteres. See **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_FULL_NAME ​ | 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 **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_ADDRESS1 ​ | N | Text type field with max length of 50 characteres. See **ND004** for more details. | 
-| SHIPPING_ADDRESS2 | N | Text type field with max length of 50 characteres. Always optional regardless compulsory setting. See **ND004 ​- Level 2 Data Validation** 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_CITY | N | Text type field, between 1 and 128 characteres. See **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_CITY | 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 **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_REGION | N | Text type field, between 1 and 128 characteres. See **ND004** for more details. | 
-| SHIPPING_POSTCODE ​ | N | Text type field, between 1 and 50 characteres. See **ND004 ​- Level 2 Data Validation** for more details. | +| SHIPPING_POSTCODE ​ | N | Text type field, between 1 and 50 characteres. See **ND004** for more details. | 
-| SHIPPING_COUNTRY ​ | N | Text type field, with 2 characteres. ISO ALPHA-2 Country Code. Also, see Notes **ND004** ​and **ND005** below. | +| SHIPPING_COUNTRY ​ | N | Text type field, with 2 characteres. ISO ALPHA-2 Country Code. See **ND004** ​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. | +| 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_FREIGHT_AMOUNT | N | Total freight amount applied to the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. | +| 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_DUTY_AMOUNT | N | Total discount amount applied to the sale. Max of 13 characteres and 3 decimal points, depending on your terminal'​s currency. | +| 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. | 
-| 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 ​- Level 3 Data Validation**. |+| 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’_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 **ND006 - 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 ​- 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’_QUANTITY | N | Quantity of the specific item for the sale. See **ND006 ​- Level 3 Data Validation**. | +| LINE_ITEM_’N’_QUANTITY | N | Quantity of the specific item for the sale. 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 **ND006 ​- Level 3 Data Validation**. | +| 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_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 ​- Level 3 Data Validation**. | +| 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’_DISCOUNT_RATE | N | A % of discount applied to the item total (quantity x unit price) before taxes. Max of 100%. See **ND006 ​- Level 3 Data Validation**. | +| 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’_TAX_RATE | N | A % of tax applied to the item total (quantity x unit price) after discounts. Max of 100%. See **ND006 ​- Level 3 Data Validation**. | +| 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’_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 ​- Level 3 Data Validation**. |+| 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. |
 | CUSTOMFIELD | N | Any of the available Custom Fields for the Terminal. If there are Custom Fields enabled for the particular Terminal in use, the Hosted Page is going to show the ones not sent on request and hide the ones sent, pre-populating them with the informed values. Their values are going to be stored and used by the Payment Gateway for the requests sent to the Receipt URL and the Validation URL. To understand more visit the section regarding **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]**. | | CUSTOMFIELD | N | Any of the available Custom Fields for the Terminal. If there are Custom Fields enabled for the particular Terminal in use, the Hosted Page is going to show the ones not sent on request and hide the ones sent, pre-populating them with the informed values. Their values are going to be stored and used by the Payment Gateway for the requests sent to the Receipt URL and the Validation URL. To understand more visit the section regarding **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]**. |
 | OTHERFIELD | N | Any other fields sent in the request will be treated as a custom field. They are not going to be stored, but they are going to be used by the Payment Gateway for the request sent to the Receipt URL. Note that this is subject to the max length of a HTTP GET request which we would conservatively recommend considering to be 2000 characters. | | OTHERFIELD | N | Any other fields sent in the request will be treated as a custom field. They are not going to be stored, but they are going to be used by the Payment Gateway for the request sent to the Receipt URL. Note that this is subject to the max length of a HTTP GET request which we would conservatively recommend considering to be 2000 characters. |
Line 292: Line 292:
 \\ \\
  
-**ND002 - Treat Metrix ​Enabling**+**ND002 - Sentinel Defence ​Enabling**
  
-Threat Metrix ​must be enabled for your Gateway and on the Terminal used for processing the request ​needs to be also enabled for Threat Metrix feature so your response contains these fields.+Sentinel Defence ​must be enabled for your Gateway and on the Terminal used for processing the transaction ​request.
  
 \\ \\
  
-**ND003 - Treat Metrix ​REVIEW status**+**ND003 - Sentinel Defence ​REVIEW status**
  
 If a transaction is returned with "​FRAUDREVIEWSTATUS"​ as "​REVIEW",​ this transaction can be changed manually, using the new report feature on %Selfcare System, or using the transaction update XML gateway service, to "​APPROVE"​ or "​REJECT"​ the transaction. Transactions with this status are not going to be settled until the transaction status is changed. See the XML Gateway method for more details, more specifically,​ its **Transaction Update** feature, to change the transaction returned as "​REVIEW"​ to "​REJECT"​ or "​APPROVE"​. If a transaction is returned with "​FRAUDREVIEWSTATUS"​ as "​REVIEW",​ this transaction can be changed manually, using the new report feature on %Selfcare System, or using the transaction update XML gateway service, to "​APPROVE"​ or "​REJECT"​ the transaction. Transactions with this status are not going to be settled until the transaction status is changed. See the XML Gateway method for more details, more specifically,​ its **Transaction Update** feature, to change the transaction returned as "​REVIEW"​ to "​REJECT"​ or "​APPROVE"​.
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International