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:xml_secure_card_features [2018/12/03 10:26]
127.0.0.1 external edit
developer:api_specification:xml_secure_card_features [2020/03/05 10:43] (current)
robinc [Examples for a Request] removed 'configurable by customer support'
Line 44: Line 44:
 | DATETIME | Y | Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. | | DATETIME | Y | Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. |
 | 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. | | 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. |
 +| CREDENTIALONFILE | N | Component of the request that can be added in case Credential on File feature is in use for the Terminal processing the Payment. See **ND004 - Credential on File** |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 103: Line 104:
 \\ \\
  
 +**ND004 - Credential on File**
 +
 +This feature is currently available to TSYS Saratoga terminals. These fields will only be used on a payment if you have secure card storage enabled. The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and adds them to the transaction,​ but doesn'​t not show it for the customer.
 +
 +To provide a transaction with COF, your request needs to add the Credential on File component and its fields, as described below.
 +
 +<​searchtable>​
 +^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^
 +| STOREDCREDENTIALTXTYPE | N  | Possible values: FIRST_TXN, SUBSEQUENT_MERCHANT_INITIATED_TXN or SUBSEQUENT_CARDHOLDER_INITIATED_TXN|
 +| STOREDCREDENTIALUSE | N  |Possible values: UNSCHEDULED,​ INSTALLMENT or RECURRING |
 +</​searchtable>​
 +\\
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?> ​
 +<​SECURECARDREGISTRATION>​
 +<​MERCHANTREF>​CSV_02338028</​MERCHANTREF>​
 +<​TERMINALID>​2366006</​TERMINALID>​
 +<​DATETIME>​11-09-2019:​14:​45:​38:​029</​DATETIME>​
 +<​CARDNUMBER>​4111111111111111</​CARDNUMBER>​
 +<​CARDEXPIRY>​1223</​CARDEXPIRY>​
 +<​CARDTYPE>​VISA</​CARDTYPE>​
 +<​CARDHOLDERNAME>​Jack Brown</​CARDHOLDERNAME>​
 +<​HASH>​f842282d0ee991dc84da957ee1697ce6</​HASH>​
 +<​CVV>​999</​CVV>​
 +<​CREDENTIALONFILE>​
 +<​STOREDCREDENTIALTXTYPE>​FIRST_TXN</​STOREDCREDENTIALTXTYPE>​
 +<​STOREDCREDENTIALUSE>​RECURRING</​STOREDCREDENTIALUSE>​
 +</​CREDENTIALONFILE>​
 +</​SECURECARDREGISTRATION>​
 +</​code>​
 +\\
 ==== Response Body Fields ==== ==== Response Body Fields ====
  
Line 113: Line 146:
 | DATETIME   | Response date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. | | DATETIME   | Response date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. |
 | HASH   | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. | | HASH   | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. |
 +| BRANDTXIDENTIFIER | The gateway returns the transaction identifier received for Acquirer to the merchant in the response if Credential on File is used. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 203: Line 237:
 | DATETIME | Y | Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. | | DATETIME | Y | Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. |
 | 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. | | 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. |
 +| CREDENTIALONFILE | N | Component of the request that can be added in case Credential on File feature is in use for the terminal processing the payment. See **ND004 - Credential on File**.|
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 260: Line 295:
 \\ \\
  
 +
 +**ND004 - Credential on File**
 +
 +This feature is currently available to TSYS Saratoga terminals. These fields will only be used on a payment if you have secure card storage enabled. The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and adds them to the transaction,​ but does not show it for the customer.
 +
 +To provide a transaction with COF, your request needs to add the Credential on File component and its fields, as described below.
 +
 +(new table below note ND004)
 +
 +<​searchtable>​
 +^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^
 +| STOREDCREDENTIALTXTYPE| N  | Possible values: FIRST_TXN, SUBSEQUENT_MERCHANT_INITIATED_TXN or SUBSEQUENT_CARDHOLDER_INITIATED_TXN|
 +| STOREDCREDENTIALUSE | N  |Possible values: UNSCHEDULED,​ INSTALLMENT or RECURRING|
 +</​searchtable>​
  
 ==== Response Body Fields ==== ==== Response Body Fields ====
Line 484: Line 533:
 | DATETIME |  Y  | Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. | | DATETIME |  Y  | Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. |
 | 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. | | 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. |
 +| CREDENTIALONFILE |  YN  | Component of the request that can be added in case Credential on File feature is in use for the terminal. See **ND003 - Credential on File**. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 526: Line 576:
 \\ \\
  
 +
 +**ND003 - Credential on File**
 +
 +This feature is currently available to TSYS Saratoga terminals. The Credential on File details will be included in the response if an empty CREDENTIALONFILE tag is sent in request.
 +
 +Quick example:
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​SECURECARDSEARCH>​
 +<​MERCHANTREF>​CSV_84828896</​MERCHANTREF>​
 +<​TERMINALID>​2366006</​TERMINALID>​
 +<​CREDENTIALONFILE/>​
 +<​DATETIME>​19-09-2019:​12:​21:​52:​441</​DATETIME>​
 +<​HASH>​054d6301a9d78d703772e7f44bca256f</​HASH>​
 +</​SECURECARDSEARCH>​
 +</​code>​
  
 ==== Response Body Fields ==== ==== Response Body Fields ====
Line 540: Line 607:
 | DATETIME   | Response date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. | | DATETIME   | Response date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. |
 | HASH   | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. | | HASH   | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. |
 +| BRANDTXIDENTIFIER   | The gateway returns the transaction identifier received from Acquirer to the merchant if Credential on File is sent in request.|
 +| STOREDCREDENTIALUSE | Possible vales: UNSCHEDULED,​ INSTALLMENT or RECURRING. Returned if Credential on File sent in request. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 625: Line 694:
 | DATETIME |  Y  | Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. | | DATETIME |  Y  | Request date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. |
 | 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. | | 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. |
 +| CREDENTIALONFILE |  N | Component of the request that can be added in case Credential on File feature is in use for the terminal. See **ND003 - Credential on File**. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 669: Line 739:
 </​WRAP>​ </​WRAP>​
 \\ \\
 +
 +
 +**ND003 - Credential on File**
 +
 +This feature is currently available on TSYS Saratoga terminals. The Credential on File details will be included in the response if an empty CREDENTIALONFILE tag is sent in request.
  
  
Line 680: Line 755:
 | DATETIME   | Response date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. | | DATETIME   | Response date and time. Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. |
 | HASH   | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. | | HASH   | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. |
 +| BRANDTXIDENTIFIER   | The gateway returns the transaction identifier received from Acquirer to the merchant if Credential on File is sent in request.|
 +| STOREDCREDENTIALUSE  ​ | Possible values: UNSCHEDULED,​ INSTALLMENT or RECURRING returned if Credential on File sent in request.|
 </​searchtable>​ </​searchtable>​
 \\ \\
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International