XML Subscription Features

The subscription features, presented in this page, allow your integration to manage recurring payments in the Gateway Platform.

The Worldnet Subscription is a versatile solution which can be used in two main ways:

• 1. Automatic Subscription: This is a fully automated solution that will manage the lifetime of a recurring payment once it is registered and notify the merchant of any issues that happen during it's lifetime.

• 2. Manual Subscription: With this solution, recurring payments are set up in our system just as they are for automatic payments. The main difference is that our system does not actually process payments automatically. Instead, when a payment is pending, the merchant should initiate the payment, either via and “XML Payment Request” or through the SelfCare System. Another difference with this method is that you can modify the amount of the payment.

The Subscription solution has two big components:

• Stored Subscriptions: They act not as subscription, but as templates for multiple subscriptions registered under them. They define the period (weekly / monthly / quarterly / annually), the number of those periods (if it's a fixed number), setup price, recurring price, etc. They are intended to represent a product, for example. This way you can define “models” which can be applied to many clients with the same settings.

• Subscriptions: Those are the actual subscriptions. Every subscription set up has to be under a Stored Subscription. However some of the settings of the stored subscription can be overruled by the Subscription itself, as you will see below. Subscriptions are intended to represent a specific order of a product represented by the stored subscription that it's under. Also, represents the “charging” configuration for a specific client.

The following resources are the same for all the requests and responses you find in this page:

Use the Request URL and the Request Body Fields to perform a request for this feature, then prepare your integration to receive the response, as defined by the Response Body Fields.

This feature allows you to perform the registration of a stored subscription.

• Main Request body Tag: <ADDSTOREDSUBSCRIPTION>
• Main Response body Tag: <ADDSTOREDSUBSCRIPTIONRESPONSE>

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

• Scenario: Simple request to create stored subscription.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<ADDSTOREDSUBSCRIPTION>
	<MERCHANTREF>MR001</MERCHANTREF>
	<TERMINALID>6491002</TERMINALID>
	<DATETIME>30-07-2009:15:26:38:027</DATETIME>
	<NAME>Animal Life</NAME>
	<DESCRIPTION>Magazine membership</DESCRIPTION>
	<PERIODTYPE>MONTHLY</PERIODTYPE>
	<LENGTH>12</LENGTH>
	<CURRENCY>EUR</CURRENCY>
	<RECURRINGAMOUNT>15.87</RECURRINGAMOUNT>
	<INITIALAMOUNT>10.99</INITIALAMOUNT>
	<TYPE>AUTOMATIC</TYPE>
	<ONUPDATE>CONTINUE</ONUPDATE>
	<ONDELETE>CANCEL</ONDELETE>
	<HASH>750f7c545a3d63ecaf3b48c149b95555</HASH>
</ADDSTOREDSUBSCRIPTION>

The response body fields will be:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Response Codes - Errors

• Scenario: Response to the simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<ADDSTOREDSUBSCRIPTIONRESPONSE>
	<MERCHANTREF>13231</MERCHANTREF>
	<DATETIME>30-07-2009:15:26:39:745</DATETIME>
	<HASH>d04c3bab519095ecb046eff91722e8df</HASH>
</ADDSTOREDSUBSCRIPTIONRESPONSE>

This feature allows you to perform the update of a valid stored subscription.

• Main Request body Tag: <UPDATESTOREDSUBSCRIPTION>
• Main Response body Tag: <UPDATESTOREDSUBSCRIPTIONRESPONSE>

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

• Scenario: Simple request to update stored subscription.
• Merchant referece: 13231.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<UPDATESTOREDSUBSCRIPTION>
	<MERCHANTREF>13231</MERCHANTREF>
	<TERMINALID>6491002</TERMINALID>
	<DATETIME>31-07-2009:16:07:21:000</DATETIME>
	<NAME>Animal Life</NAME>
	<DESCRIPTION>Magazine membership</DESCRIPTION>
	<LENGTH>12</LENGTH>
	<CURRENCY>EUR</CURRENCY>
	<RECURRINGAMOUNT>15.99</RECURRINGAMOUNT>
	<INITIALAMOUNT>10.99</INITIALAMOUNT>
	<TYPE>AUTOMATIC</TYPE>
	<ONUPDATE>CONTINUE</ONUPDATE>
	<ONDELETE>CANCEL</ONDELETE>
	<HASH>5023bbb6726d1b5d2dcb7c77fb11b94f</HASH>
</UPDATESTOREDSUBSCRIPTION>

The response body fields will be:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Response Codes - Errors

• Scenario: Response to the simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<UPDATESTOREDSUBSCRIPTIONRESPONSE>
	<MERCHANTREF>13231</MERCHANTREF>
	<DATETIME>31-07-2009:16:07:21:329</DATETIME>
	<HASH>0af49616cad0fd1e19bc709de7d7c934</HASH>
</UPDATESTOREDSUBSCRIPTIONRESPONSE>

This feature allows you to delete a valid stored subscription.

• Main Request body Tag: <DELETESTOREDSUBSCRIPTION>
• Main Response body Tag: <DELETESTOREDSUBSCRIPTIONRESPONSE>

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

• Scenario: Simple request to delete existing stored subscription.
• Terminal: 6491002.
• Merchant reference: 13231.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<DELETESTOREDSUBSCRIPTION>
	<MERCHANTREF>13231</MERCHANTREF>
	<TERMINALID>6491002</TERMINALID>
	<DATETIME>31-07-2009:20:49:34:798</DATETIME>
	<HASH>efc5a04b5a98be9bd59ec5383abb9161</HASH>
</DELETESTOREDSUBSCRIPTION>

The response body fields will be:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Response Codes - Errors

• Scenario: Response to the simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<DELETESTOREDSUBSCRIPTIONRESPONSE>
	<MERCHANTREF>13231</MERCHANTREF>
	<DATETIME>31-07-2009:20:49:35:381</DATETIME>
	<HASH>8a8f462278c730e9de5561d8f186d7dc</HASH>
</DELETESTOREDSUBSCRIPTIONRESPONSE>

This feature allows you to perform the registration of a subscription. Additionally to that, you can also, while registering the subscription, register a stored subscription, by just adding its fields to the request.

• Main Request body Tag: <ADDSUBSCRIPTION>
• Main Response body Tag: <ADDSUBSCRIPTIONRESPONSE>

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

If using the SECURECARDMERCHANTREF field to create the subscription:

If using the CARDREFERENCE field to create the subscription:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Stored Subscription Creation with Subcription

The following fields represent the nested elements of NEWSTOREDSUBSCRIPTIONINFO, to be used qhen creating the stored subscription at the same time as the subscription.

ND004 - Level 2 Data Validation

This field is associated with the Transaction Enhanced Data feature, and to be used it is necessary to have the “Allow Enhanced Data (Level II and Level III)” enabled with the “Transaction Data Level” option set as “Level II” on the Processing Terminal “Features” section.

To provide a transaction with LEVEL 2, your request needs to add the LEVEL_2_DATA component and its fields, as described below.

Quick example:

<LEVEL_2_DATA>
    <CUSTOMER_REF_NUMBER>SDGK-JSAAS-0235.00002314</CUSTOMER_REF_NUMBER>
    <TAX_AMOUNT>151.27</TAX_AMOUNT>
    <SHIPPING_ADDRESS>
		<FULL_NAME>JOHN SMITH AND ASSOCIATES</FULL_NAME>
		<ADDRESS1>Unit 001, Street X</ADDRESS1>
		<ADDRESS2>Block "A", Neighborhood "A"</ADDRESS2>
		<CITY>City "Y"</CITY>
		<REGION>Region 1</REGION>
		<POSTCODE>A00B0001</POSTCODE>
		<COUNTRY>Country "Z"</COUNTRY>
	</SHIPPING_ADDRESS>
</LEVEL_2_DATA>

ND005 - Level 3 Data Validation

This field is associated with the Transaction Enhanced Data feature, and to be used it is necessary to have the “Allow Enhanced Data (Level II and Level III)” enabled with the “Transaction Data Level” option set as “Level III” on the Processing Terminal “Features” section.

To provide a transaction with LEVEL 3, your request needs to add the LEVEL_2_DATA (described before) and the LEVEL_3_DATA components and their fields. The LEVEL_3_DATA component fields are described below.

Quick example:

<LEVEL_2_DATA>...</LEVEL_2_DATA>
<LEVEL_3_DATA>
    <SUMMARY>
        <TOTAL_DISCOUNT_AMOUNT>61.30</TOTAL_DISCOUNT_AMOUNT>
        <TOTAL_FREIGHT_AMOUNT>3.50</TOTAL_FREIGHT_AMOUNT>
        <TOTAL_DUTY_AMOUNT>11.50</TOTAL_DUTY_AMOUNT>
    </SUMMARY>
    <LINE_ITEMS> 
        <!-- As many as necessary -->
        <LINE_ITEM>
            <COMMODITY_CODE>PDX001</COMMODITY_CODE>
            <PRODUCT_CODE>DSV1303.090.00001</PRODUCT_CODE>
            <DESCRIPTION>General services</DESCRIPTION>
            <QUANTITY>10</QUANTITY>
            <UNIT_OF_MEASURE>Hour</UNIT_OF_MEASURE>
            <UNIT_PRICE>105.50</UNIT_PRICE>
            <DISCOUNT_RATE>5.00</DISCOUNT_RATE>
            <TAX_RATE>12.50</TAX_RATE>
            <TOTAL_AMOUNT>1127.53</TOTAL_AMOUNT>
        </LINE_ITEM>
        <LINE_ITEM>
            <COMMODITY_CODE>PDX002</COMMODITY_CODE>
            <PRODUCT_CODE>DSV1302.090.00001</PRODUCT_CODE>
            <DESCRIPTION>General services</DESCRIPTION>
            <QUANTITY>2</QUANTITY>
            <UNIT_OF_MEASURE>Hour</UNIT_OF_MEASURE>
            <UNIT_PRICE>85.50</UNIT_PRICE>
            <DISCOUNT_RATE>5.00</DISCOUNT_RATE>
            <TAX_RATE>16.00</TAX_RATE>
            <TOTAL_AMOUNT>188.44</TOTAL_AMOUNT>
        </LINE_ITEM>
    </LINE_ITEMS>
</LEVEL_3_DATA>

• Scenario: Simple request to create a subscription.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<ADDSUBSCRIPTION>
	<MERCHANTREF>MR01-02</MERCHANTREF>
	<TERMINALID>6491002</TERMINALID>
	<STOREDSUBSCRIPTIONREF>MR01</STOREDSUBSCRIPTIONREF>
	<SECURECARDMERCHANTREF>7126</SECURECARDMERCHANTREF>
	<DATETIME>30-07-2009:15:34:23:671</DATETIME>
	<STARTDATE>01-08-2009</STARTDATE>
	<ENDDATE>31-07-2010</ENDDATE>
	<EDCCDECISION>Y</EDCCDECISION>
        <HASH>99a8addc5cac111c21a9aa48aae3c363</HASH>
	<CUSTOMFIELD NAME=”ACCOUNTID”>9238746529</CUSTOMFIELD>
	<CUSTOMFIELD NAME=”EVENTID”>44</CUSTOMFIELD>
</ADDSUBSCRIPTION>

• Scenario: Request to create a subscription, creating a stored subscription at the same time.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<ADDSUBSCRIPTION>
	<MERCHANTREF>MR02-02</MERCHANTREF>
	<TERMINALID>6491002</TERMINALID>
	<SECURECARDMERCHANTREF>7126</SECURECARDMERCHANTREF>
	<DATETIME>30-07-2009:15:34:23:671</DATETIME>
	<STARTDATE>01-08-2009</STARTDATE>
	<ENDDATE>31-07-2010</ENDDATE>
	<EDCCDECISION>Y</EDCCDECISION>
	<NEWSTOREDSUBSCRIPTIONINFO>
		<MERCHANTREF>MR001</MERCHANTREF>
		<NAME>Animal Life</NAME>
		<DESCRIPTION>Magazine membership</DESCRIPTION>
		<PERIODTYPE>MONTHLY</PERIODTYPE>
		<LENGTH>12</LENGTH>
		<CURRENCY>EUR</CURRENCY>
		<RECURRINGAMOUNT>15.87</RECURRINGAMOUNT>
		<INITIALAMOUNT>10.99</INITIALAMOUNT>
		<TYPE>AUTOMATIC</TYPE>
		<ONUPDATE>CONTINUE</ONUPDATE>
		<ONDELETE>CANCEL</ONDELETE>
	</NEWSTOREDSUBSCRIPTIONINFO>
	<HASH>8515ccc5605651c12ab0645f79eb0271</HASH>
	<CUSTOMFIELD NAME=”ACCOUNTID”>9238746529</CUSTOMFIELD>
	<CUSTOMFIELD NAME=”EVENTID”>44</CUSTOMFIELD>
</ADDSUBSCRIPTION>

The response body fields will be:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Response Codes - Errors

• Scenario: Response to the simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<ADDSUBSCRIPTIONRESPONSE>
	<MERCHANTREF>MR02-02</MERCHANTREF>
	<DATETIME>30-07-2009:15:34:24:305</DATETIME>
	<HASH>8bb39be67a1f05bf73fe334e12037257</HASH>
</ADDSUBSCRIPTIONRESPONSE>

This feature allows you to perform the update of an existing and valid subscription.

• Main Request body Tag: <UPDATESUBSCRIPTION>
• Main Response body Tag: <UPDATESUBSCRIPTIONRESPONSE>

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

If you are using the SECURECARDMERCHANTREF:

If you are using the CARDREFERENCE:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Level 2 Data Validation

This field is associated with the Transaction Enhanced Data feature, and to be used it is necessary to have the “Allow Enhanced Data (Level II and Level III)” enabled with the “Transaction Data Level” option set as “Level II” on the Processing Terminal “Features” section.

To provide a transaction with LEVEL 2, your request needs to add the LEVEL_2_DATA component and its fields, as described below.

Quick example:

<LEVEL_2_DATA>
    <CUSTOMER_REF_NUMBER>SDGK-JSAAS-0235.00002314</CUSTOMER_REF_NUMBER>
    <TAX_AMOUNT>151.27</TAX_AMOUNT>
    <SHIPPING_ADDRESS>
		<FULL_NAME>JOHN SMITH AND ASSOCIATES</FULL_NAME>
		<ADDRESS1>Unit 001, Street X</ADDRESS1>
		<ADDRESS2>Block "A", Neighborhood "A"</ADDRESS2>
		<CITY>City "Y"</CITY>
		<REGION>Region 1</REGION>
		<POSTCODE>A00B0001</POSTCODE>
		<COUNTRY>Country "Z"</COUNTRY>
	</SHIPPING_ADDRESS>
</LEVEL_2_DATA>

ND004 - Level 3 Data Validation

This field is associated with the Transaction Enhanced Data feature, and to be used it is necessary to have the “Allow Enhanced Data (Level II and Level III)” enabled with the “Transaction Data Level” option set as “Level III” on the Processing Terminal “Features” section.

To provide a transaction with LEVEL 3, your request needs to add the LEVEL_2_DATA (described before) and the LEVEL_3_DATA components and their fields. The LEVEL_3_DATA component fields are described below.

Quick example:

<LEVEL_2_DATA>...</LEVEL_2_DATA>
<LEVEL_3_DATA>
    <SUMMARY>
        <TOTAL_DISCOUNT_AMOUNT>61.30</TOTAL_DISCOUNT_AMOUNT>
        <TOTAL_FREIGHT_AMOUNT>3.50</TOTAL_FREIGHT_AMOUNT>
        <TOTAL_DUTY_AMOUNT>11.50</TOTAL_DUTY_AMOUNT>
    </SUMMARY>
    <LINE_ITEMS> 
        <!-- As many as necessary -->
        <LINE_ITEM>
            <COMMODITY_CODE>PDX001</COMMODITY_CODE>
            <PRODUCT_CODE>DSV1303.090.00001</PRODUCT_CODE>
            <DESCRIPTION>General services</DESCRIPTION>
            <QUANTITY>10</QUANTITY>
            <UNIT_OF_MEASURE>Hour</UNIT_OF_MEASURE>
            <UNIT_PRICE>105.50</UNIT_PRICE>
            <DISCOUNT_RATE>5.00</DISCOUNT_RATE>
            <TAX_RATE>12.50</TAX_RATE>
            <TOTAL_AMOUNT>1127.53</TOTAL_AMOUNT>
        </LINE_ITEM>
        <LINE_ITEM>
            <COMMODITY_CODE>PDX002</COMMODITY_CODE>
            <PRODUCT_CODE>DSV1302.090.00001</PRODUCT_CODE>
            <DESCRIPTION>General services</DESCRIPTION>
            <QUANTITY>2</QUANTITY>
            <UNIT_OF_MEASURE>Hour</UNIT_OF_MEASURE>
            <UNIT_PRICE>85.50</UNIT_PRICE>
            <DISCOUNT_RATE>5.00</DISCOUNT_RATE>
            <TAX_RATE>16.00</TAX_RATE>
            <TOTAL_AMOUNT>188.44</TOTAL_AMOUNT>
        </LINE_ITEM>
    </LINE_ITEMS>
</LEVEL_3_DATA>

• Scenario: Simple request to update valid subscription.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?> 
<UPDATESUBSCRIPTION>  
       <MERCHANTREF>MR001</MERCHANTREF>  
       <TERMINALID>6491002</TERMINALID>  
       <SECURECARDMERCHANTREF>8328</SECURECARDMERCHANTREF>  
       <DATETIME>30-07-2009:09:59:38:921</DATETIME>  
       <NAME>Animal Life</NAME>  
       <DESCRIPTION>Magazine membership</DESCRIPTION>  
       <PERIODTYPE>MONTHLY</PERIODTYPE>  
       <LENGTH>12</LENGTH>  
       <RECURRINGAMOUNT>15.87</RECURRINGAMOUNT>  
       <STARTDATE>23-08-2009</STARTDATE>  
       <ENDDATE>22-08-2010</ENDDATE>  
       <EDCCDECISION>Y</EDCCDECISION>  
       <HASH>53b6917aac8eb179e8b80f754c4afd5c</HASH> 
</UPDATESUBSCRIPTION> 

The response body fields will be:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Response Codes - Errors

• Scenario: Response to the simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?> 
<UPDATESUBSCRIPTIONRESPONSE>  
      <MERCHANTREF>MR02-02</MERCHANTREF>  
      <DATETIME>30-07-2009:15:34:24:305</DATETIME> 
      <HASH>8bb39be67a1f05bf73fe334e12037257</HASH>             
</UPDATESUBSCRIPTIONRESPONSE>

This feature allows you to delete an existing subscription.

• Main Request body Tag: <DELETESUBSCRIPTION>
• Main Response body Tag: <DELETESUBSCRIPTIONRESPONSE>

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

• Scenario: Simple request to delete a subscription.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<DELETESUBSCRIPTION>
	<MERCHANTREF>MR002</MERCHANTREF>
	<TERMINALID>6491002</TERMINALID>
	<DATETIME>31-07-2009:11:03:42:328</DATETIME>
	<HASH>53b6917aac8eb179e8b80f754c4afd5c</HASH>
</DELETESUBSCRIPTION>

The response body fields will be:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Response Codes - Errors

• Scenario: Response to the simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<DELETESUBSCRIPTIONRESPONSE>
	<MERCHANTREF>MR02-02</MERCHANTREF>
	<DATETIME>30-07-2009:15:34:24:305</DATETIME>
	<HASH>8bb39be67a1f05bf73fe334e12037257</HASH>
</DELETESUBSCRIPTIONRESPONSE>

Manual recurring payment can be done using this subscription feature. Also, when an automatic subscription has any problems and could not process a payment automatically, because of card details expiration or other issue, this missing payment can also be executed in the same way as a manual subscription payment, after the problems with the payment details is solved.

This feature allows you to perform a payment of a subscription.

• Main Request body Tag: <SUBSCRIPTIONPAYMENT>
• Main Response body Tag: <SUBSCRIPTIONPAYMENTRESPONSE>

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Using eDCC

All eDCC enabled XML requests must include FOREIGNCURRENCYINFORMATION tag and it nested tags.

Those fields can be obtained by using the eDCC Exchange Rate feature.

• Scenario: Simple subscription payment request with FOREIGNCURRENCYINFORMATION.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<SUBSCRIPTIONPAYMENT>
	<ORDERID>8362</ORDERID>
	<TERMINALID>6491002</TERMINALID>
	<AMOUNT>87.78</AMOUNT>
	<SUBSCRIPTIONREF>311</SUBSCRIPTIONREF>
	<FOREIGNCURRENCYINFORMATION>
		<CARDCURRENCY>JPY</CARDCURRENCY>
		<CARDAMOUNT>10638</CARDAMOUNT>
		<CONVERSIONRATE>121.186190</CONVERSIONRATE>
	</FOREIGNCURRENCYINFORMATION>
	<EMAIL>cardholder_email@worldnettps.com</EMAIL>
	<DATETIME>31-07-2009:14:09:59:121</DATETIME>
	<HASH>53b6917aac8eb179e8b80f754c4afd5c</HASH>
	<CUSTOMFIELD NAME=”ACCOUNTID”>132453462</CUSTOMFIELD>
	<CUSTOMFIELD NAME=”EVENTID”>FG00001</CUSTOMFIELD>
</SUBSCRIPTIONPAYMENT>

The response body fields will be:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

• Scenario: .
• Terminal: .
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<SUBSCRIPTIONPAYMENTRESPONSE>
	<RESPONSECODE>A</RESPONSECODE>
	<RESPONSETEXT>APPROVAL</RESPONSETEXT>
	<APPROVALCODE>406243</APPROVALCODE>
	<DATETIME>31-07-2009:14:10:03:834</DATETIME>
	<HASH>6dd32c4b61f180dd791310f9c07d76a1</HASH>
</SUBSCRIPTIONPAYMENTRESPONSE>

The subscription notification is a feature which allows the Payment Gateway to notify the Merchant about events associated to its subscriptions.

This is only possible when the Subscription Notification URL is informed at the Terminal configuration - you can see it at the Terminal Setup page of the SelfCare System. If the URL is in place, a POST notification will be sent to this URL each time an automated activity happens on any active subscriptions. Note that manual changes applied to subscriptions via the SelfCare System will not generate these notifications.

The data sent to the Subscription Notification URL contains all the normal subscription response fields (depending on the action performed, as NOTIFICATIOTYPE), plus the following extra fields below. So, to know how each notification body works, you need to consider the same body of each feature of the Subscription solution, then add the following fields:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

When the NOTIFICATIONTYPE is SUBSCRIPTIONSETUPPAYMENT or SUBSCRIPTIONRECURRINGPAYMENT:

Any other case:

Note that for Stored Subscriptions, RESPONSECODE and RESPONSETEXT, will always be blank.

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

The successful response expected to this request is a body containing a “OK” with a HTTP Status of 200. Anything else will be considered an unsuccessful attempt of notification by the Payment Gateway.