Skip to main content
Version: Next

Json Request

Request fields

NameTypeDescription
actionobjectRequired Contains the transaction type and relevant parameters.
clientobjectRequired Contains information specific to the client setup.

Action fields

NameTypeDescription
typestringRequired The type of transaction you intend to perform, currently supported types are "sale", "refund", "saleReversal", "refundReversal", "saleAndTokenizeCard" and "enableScanner".
parametersobjectRequired An object containing the keys an values with the parameters required for this transaction.
extraParametersobjectRequired Contains a custom set of keys and values that are sent to the Handpoint gateway and will be delivered back in the response. Useful for tracking the transactions, merchants, etc.

Transaction Parameters fields

NameTypeDescription
amountstringRequired The amount of money, in the smallest unit of the applicable currency. For US dollars, this value is in cents. (So, $12 would result in 1200. $0.01 would result in 1) This value is always an integer.
currencystringRequired The type of currency involved in the current payment, in ISO 4217 format. For example, the currency code for US dollars is USD.
originalTransactionIDstringRequired (Required for reversals.) The original transaction Id required to reverse/cancel a transaction.

Barcode / QR Scanner Parameters fields

NameTypeDescription
multiScanbooleanOptional True if you want the scanner to stay on to capture multiple codes. False to turn off the scanner after the first succesful scan, timeout or cancel. Default is False.
autoScanbooleanOptional True if you want the scanner to function automatically without the press of a button. Default is False.
resultsGroupedbooleanOptional True if you want the results of the scan to come all grouped when the scanner is turned off. Otherwise the device will send an event per each code scanned. Default is True.
timeoutintegerOptional The amount of seconds after which the scanner, if left idle, turns itself off. Default is 0.

Client fields

NameTypeDescription
clientIdstringArbitrary identification of the client. Your APP_ID or just an unique identifier of your web client.
sskstringShared Secret Key to activate the payment terminal.
autoReturnbooleanRequired If true, the Express client automatically gets hidden/switches back to your app following a short timeout after the transaction completes. Otherwise, the merchant must tap the back button to return to your app.
autoReturnTimeoutintegerNumber of seconds to wait before switching back to your app if autoReturn is true. The default value is 10.