Guides
Start typing to search…

addSubRetailer

The addSubRetailer method is used to load sub-retailers into the terminal. This method can only be used if the main retailer is defined as RAV-SAPAK at Shva.

🚧

Use doPeriodic

After loading new retailers, you should use the doPeriodic method.

Request

📘

JSON-RPC 2.0

All methods in TweezerComm follow a JSON-RPC 2.0 structure. See Integration for more details on how the requests are structured and sent.

In the request, ensure to configure the following:

  • The method field must be set to addSubRetailer .
  • The service must be set to ashrait in the params.

The request needs to include the retailerId list.

{
    "jsonrpc": "2.0",
    "method": "addSubRetailer",
    "id": "123454352",
    "params": [
        "ashrait",
        {
            "retailerId": [
                "0883806",
                "0884806"
            ]
        }
    ]
}

Request Parameters

The table below describes the request parameters for this method.

NameTypeDescription
retailerIdarrayList of retailers.

Response

A successful request will return the following response:

{
    "jsonrpc": "2.0",
    "id": "123454352",
    "result": {
        "statusCode": 0,
        "statusMessage": "OK"
    }
}

Response Parameters

The table below describes the response parameters for this method.

Name

Type

Description

statusCode

integer

Transaction status. A value of 0 indicates a successful (approved) transaction.

statusMessage

string

Transaction message (e.g., ok)

mutag

integer

Card brand

solek

integer

Acquirer

manpik

integer

Card Issuer

uid

string

Transaction unique identifier

posEntryMode

integer

POS Entry Mode, type of card transaction. Values are: 0 (MSR), 5 (CTLS MSR), 40 (Contact EMV), 50 (Phone), 51 (Signature only), 80 (Fallback (err)), 81 (Fallback (no AID))

cardNumber

string

Masked personal account number (PAN)

rrn

string

Transaction authorization number from the authorized entity

issuerAuthNum

string

Issuer authorization number

acquirerMerchantID

string

Merchant ID in the acquirer system

authCodeManpik

integer

Code of authorization. Values are: 0 (Unauthorized transaction), 1 (Authorized by issuer), 2 (Declined by issuer), 3 (Stip approved ABS), 4 (Stip declined ABS), 5 (Voice approval), 6 (Voice declined), 7 (Approved by issuer pre-auth), 8 (Approved by card)

gatewayToken

string

Gateway token of the card

appVersion

string

Payment application version

retailerId

string

Terminal retailer Id

ecrNo

string

POS identifier

vuid

string

Vendor unique identifier

tranCode

string

Transaction Code

merchantReceipt

array of key/value

Merchant receipt to print or save

customerReceipt

array of key/value

Customer receipt to print

Updated about 1 month ago