This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
developer:api_specification:xml_secure_card_features [2019/12/13 09:57] robinc [Request Body Fields] Added CREDENTIALONFILE |
developer:api_specification:xml_secure_card_features [2019/12/13 10:28] robinc [Request Body Fields] Added CREDENTIALONFILE |
||
---|---|---|---|
Line 104: | Line 104: | ||
\\ | \\ | ||
+ | **ND004 - Credential on File** | ||
+ | |||
+ | This feature is currently available to TSYS Saratoga terminals and is configurable by customer support. 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 114: | 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 204: | 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 261: | Line 295: | ||
\\ | \\ | ||
+ | |||
+ | **ND004 - Credential on File** | ||
+ | |||
+ | This feature is currently available to TSYS Saratoga terminals and is configurable by customer support. 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 485: | 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> | ||
\\ | \\ |