ToggleVoucherFeature

Toggles a voucher feature on or off

Request

Path parameters

terminalID

string,  10 characters,  required

The Paymentology issued terminal ID of the terminal requesting the transaction

profileNumber

string,  1-20 characters,  required

Profile number linked with this card

cardIdentifier

string,  1-20 characters,  required

The card number, sequence number or tracking number of the specified card.

featureName

string,  1-255 characters,  required

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,  required

Status to be applied.(True/False)

transactionID

string,  1-255 characters,  required

A unique identifier generated by the client, which must not be duplicated over time.

transactionDate

date,  required

Transaction date generated by the calling client

checksum

string,  1-255 characters,  required

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

STATUS200 OK

Schema

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>

Was this page helpful?

Are you ready to use our APIs

If you are not yet registered with us.

Still have questions? Contact us.