Contents x
    Update Notification Message
    • 28 Aug 2023
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Update Notification Message

    • Updated on 28 Aug 2023
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Overview 

    SmartRoute interface is used to send payment response messages based on the API communication model described in the Communication Model section.

    This message will be sent from SmartRoute to merchant only if merchant has the “Merchant Notification URL” filled. It slightly differs from the regular messages as it consists of a response only, not a request and a response. The response received will be the same as the payment response received in the final step of the redirect payment. 

    Response Parameters

    ParameterDescription

    Response.StatusCode 
    required

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

    Appendix A: Redirect Payment Response Codes for descriptive details about Response Codes. 

    • Field Type: Alphanumeric
    • Length: 5
    • Sample Data: 00000
    Note:

    The update notification response codes are the same as the redirect payment response codes. 

    Response.StatusDescription 
    required

    An alphanumeric value that represents a message describing the response status received from SmartRoute. This parameter will be 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: Payment processed successfully
    Response.Amount
    required

    A numeric value that contains the purchase amount of the item.
    The value is in ISO format with no decimal point. Also. For example, 100 for 1.00 USD.

    • Field Type: Numeric
    • Length: 9
    • Sample Data: 100
    Response.CurrencyISOCode 
    required

    The numeric value is in ISO format for the currency. The value should be neither character value nor decimal point.

    For example, 840 for US Dollar, 400 for JOD.

    • Field Type: Numeric
    • Length: 3
    • Sample Data: 840
    Response.MerchantID 
    required    		The alphanumeric value 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.TransactionID 
    required    		The merchant generates the Transaction ID. It represents a unique identifier for the transaction and is alphanumeric which must not include special characters or spaces.
    • Field Type: Alphanumeric
    • Length: 20
    • Sample Data: 201508180000001
    Response.MessageID 
    required

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

    • 1 for Sale
    • 14 for Redirect Payment Verify
    • 11 for Recurring Payment
    • 6 for Redirect Pre-Authorization  
    • 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: e9fbb3c46ec9c7dec2a318edc283bbbea27bc5 d7bf7da30f4f2e62b89df74a2e
    Note:

    The update notification secure hash is the same as the redirect payment response secure hash.

    Response.AuthorizedCurrencyISOCode 
    conditional

    Authorized Currency uses the numeric ISO Code for the payment and not the character value.
    For example, 840 for the US Dollar.

    • Field Type: Numeric
    • Length: 3
    • Sample Data: 840
    Condition:
    This parameter will be provided back to the merchant if the MCP is enabled for this merchant.
    Response.AuthorizedAmount 
    conditional
    		A numeric value that contains the total purchase Authorized Amount of the item.
    The value is in ISO format with no decimal point. For example, 100 for 1.00 USD.
    • Field Type: Numeric
    • Length: 9
    • Sample Data: 100
    Condition:
    This parameter will be provided back to the merchant if the MCP is enabled for this merchant.
    Response.GatewayStatusCode 
    optional
    		An alphanumeric value that represents the gateway response code. This code covers errors generated by the chosen gateway. 
    • Field Type: Alphanumeric
    • Length: 15
    • Sample Data: 0000
    Response.GatewayStatusDescription 
    optional

    An alphanumeric value that represents a message describing the response status received from the chosen gateway using the language specified in the request.

    After completing the execution process, this parameter will be filled in. This value should be UTF-8 encoded when it is entered into the secure hash generation process. 

    • Field Type: Alphanumeric
    • Length: 100
    • Sample Data: Sample Gateway Description 
    Response.GatewayName 
    optional
    		This value represents the gateway name that processed the transaction. It can be alphanumeric with special characters like space, ‘@’ and ‘_’.
    • Field Type: Alphanumeric and Some Special
    • Length: 40
    • Sample Data: TestGateway
    Response.RRN 
    optional
    		An alphanumeric value that represents a Receipt Reference Number for the current payment transaction. This value will be returned if the value is provided from the gateway.
    • Field Type: Alphanumeric
    • Length: 60
    • Sample Data: 201508201600462840000000000
    Response.ApprovalCode 
    optional

    Approval Code received from Payment Processor such as Visa. The values will be returned in the following case:

    • Only after a successful transaction
    • Value is provided from the gateway
    • Field Type: Alphanumeric
    • Length: 10
    • Sample Data: 12345678
    Response.Token 
    optional
    		The token that is assigned to the entered card information; responds to a “GenerateToken” flag with the value “Yes”. This parameter is a part of the tokenization parameters; for more information, see Tokenization.
    • Field Type: Alphanumeric
    • Length: 64
    • Sample Data: 
    17b61316feafe09feb806ce33cdbfc85a
    ed1b4173ed604f8fd5fa3cf72a02e27
    Response.CardExpiryDate  
    optional
    		The customer’s card expiry date (year) digits that are used in the payment. The format of this parameter should be in the form (YY).
    • Field Type: Alphanumeric
    • Length: 4
    • Sample Data: 1508
    Response.CardHolderName 
    optional

    The customer’s card number is used in the payment.

    • Field Type: Alphanumeric
    • Length: 32
    • Sample Data: FName LName 
    Response.CardNumber 
    optional

    The customer’s masked card number is used in the payment.

    • Field Type: Alphanumeric
    • Length: 19
    • Sample Data: 4747******123
    What's Next