Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
developer:api_specification:hpp_secure_card_features [2019/06/04 15:15] hanv [Request Body Fields] |
developer:api_specification:hpp_secure_card_features [2022/03/04 10:59] (current) lezlieh [update to secure token |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Hosted Page Secure Card Feature ======= | + | ====== Hosted Page Secure Token Feature ======= |
| ~~TOC~~ | ~~TOC~~ | ||
| Line 5: | Line 5: | ||
| \\ | \\ | ||
| - | This feature enables you to register a Secure Card using the Hosted Page method. For more details on Secure Cards, please visit the **[[merchant:new_merchant:products#secure_card|Products]]** page. | + | This feature enables you to register a Secure Token using the Hosted Page method. For more details on Secure Tokens, please visit the **[[merchant:new_merchant:products#secure_card|Products]]** page. |
| - | Use the Request URL and the Request Body Fields to perform a request for this feature, then put in place your Secure Card URL so the Gateway can use the Response Body Fields to send the registration's response. | + | Use the Request URL and the Request Body Fields to perform a request for this feature, then put in place your Secure Token URL so the Gateway can use the Response Body Fields to send the registration's response. |
| - | ===== Secure Card Registration and Update ===== | + | ===== Secure Token Registration and Update ===== |
| * REQUEST URL: **https://testpayments.nuvei.com/merchant/securecardpage** | * REQUEST URL: **https://testpayments.nuvei.com/merchant/securecardpage** | ||
| Line 19: | Line 19: | ||
| | ACTION | Y | Values can be: register or update. | | | ACTION | Y | Values can be: register or update. | | ||
| | TERMINALID | Y | A TerminalID provided by Nuvei. | | | TERMINALID | Y | A TerminalID provided by Nuvei. | | ||
| - | | MERCHANTREF| Y | Unique reference assigned by the Merchant site/ solution to identify the stored card details. The length is limited to 48 characters. | | + | | MERCHANTREF| Y | Unique reference assigned by the Merchant site/solution to identify the stored card details. The length is limited to 48 characters. | |
| - | | EMAIL | N | Cardholder e-mail, which is going to be used, if sent, to provide the cardholder with receipt notifications when the transactions is processed. See note **ND0003 - E-mail field behavior and settings**. | | + | | EMAIL | N | Cardholder e-mail, which is going to be used, if sent, to provide the cardholder with receipt notifications when the transactions are processed. See note **ND0003 - E-mail field behavior and settings**. | |
| | DATETIME | Y | Date and time of the request. Format: DD-MM-YYYY:HH:MM:SS:SSS. | | | DATETIME | Y | Date and time of the request. 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. | | ||
| + | | STOREDCREDENTIALUSE | N | Values can be: UNSCHEDULED, INSTALLMENT or RECURRING. See note **ND0004 - Stored Credential use field behavior and settings**. | | ||
| </searchtable> | </searchtable> | ||
| \\ | \\ | ||
| Line 31: | Line 32: | ||
| **ND001 - Hash Formation** | **ND001 - Hash Formation** | ||
| - | The gerenal rule to build HASH field is given at the **[[developer:api_specification:special_fields_and_parameters|Special Fields and Parameters]]** page. For this specific feature, you should use the following formats: | + | The general rule to build HASH field is given at the **[[developer:api_specification:special_fields_and_parameters|Special Fields and Parameters]]** page. For this specific feature, you should use the following formats: |
| <WRAP center box 100%> | <WRAP center box 100%> | ||
| Line 37: | Line 38: | ||
| </WRAP> | </WRAP> | ||
| - | **ND002 - Valid Secure Card Update** | + | **ND002 - Valid Secure Token Update** |
| - | To initiate card details updating, the value of the ACTION parameter should be changed to “update”. Also, in case you want to update a Secure Card of MERCHANTREF **1234321**, a Secure Card should already exist with this same MERCHANTREF, or the updated won't preoceed. | + | To initiate card details updating, the value of the ACTION parameter should be changed to “update”. Also, in case you want to update a Secure Token of MERCHANTREF **1234321**, a Secure Token should already exist with this same MERCHANTREF, or the updated won't preoceed. |
| **ND0003 - E-mail field behavior and settings** | **ND0003 - E-mail field behavior and settings** | ||
| Line 45: | Line 46: | ||
| This field is available for all terminal, but depending on configuration (**SC Hosted Page email field setup**), it might have one of the following behaviors when the customer gets to the hosted payment page: \\ **Hidden** - the gateway accepts the field, if sent, and adds it to the transaction, but does not show it for the customer); \\ **Visible** - the gateway accepts the field, if sent, and adds it to the transaction, also shows the field on the hosted payment page, and the user can changed it or not. In this last case, the field can be made optional or mandatory. | This field is available for all terminal, but depending on configuration (**SC Hosted Page email field setup**), it might have one of the following behaviors when the customer gets to the hosted payment page: \\ **Hidden** - the gateway accepts the field, if sent, and adds it to the transaction, but does not show it for the customer); \\ **Visible** - the gateway accepts the field, if sent, and adds it to the transaction, also shows the field on the hosted payment page, and the user can changed it or not. In this last case, the field can be made optional or mandatory. | ||
| + | **ND0004 - Stored Credential use field behavior and settings** | ||
| + | |||
| + | This field is currently available to TSYS Saratoga terminals. This field is optional and will have the following behavior: Hidden - the gateway accepts the field, if sent, and adds it to the transaction, but does not sow it for the customer. | ||
| + | |||
| + | Note: STOREDCREDENTIALTXTYPE set as FIRST_TXN by default. | ||
| \\ | \\ | ||
| Line 58: | Line 64: | ||
| <input type="hidden" name="ACTION" value="register" /> | <input type="hidden" name="ACTION" value="register" /> | ||
| <input type="hidden" name="TERMINALID" value="6491002" /> | <input type="hidden" name="TERMINALID" value="6491002" /> | ||
| - | <input type="hidden" name="MERCHANTREF" value="1234321" /> | + | <input type="hidden" name="MERCHANTREF" value="1234321" /> |
| - | <input type="hidden" name="DATETIME" value="15-3-2006:10:43:01:673" /> | + | <input type="hidden" name="DATETIME" value="15-3-2006:10:43:01:673" /> |
| - | <input type="hidden" name="HASH" value="c3ce23e5e27d2863d116a6f9c8d63f5e" /> | + | <input type="hidden" name="STOREDCREDENTIALUSE" value="UNSCHEDULED" /> |
| - | <input type="submit" value="Register" /> | + | <input type="hidden" name="HASH" value="c3ce23e5e27d2863d116a6f9c8d63f5e" /> |
| + | <input type="submit" value="Register" /> | ||
| </form> | </form> | ||
| </body> | </body> | ||
| Line 77: | Line 84: | ||
| ==== Response Body Fields ==== | ==== Response Body Fields ==== | ||
| - | Assuming valid details were sent, the Hosted Registration or Update page will be displayed, clicking on “Register” or “Update” will save the card details, result GET parameters will be forwarded to the Secure Card URL that is configured on the Terminal Setup page. The response body field will be: | + | Assuming valid details were sent, the Hosted Registration or Update page will be displayed, clicking on “Register” or “Update” will save the card details, result GET parameters will be forwarded to the Secure Token URL that is configured on the Terminal Setup page. The response body field will be: |
| <searchtable> | <searchtable> | ||
| Line 90: | Line 97: | ||
| | DATETIME | The time of the registration. Format: YYYY-MM-DDTHH:MM:SS. | | | DATETIME | The time of the registration. Format: YYYY-MM-DDTHH:MM:SS. | | ||
| | HASH | A HASH code formed by part of the response fields. The formation rule is given at the **ND001 - Hash Formation**, in the next section. | | | HASH | A HASH code formed by part of the response fields. The formation rule is given at the **ND001 - Hash Formation**, in the next section. | | ||
| + | | STOREDCREDENTIALUSE | Same as informed at the transaction's request. Returned if informed on request.| | ||
| + | | STOREDCREDENTIALTXTYPE | set as FIRST_TXN by default | | ||
| + | | BRANDTXIDENTIFIER | If STOREDCREDENTIALUSE is sent in request and secure token is validated - then returned by acquirer. | | ||
| </searchtable> | </searchtable> | ||
| \\ | \\ | ||
| Line 129: | Line 139: | ||
| <searchtable> | <searchtable> | ||
| ^ **CONSTRAINT** ^ **DESCRIPTION** ^ | ^ **CONSTRAINT** ^ **DESCRIPTION** ^ | ||
| - | | C001 | If invalid parameter values are sent, an Error Page will appear and the web browser will not be redirected to the Secure Card Receipt Page. This should not happen in a production environment after integration is completed. | | + | | C001 | If invalid parameter values are sent, an Error Page will appear and the web browser will not be redirected to the Secure Token Receipt Page. This should not happen in a production environment after integration is completed. | |
| </searchtable> | </searchtable> | ||
| \\ | \\ | ||