Open, close and query virtual terminals (points of sale) and their local clearing periods. A terminal must be open before any financial operation.
Open terminal
A virtual terminal must be open to perform financial operations. Opening it starts a new local clearing period and transaction sequence, which are assigned automatically to subsequent operations.
The first operation of the day always requires opening the terminal. If the terminal is already open, it is closed and then reopened.
path Parameters
posIdTerminal (point of sale) identifier.
Open terminal › Responses
Created
idTransaction identifier.
errorTypeerrorCodeerrorMessageClose terminal
Closes the terminal's local clearing period. Closing asks the network to transfer the funds held on the terminal to the merchant account and to settle the associated commissions.
path Parameters
posIdTerminal (point of sale) identifier.
Close terminal › Responses
Terminal closed.
Get terminal
Returns the PointOfSale resource with the terminal's current information.
path Parameters
posIdTerminal (point of sale) identifier.
Get terminal › Responses
Terminal found.
creationDateupdatedDateactiveidnamestatusTerminal state.
scenariosupervisorIdList clearing periods
Returns the history of the terminal's local clearing periods. A clearing period aggregates transactions, amounts, commissions and other data for the interval between one terminal opening and the following close.
path Parameters
posIdTerminal (point of sale) identifier.
query Parameters
$skipNumber of records to skip.
$topNumber of records per response.
$orderByResult ordering.
$filterFilter expression applied to the records.
List clearing periods › Responses
Clearing periods.
creationDateupdatedDatereferencestransactionsauthorizedcancelledpayedrefundednumberopenDatecloseDatecommissionGet clearing period
Returns one local clearing period of the terminal, with aggregated transactions, amounts and commissions for the interval between an opening and a close.
path Parameters
posIdTerminal (point of sale) identifier.
clearingPeriodNumberNumber of the terminal's local clearing period.
Get clearing period › Responses
Clearing period found.
creationDateupdatedDatereferencestransactionsauthorizedcancelledpayedrefundednumberopenDatecloseDatecommission