Skip to content

Deposit

METHOD NAME deposit

Requires state IDLE and during process moves to SETTLEMENT

Description

Deposit all transactions on the batch file to the gateway. Each record is deposited independently, and so is the result for each transaction. The method will return when the process is finished and each transaction tried once to deposit. If the transaction is not VOIDED or INFORMATIVE, the status will move to DEPOSITED.

Parameters

object

  • host string REQUIRED
    Currently, the value is SHVA only

Result

object when a request is valid and deposit starts processing

  • result Result
    Possible results are: OK, GENERAL_ERROR
    (1) Show values

    1. Result

      Result of new request. Each command has possible values in the field.

      • OK Request is ok
      • GENERAL_ERROR An error occurred
      • CANCELED Command was canceled either by the user (on-screen) or through cancel command,
      • TIMEOUT Operation was timed out.
      • HOST_ERROR Host returned an error regarding the request.
      • SMART_READER_ERROR An error occurred with the smart-reader
      • SMART_CARD_ERROR An error occurred with the smart card, or the reader couldn't communicate with the card.
      • NONE_CREDIT_CARD Industrial card was detected when performing a transaction.
      • CARD_NOT_ALLOWED When the detected card is not allowed to be processed

  • deposit Deposit
    Deposit payload

Errors

  • HostDisabled
  • MissingParams
  • IllegalState
  • ScreenNotReady

  • IllegalRequest

    Reason Description
    NO_GATEWAY when a gateway is not configured

Example

Request

1
2
3
4
5
6
7
8
{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "deposit",
  "params": {
    "host": "SHVA"
  }
}

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "jsonrpc": "2.0",
  "id": "1234567890"
  "result": {
    "result": "OK",
    "deposit": {
        "terminalId": "0883198",
        "depositCandidates": [
            {
                "transaction": {
                    "type": "R",
                    "referenceId": "5544a15f-2759-4622-8a97-53adfbbee184",
                    "transactionId": "24111020193508831988304"
                },
                "deposited": true,
                "depositId": "1234567890",
                "token": "6f7d2c1229b54831c7a4d403501882f0"
            },            
            {
                "transaction": {
                    "type": "R",
                    "referenceId": "65f0bf12-8a42-40d1-98aa-a91cb920cf1f",
                    "transactionId": "24111020204508831983607"
                },
                "deposited": true,
                "depositId": "543524333",
                "token": "0b77c1c2e4d684af08b20c61e22b193d"
            }
        ]
    }
  }
}