ToggleVoucherFeature

Toggles a voucher feature on or off

Request Path Parameters

Parameter	type	Limits	required	Description
terminalID	String	10 characters	✓	The Paymentology issued terminal ID of the terminal requesting the transaction
profileNumber	String	1-20 characters	✓	Profile number linked with this card
cardIdentifier	String	1-20 characters	✓	The card number, sequence number or tracking number of the specified card.
featureName	String	1-255 characters	✓	Name of the feature to be enabled/disabled.; ; Possible values:; ; ENABLE_INTERNATIONAL; ; OPT_IN_VAU; ; OPT_OUT_ABU; ; OPT_OUT_VAU; ; ATM_ENABLED; ; NFC_ENABLED; ; POS_ENABLED; ; ECOM_ENABLED
featureStatus	Boolean		✓	Status to be applied.(True/False)
transactionID	String	1-255 characters	✓	A unique identifier generated by the client, which must not be duplicated over time.
transactionDate	Date		✓	Transaction date generated by the calling client
checksum	String	1-255 characters	✓	HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key.

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>ToggleVoucherFeature</methodName>
  <params>
    <param>
      <value>
        <string>123456789</string>
      </value>
    </param>
    <param>
      <value>
        <string>12345</string>
      </value>
    </param>
    <param>
      <value>
        <string>5165641045432078</string>
      </value>
    </param>
    <param>
      <value>
        <string>NFC_ENABLED</string>
      </value>
    </param>
    <param>
      <value>
        <int>1</int>
      </value>
    </param>
    <param>
      <value>
        <string>4f012b3a3d456d2ba789b8dcadf2ccf9</string>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20240724T23:54:28</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <string>12345678930</string>
      </value>
    </param>
  </params>
</methodCall>

Response Parameters

Parameter	type	Description
cardIdentifier	String	Echo of incoming value.
resultCode	Integer	Status code indicating transaction result.
terminalID	String	Echo of incoming value.
profileNumber	String	Echo of incoming value.
featureName	String
resultText	String	Status text indicating transaction result.
transactionDate	String	Echo of incoming value.
transactionID	String	Echo of incoming value.
featureStatus	Boolean

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>cardIdentifier</name>
            <value>
              <string>5165641045432078</string>
            </value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>1</int>
            </value>
          </member>
          <member>
            <name>terminalID</name>
            <value>
              <string>123456789</string>
            </value>
          </member>
          <member>
            <name>profileNumber</name>
            <value>
              <string>12345</string>
            </value>
          </member>
          <member>
            <name>featureName</name>
            <value>
              <string>NFC_ENABLED</string>
            </value>
          </member>
          <member>
            <name>resultText</name>
            <value>
              <string>NFC_ENABLED was turned on</string>
            </value>
          </member>
          <member>
            <name>transactionDate</name>
            <value>
              <dateTime.iso8601>20240724T23:54:28</dateTime.iso8601>
            </value>
          </member>
          <member>
            <name>transactionID</name>
            <value>
              <string>4f012b3a3d456d2ba789b8dcadf2ccf9</string>
            </value>
          </member>
          <member>
            <name>featureStatus</name>
            <value>
              <boolean>1</boolean>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>