Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
developer:api_specification:hpp_subscription_features [2018/12/03 10:26]
127.0.0.1 external edit
developer:api_specification:hpp_subscription_features [2022/03/31 08:31] (current)
lezlieh update with secure token
Line 6: Line 6:
 This feature enables you to create a Subscription using the Hosted Page method. For more details on Subscriptions,​ please visit the **[[merchant:​new_merchant:​products#​suscription|Products]]** page. This feature enables you to create a Subscription using the Hosted Page method. For more details on Subscriptions,​ please visit the **[[merchant:​new_merchant:​products#​suscription|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 creation'​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 creation'​s response.
  
 ===== Subscription Registration ===== ===== Subscription Registration =====
Line 21: Line 21:
 | MERCHANTREF | Y | Unique reference assigned by the Merchant site/ solution to identify the subscription details. The length is limited to 48 characters. | | MERCHANTREF | Y | Unique reference assigned by the Merchant site/ solution to identify the subscription details. The length is limited to 48 characters. |
 | STOREDSUBSCRIPTIONREF | Y | Reference of a previously created stored subscription,​ at %Slafcare System. This field is required if the new Subscription being created is going to be based on an already existing Stored Subscription. | | STOREDSUBSCRIPTIONREF | Y | Reference of a previously created stored subscription,​ at %Slafcare System. This field is required if the new Subscription being created is going to be based on an already existing Stored Subscription. |
-| SECURECARDMERCHANTREF | Y | Merchant reference of a previously created Secure ​Card, which will be used to do set-up and recurring payments.\\ You should either use the SECURECARDMERCHANTREF,​ or CARDREFERENCE fields on your request. |  +| SECURECARDMERCHANTREF | Y | Merchant reference of a previously created Secure ​Token, which will be used to do set-up and recurring payments.\\ You should either use the SECURECARDMERCHANTREF,​ or CARDREFERENCE fields on your request. |  
-| CARDREFERENCE | Y | Payment Gateway Reference of a previously created Secure ​Card.\\ You should either use the SECURECARDMERCHANTREF,​ or CARDREFERENCE fields on your request. | +| CARDREFERENCE | Y | Payment Gateway Reference of a previously created Secure ​Token.\\ You should either use the SECURECARDMERCHANTREF,​ or CARDREFERENCE fields on your request. |
 | SUBSCRIPTIONRECURRINGAMOUNT | N | Cost of each payment to be processed for the subscription.\\ This field should only be informed if the Stored Subscription (STOREDSUBSCRIPTIONREF) type is Automatic (without amounts). | | SUBSCRIPTIONRECURRINGAMOUNT | N | Cost of each payment to be processed for the subscription.\\ This field should only be informed if the Stored Subscription (STOREDSUBSCRIPTIONREF) type is Automatic (without amounts). |
 | SUBSCRIPTIONINITIALAMOUNT | N | Initial (set-up) payment to be taken off card. Payment will not be taken if it is 0. Should only be sent if Stored Subscription (STOREDSUBSCRIPTIONREF) type is Automatic (without amount). | | SUBSCRIPTIONINITIALAMOUNT | N | Initial (set-up) payment to be taken off card. Payment will not be taken if it is 0. Should only be sent if Stored Subscription (STOREDSUBSCRIPTIONREF) type is Automatic (without amount). |
Line 38: Line 38:
 | 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 subscription details. The length is limited to 48 characters. | | MERCHANTREF | Y | Unique reference assigned by the Merchant site/ solution to identify the subscription details. The length is limited to 48 characters. |
-| SECURECARDMERCHANTREF | Y | Merchant reference of a previously created Secure ​Card, which will be used to do set-up and recurring payments.\\ You should either use the SECURECARDMERCHANTREF,​ or CARDREFERENCE fields on your request. |  +| SECURECARDMERCHANTREF | Y | Merchant reference of a previously created Secure ​Token, which will be used to do set-up and recurring payments.\\ You should either use the SECURECARDMERCHANTREF,​ or CARDREFERENCE fields on your request. |  
-| CARDREFERENCE | Y | Payment Gateway Reference of a previously created Secure ​Card.\\ You should either use the SECURECARDMERCHANTREF,​ or CARDREFERENCE fields on your request. |+| CARDREFERENCE | Y | Payment Gateway Reference of a previously created Secure ​Token.\\ You should either use the SECURECARDMERCHANTREF,​ or CARDREFERENCE fields on your request. |
 | 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. |
 | STARTDATE | Y | Subscription start date. |  | STARTDATE | Y | Subscription start date. |
Line 82: Line 82:
   * **Scenario**:​ Minimum request, with only mandatory data, based on an existing Stored Subscription.   * **Scenario**:​ Minimum request, with only mandatory data, based on an existing Stored Subscription.
   * **Stored Subscription Ref**: 6523423.   * **Stored Subscription Ref**: 6523423.
-  * **Secure ​Card Reference**:​ 237498.+  * **Secure ​Token Reference**:​ 237498.
   * **Terminal Secret**: x4n35c32RT.   * **Terminal Secret**: x4n35c32RT.
  
Line 112: Line 112:
 ==== Response Body Fields ==== ==== Response Body Fields ====
  
-Assuming valid details were sent, the Subscription Registration Hosted page will be displayed, clicking on "​Accept & Subscribe"​ button will create the subscription only if the setup amount authorises successfully,​ and the resulting GET parameters will be forwarded to the Subscription Receipt URL that is configured on the Terminal Setup page. If the Subscription Secure ​Card currency is different from the Stored Subscription currency, then an eDCC Decision Page will be displayed, and the customer will have to decide if eDCC should be used for the initial and all subsequent payments for the subscription. The response body field will be:+Assuming valid details were sent, the Subscription Registration Hosted page will be displayed, clicking on "​Accept & Subscribe"​ button will create the subscription only if the setup amount authorises successfully,​ and the resulting GET parameters will be forwarded to the Subscription Receipt URL that is configured on the Terminal Setup page. If the Subscription Secure ​Token currency is different from the Stored Subscription currency, then an eDCC Decision Page will be displayed, and the customer will have to decide if eDCC should be used for the initial and all subsequent payments for the subscription. The response body field will be:
  
 <​searchtable>​ <​searchtable>​
Line 161: Line 161:
 | E30 | INVALID STORED SUBSCRIPTION REF | | E30 | INVALID STORED SUBSCRIPTION REF |
 | E31 | INVALID STORED SUBSCRIPTION MERCHANT REF | | E31 | INVALID STORED SUBSCRIPTION MERCHANT REF |
-| E32 | INVALID SECURE ​CARD MERCHANT REF |+| E32 | INVALID SECURE ​TOKEN MERCHANT REF |
 | E33 | INVALID STARTDATE | | E33 | INVALID STARTDATE |
 | E34 | INVALID ENDDATE | | E34 | INVALID ENDDATE |
Line 168: Line 168:
 | E37 | INVALID SUBSCRIPTIONRECURRINGAMOUNT | | E37 | INVALID SUBSCRIPTIONRECURRINGAMOUNT |
 | E38 | INVALID SUBSCRIPTIONINITIALAMOUNT | | E38 | INVALID SUBSCRIPTIONINITIALAMOUNT |
-| E39 | SECURE ​CARD NOT VALIDATED |+| E39 | SECURE ​TOKEN NOT VALIDATED |
 | E41 | PASS ONLY ONE OF CARDREFERENCE OR SECURECARDMERCHANTREF OR SECUREACHACCOUNTMERCHANTREF | | E41 | PASS ONLY ONE OF CARDREFERENCE OR SECURECARDMERCHANTREF OR SECUREACHACCOUNTMERCHANTREF |
-| E48 | INVALID SECURE ​CARD REFERENCE |+| E48 | INVALID SECURE ​TOKEN REFERENCE |
 \\ \\
  
Line 177: Line 177:
 <​searchtable>​ <​searchtable>​
 ^ **CONSTRAINT** ^ **DESCRIPTION** ^ ^ **CONSTRAINT** ^ **DESCRIPTION** ^
-| C001 | To created a subscription,​ you need to inform a valid, existing Secure ​Card. You may either used the SECURECARDMERCHANTREF or the CARDREFERENCE field for that, but only one of those. |+| C001 | To created a subscription,​ you need to inform a valid, existing Secure ​Token. You may either used the SECURECARDMERCHANTREF or the CARDREFERENCE field for that, but only one of those. |
 | C002 | When requesting the creation of a new Subscription,​ you may also created your Stored Subscription,​ or use an existing one, but you can only use the fields of one of these options. | | C002 | When requesting the creation of a new Subscription,​ you may also created your Stored Subscription,​ or use an existing one, but you can only use the fields of one of these options. |
 | C003 | When requesting the creation of a new Subscription based on an existing Stored Subscription,​ you need to provide a valid Stored Subscription. | | C003 | When requesting the creation of a new Subscription based on an existing Stored Subscription,​ you need to provide a valid Stored Subscription. |
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International