Contents x
    Void
    • 07 Oct 2025
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Void

    • Updated on 07 Oct 2025
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    This message is used to discard any payment action (Sale/Authorize) and it is based on the API communication model described in the Communication Model section.

    Request Parameters

    ParameterDescription
    MessageID
    required

    An alphanumeric value that represents the action for defined unique numbers as mentioned below: 

    • 3 for Void Message 
    • Field Type: Alphanumeric
    • Length: 2
    • Sample Data: 3
    MerchantID
    required
    		An alphanumeric value that represents the unique Merchant ID at SmartRoute. The Payment Gateway operation team provides this value based on the merchant enrollment.
    • Field Type: Alphanumeric
    • Length: 40
    • Sample Data: MID0001
    SecureHash
    required

    An alphanumeric value that represents the generated hex-encoded hash using hashing algorithm SHA-2 (256) by concatenating parameters as a single string starting with the merchant’s Merchant Authentication Token. Then all parameters (required parameters and optional parameters - if available) are ordered alphabetically. By parameter’s name should be part of the secure hash, with no separators and no terminating character.

    Appendix B: Secure Hash – Apple Pay Merchant Validation; for more information, see secure hash generation. 

    • Field Type: Alphanumeric
    • Length: 64
    • Sample Data: e9fbb3c46ec9c7dec2a318edc283bbbea27bc5d7bf7da30f4f2e62b89df74a2e

    Version
    optional

    A numeric value with (.) separator represents the command's version to be used. If this value is not provided, SmartRoute will consider its default value which is 1.0

    • Field Type: Numeric
    • Length: 5
    • Sample Data: 1.0
    OriginalTransactionID
    required
    		The transaction ID of the original transaction needs to be voided.
    • Field Type: Alphanumeric
    • Length: 40
    • Sample Data: 1440594083737

    Response Parameters

    ParameterDescription

    Response.StatusCode 
    required

    An alphanumeric value that represents the response code that covers errors generated by the SmartRoute.  

    Appendix A: Void message Response Codes for descriptive details about Response Codes. 

    • Field Type: Alphanumeric
    • Length: 5
    • Sample Data: 00000
    Response.StatusDescription 
    required
    		An alphanumeric value that represents a message describing the response status received from SmartRoute. This parameter is filled only after a complete execution process using the language specified in the request. This value should be UTF-8 encoded when it is entered into the secure hash generation process.
    • Field Type: Alphanumeric
    • Length: 100
    • Sample Data: Transaction was processed successfully
    Response.OriginalTransactionID  
    required

    The transaction ID of the original transaction needs to be voided.

    • Field Type: Alphanumeric
    • Length: 40
    • Sample Data: 1440594083737
    Response.MerchantID 
    required    		An alphanumeric value that represents the unique ID of the merchant at SmartRoute. The SmartRoute operation team provides this value upon merchant enrollment. 
    • Field Type: Alphanumeric
    • Length: 40
    • Sample Data: MID0001
    Response.MessageID 
    required

    An alphanumeric value that represents the action for defined unique numbers as mentioned below: 

    • 3 for Void Message 
    • Field Type: Alphanumeric
    • Length: 2
    • Sample Data: 3
    Response.SecureHash 
    required

    An alphanumeric value that represents the generated hex-encoded hash using hashing algorithm SHA-2 (256) by concatenating parameters as a single string starting with the merchant’s Merchant Authentication Token. Then all response parameters are appended in alphabetical order based on the parameter’s name, with no separators and no terminating character.

    Appendix B: Secure Hash – Void Message; for more information, see secure hash generation. 

    • Field Type: Alphanumeric
    • Length: 64
    • Sample Data: e9fbb3c46ec9c7dec2a318edc283bbbea27bc5d7bf7da30f4f2e62b89df74a2e
    What's Next