Contents x
    Apple Pay Merchant Validation
    • 02 Apr 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Apple Pay Merchant Validation

    • Updated on 02 Apr 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    After clicking the Apple Pay button:

    • Validates the Apple Pay Merchant
    • Request a valid Apple Pay session from the Apple Pay server

    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: 

    • 15 for Apple Pay Marchant  
    • Field Type: Alphanumeric
    • Length: 2
    • Sample Data: 15
    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
    MerchantDomainName
    required

    The domain name that is used when making an Apple Pay request. This value should be UTF-8 encoded upon secure hash calculation.


    • Field Type: Alphanumeric, Hyphens and Dots
    • Length: 253
    • Sample Data: smartroute-test.payone.io

    Response Parameters

    ParameterDescription
    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: 

    • 15 for Apple Pay   
    • Field Type: Alphanumeric
    • Length: 2
    • Sample Data: 15
    Response.ApplePayMerchantValidation 
    required    		The Apple Pay Merchant Validation represents the Apple Pay session object received from the Apple Pay server.
    • Field Type: Alphanumeric
    • Length: 2
    • Sample Data: 1
    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 – Redirect Payment; for more information, see secure hash generation. 

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