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

customerReference

string,  1-20 characters,  required

Customer reference linked with this card

trackingNumber

string,  1-20 characters,  required

The tracking number of the card

featureName

string,  required

The name of the feature to disable – only supports PHYSICAL_CARD_DISABLED
Possible values: PHYSICAL_CARD_DISABLED

featureStatus

boolean,  required

The status of the feature. Possible values 1 or 0. To enable the feature this should be 1, to disable it this field should be 0.

transactionID

string,  1-255 characters,  required

Transaction ID number generated by the calling client

transactionDate

date,  required

Transaction date generated by the calling client

checksum

string,  1-255 characters,  required

HMAC-SHA1 hashed signature of the concatenated method name with all argument values using the terminal password as private key

<methodCall>
  <methodName>ToggleVoucherFeature</methodName>
  <params>
    <param>
      <value>
        <string>123456789</string>
      </value>
    </param>
    <param>
      <value>
        <string>Demo Ref</string>
      </value>
    </param>
    <param>
      <value>
        <string>123456789</string>
      </value>
    </param>
    <param>
      <value>
        <string>13245678</string>
      </value>
    </param>
    <param>
      <value>
        <boolean>1</boolean>
      </value>
    </param>
    <param>
      <value>
        <string>2321345</string>
      </value>
    </param>
    <param>
      <value>
        <dateTime.iso8601>20191007T00:00:00</dateTime.iso8601>
      </value>
    </param>
    <param>
      <value>
        <string>B2D78C6F5710AC56E8899A23E4FE6D20975576B5</string>
      </value>
    </param>
  </params>
</methodCall>

Response

STATUS200 OK

Schema

resultCode

integer

Status code indicating transaction result

resultText

string

Status text indicating transaction result

<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>OK</string>
                        </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.