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 Both sides next revision
developer:api_specification:xml_payment_features [2019/07/15 10:16]
thiago123
developer:api_specification:xml_payment_features [2019/07/16 13:09]
thiago123
Line 22: Line 22:
  
 ==== Request Body Fields ==== ==== Request Body Fields ====
-{gateway=testdocs.worldnettps.com}{gateway=docs.worldnettps.com}{gateway=testdocsanywherecommercecom.worldnettps.com}{gateway=docs.anywherecommerce.com} +
-<​searchtable>​  +
-^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^ +
-|ORDERID | Y |A unique identifier for the order created by the merchant.\\ Maximum of 24 characters. | +
-|TERMINALID | Y |A Terminal ID provided by %CompanyName. | +
-|AMOUNT | Y |The amount of the transaction.\\ A 2 digit decimal or an Integer value for JPY amounts. | +
-|DATETIME | Y |Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. |  +
-|TRACKDATA | N |Track 2 data.\\ Should be present for a swiped cardholder present (CHP) transaction. If this is present then TERMINALTYPE should be set to 3 and TRANSACTIONTYPE should be set to 0. |  +
-|CARDNUMBER | N |Payment card number.\\ Required if TRACKDATA is not being sent.\\ If a SECURECARD is used (in CARDTYPE), this field should inform the CARDREFERENCE of the given Secure Card. |  +
-|APPLEPAYLOAD | N |When using apple pay for payments, instead of the TRACKDATA or CARDNUMBER, you pass this field, with the Apple Pay user data, received from your request, converted to Hexadecimal. | +
-|GOOGLEPAYLOAD | N |When using google pay for payments, instead of the TRACKDATA or CARDNUMBER, you pass this field, with the Google Pay user data, received from your request, converted to Hexadecimal. | +
-|CARDTYPE | Y |Card Type used for the transaction.\\ For more details on this, visit **[[developer:​api_specification:​special_fields_and_parameters#​the_card_types|Special Fields and Parameters - Card Types]]**.\\ This field can also admit the SECURECARD type, when using a Secure Card to perform the transaction. | +
-|CARDEXPIRY | N |Expiry date of the card.\\ A 4 digit expiry field (MMYY), required if TRACKDATA is not being sent.\\ This field should not be informed if the CARDTYPE is SECURECARD. | +
-|CARDHOLDERNAME | N |The name of the card holder, required if TRACKDATA is not being sent and not using a SecureCard. It should be as displayed on the front of the card.\\ This field should not be informed if the CARDTYPE is SECURECARD. | +
-|HASH | Y |A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. |  +
-|CURRENCY | Y |Currency of the transaction.\\ A 3 character code following the ISO 4217 Currency Code. | +
-|FOREIGNCURRENCYINFORMATION | N |Tag contains Dynamic Currency Conversion information. It has to be present in the eDCC enabled transactions.\\ See the next section, **ND004 - Using eDCC**, for more details on this field. | +
-|TERMINALTYPE | Y |The type of terminal:\\ 1 - MOTO (Mail Order/​Telephone Order).\\ 2 - eCommerce.\\ 3 - Cardholder Present. | +
-|TRANSACTIONTYPE | Y |Normally:​\\ 0 - Cardholder Present (CHP) transaction.\\ ​ 4 - MOTO (Mail Order/​Telephone Order).\\ 7 - eCommerce.\\ \\ Recurring Payment Flagging:\\ 2 - Specify that this transaction is recurring. This must be accompanied by the RECURRINGTXNREF field or have special permission granted by the Gateway. Not all processors support this transaction type and consultation with the integration team should be carried out prior to configuring recurring payment flagging.\\ \\ For First Data Latvia terminal MOTO transactions:​\\ 4 - Telephone Order.\\ 9 - Mail Order.\\ \\ If sending XID & CAVV from non %CompanyName MPI on an eCommerce transaction use:\\ 0 - not applicable.\\ 1 - Single transaction.\\ 2 - Recurring transaction.\\ 3 - Installment payment.\\ 4 - Unknown classification.\\ 5 - Fully authenticated transaction 3D Secure transaction.\\ 6 - The merchant attempted to authenticate the cardholder, but the cardholder cannot or does not  in 3D Secure.\\ 7 - Transaction when payment data was transmitted using SSL encryption, or Channel Encrypted. \\ 8 - Transaction in the clear, or Non Secure. | +
-|AUTOREADY | N |Y or N. If this is set to Y %CompanyName will automatically set the transaction to READY in the batch. If set to N then the transaction will go to a PENDING status. If not present the terminal default will be used. | +
-|EMAIL | N |Cardholder'​s e-mail address.\\ If populated, the cardholder will receive an email receipt.\\ This can be overridden by the Terminal Setup settings “Disable Cardholder Receipt”. | +
-|CVV | N |The security code entered by the card holder. | +
-|ISSUENO | N |The issue no. of the card (Solo). | +
-|ADDRESS1 | N |The first address. Required for AVS. | +
-|ADDRESS2 | N |Second line of address. Required for AVS. Same as ADDRESS1. | +
-|POSTCODE | N |Post code for the address. Required for AVS. Required for MaxMind MinFraud fraud scoring complementary service. | +
-|BILLTOLASTNAME | N |First name of the "Bill To" part of a sale | +
-|BILLTOFIRSTNAME | N |Last name of the "Bill To" part of a sale | +
-|DESCRIPTION | N |A description of the transaction. | +
-|XID | N | The XID for a 3D Secure transaction. It should only be provided in case you are not using %CompanyName **[[developer:​api_specification:​xml_3d_secure|3D Secure]]** service. If you are, use MPIREF instead to perform a 3DS transaction. | +
-|CAVV | N |The CAVV for a 3D Secure transaction. It should only be provided in case you are not using %CompanyName **[[developer:​api_specification:​xml_3d_secure|3D Secure]]** service. If you are, use MPIREF instead to perform a 3DS transaction. | +
-|MPIREF | N | 3D Secure %CompanyName Transaction Reference. If you are using the %CompanyName **[[developer:​api_specification:​xml_3d_secure|3D Secure]]** service, the response of your request, when successful, will contain this field. | +
-|MOBILENUMBER | N |Used for SMS receipts.\\ International format, numeric only. | +
-|DEVICEID | N |The unique identifier string for a connecting device.\\ Mandatory for non-server based devices such as handheld devices/​cash register etc. | +
-|PHONE | N |Card Holder Phone Number stored against transaction.\\ International format, numeric only. | +
-|CITY | N |City of the address. Required for MaxMind MinFraud fraud scoring complementary service. | +
-|REGION | N |Region of the address. Required for MaxMind MinFraud fraud scoring complementary service. | +
-|COUNTRY | N |Country code for the address. Following the ISO 3166-1-alpha-2 Country Code. Required for MaxMind MinFraud fraud scoring complementary service. | +
-|IPADDRESS | N |Recommended inclusion. Useful for tracking customers. Functionality will expand in the future. Required for MaxMind MinFraud fraud scoring. | +
-|SIGNATURE | N |Optional field if processing Cardholder Present (CHP) transactions using the TRACKDATA field. For format, visit **[[developer:​api_specification:​special_fields_and_parameters#​the_signature_field_format|Special Fields and Parameters]]**. | +
-|CUSTOMFIELD'​N'​ | N |Any of the available Custom Fields for the Terminal. Their values are going to be stored and can be used by the Payment Gateway later on. To understand more visit the section regarding **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]**. Limited to 30 custom fields in this request. | +
-|RECURRINGTXNREF | N |Should be set to the value of a UNIQREREF returned in a Payment response for a matching card. TRANSACTIONTYPE should be set to '​2'​. | +
-|LEVEL_2_DATA | N |Component of the request that can be added in case the Level II Data feature is in use for the Terminal processing the Payment. See **ND005 - Level 2 Data Validation**. | +
-|ENHANCED_DATA_TEMPLATE | N | Enhanced Data template name to be used when creating the transaction. It fills up any not provided transaction'​s enhanced data fields. \\ Note that if you use a template, but inform the data during the request, the gateway is just going to use the template to fill the gaps of whatever you didn't inform in your original request. \\ This field should only be used if you desire to use one of your Enhanced Data Templates (see **[[merchant:​existing_merchant:​selfcare_system:​settings:​enhanced_data_templates|Merchant Enhanced Data Templates]]** for more details.\\ This field is only available for terminals with **Transaction Enhanced Data** feature enabled. | +
-|FRAUDREVIEWSESSIONID | N |This field should contain the value of THEIR_SESSION_ID parameter that a merchant integration uses to configure its session with Sentinel Defence. See the **ND003 - Using Sentinel Defence**, in the next section. | +
-</​searchtable>​ +
-{/​gateway}  +
-{gateway=helpdesk.nuvei.com}{gateway=testhelpdesknuveicom.worldnettps.com}+
 <​searchtable>​  <​searchtable>​
 ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^ ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^
Line 116: Line 69:
 |FRAUDREVIEWSESSIONID | N |This field should contain the value of THEIR_SESSION_ID parameter that a merchant integration uses to configure its session with Sentinel Defence. See the **ND003 - Using Sentinel Defence**, in the next section. | |FRAUDREVIEWSESSIONID | N |This field should contain the value of THEIR_SESSION_ID parameter that a merchant integration uses to configure its session with Sentinel Defence. See the **ND003 - Using Sentinel Defence**, in the next section. |
 </​searchtable>​  </​searchtable>​
-{/gateway} 
 \\ \\
  
Line 220: Line 172:
  
 \\ \\
-{gateway=helpdesk.nuvei.com}{gateway=testhelpdesknuveicom.worldnettps.com}+
 **ND006 - Level 3 Data Validation** **ND006 - Level 3 Data Validation**
  
Line 292: Line 244:
  
 \\ \\
-{/gateway}+
 **ND007 - Multi Language Support** **ND007 - Multi Language Support**
  
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International