Settle

Settle initiates batch settlement for the terminal, closing the current batch and submitting transactions to the payment processor. All the responses have GeneralResponse section that informs about successful result or error. See Error Codes and Messages.

Request Body

application/json

ReferenceId?string

Alphanumeric SPIn transaction identifier. Has to be unique within one batch.

Length1 <= length <= 50

GetReceipt?boolean

Indicates if a settlement receipt copy should be returned in the response.

SettlementType?string

The field indicating the type of settlement processing. Standard close, remove all batch data, or settle without validation.

Value in"Close" | "Clear" | "Force"

Tpn?string

Terminal profile number. Can be used to identify the terminal in SPIn Proxy environment.

Length10 <= length <= 12

RegisterId?string

Terminal identifier for register. [Obsolete] Can be used to identify the terminal instead of Tpn in SPIn Proxy environment. Required if no Tpn.

Length2 <= length <= 50

Authkey?string

Merchant's authorization password. Required if no SPInToken.

Length10 <= length <= 10

SPInProxyTimeout?|

Timeout for processing transaction with SPIn proxy. If null, the default timeout will be used.

Formatint32

Range1 <= value <= 720

CustomFields?

A collection of custom fields in key-value format.

Response Body

`application/json`

curl -X POST "https://example.com/v2/Payment/Settle" \  -H "Content-Type: application/json" \  -d '{    "ReferenceId": "30e5bd83f508",    "GetReceipt": false,    "SettlementType": "Close",    "Tpn": "",    "RegisterId": "",    "Authkey": "",    "SPInProxyTimeout": null,    "CustomFields": {}  }'

{
  "SettleDetails": [
    {
      "MerchantNumber": null,
      "MerchantName": "",
      "Application": "",
      "DetailedMessage": "",
      "BatchNumber": null,
      "HostStatus": "",
      "TransactionsReports": {
        "TransactionsCount": null,
        "SaleAmount": null,
        "ReturnAmount": null,
        "VoidAmount": null,
        "AuthAmount": null,
        "TicketAmount": null,
        "ReversalAmount": null,
        "CashAdvanceAmount": null,
        "TotalAmount": null
      },
      "Receipt": ""
    }
  ],
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

{
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

Request Body

Response Body

200application/json

400application/json

Standard Settle Response

DvPay Settle Response

DvPayLite Settle Response

`application/json`

`application/json`