Skip to content

This endpoint is used to process a reversal of a Sales Adjustment at the point-of-sale.

Method: ProcessSalesAdjustmentReversal

Request

Parameter Type length Description
x_pos_transaction_ref Unicode string 64 This is the transaction reference of the adjustment reversal
x_adjustment_signature Unicode string 200 The original adjustment signature that we are trying to reverse. We are using the Sales Adjustment Signature as we can not rely on the Sales Adjustment to return a result. (e.g. Network Issues)
x_merchant_id Unicode string 10 Merchant identifier as defined by humm
x_device_id Unicode string 64 Unique device identifier for the POS terminal
x_operator_id Unicode string 64 ID of POS/terminal operator
x_firmware_version Unicode string 64 Current firmware version of POS device
tracking_data optional Associative array Max 1000000 A map that can be populated with additional tracking/state information that will get passed back in the response
signature Hex string case-insensitive 200 Payload that is signed using HMAC-SHA256 using a device specific key

Response

Parameter Type Description
x_status Unicode string Success/Failure/Error
x_code Unicode string A code that maps to a specific reason
x_message Unicode string A string explaining the status/code above. Example: For an Error: Reason why the adjustment cannot be done
tracking_data Associative array Echoes tracking_data sent on the request
signature Hex string case-insensitive Payload that is signed using HMAC-SHA256 using a device specific key

Testing

The following describes dummy API requests that return a predictable response. Please contact pit@shophumm.com.au to get access to the test/dummy APIs.

Request -> x_adjustment_signature Response -> x_status Response -> x_code
01## Success SPAR01
10## Failed FPAR01
11## Failed FPAR02
12## Failed FPAR03
13## Failed FPAR05
14## Failed FPAR06
15## Failed FPAR07
16## Failed FPAR08
30## Error EVAL01
31## Error EAUT01
any other value Error EISE01

# signifies an alphanumeric digit

Testing Assumptions To generate the signature, use a device-signing-key of "1234567890". A invalid signature will cause an ESIG01 Error.