# Methods and Parameters

This reference lists Integrated POS methods and their parameters. It is a lookup for developers; for step-by-step flows, use the [Quick Start](/en/integrated-pos/first-steps-pos/quickstart-integrated-pos) and [payment](/en/integrated-pos/pos-payment-guides/single-step-payment) or [operational](/en/integrated-pos/operational-guides/get-reports) guides.

## What are these methods

Integrated POS exposes **connection management** methods (CreateHttp, CreateUsb, CreateCloud, Polling, GetInfo, Close) and **device operation** methods (Sale, Refund, PreAuth, GetReports, Shift, GetLastVoucher, etc.). All device operations are invoked on a **Connector** instance returned by one of the Create methods. Only one operation at a time can be in progress per Connector. Parameter names and types may differ slightly by SDK (.NET, Kotlin, JavaScript/TypeScript).

<Callout type="warning">

Only one device operation can be in progress per Connector at any time. Wait for the response (or error) before sending the next command. See [Connector communication flows](/en/integrated-pos/core-concepts-pos/connector-communication-flows).

</Callout>

## Connector creation methods

The following tables describe the connector creation methods:

### CreateHttp

Creates a Connector using HTTP (Wi-Fi or Ethernet).

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| hostname | String | Yes | Hostname, IPv4, or IPv6 of the POS device. |
| port | int | No | Remote port (default 8080). |
| setupParams | HashMap&lt;String, String> | No | Terminal configuration. See reconnection behavior if used. |

### CreateUsb

Creates a Connector using USB (serial).

| Parameter | Type | Required | Description | Availability |
| :--- | :--- | :--- | :--- | :--- |
| address | String | Yes | Serial port address (e.g. COM3, /dev/ttyACM0). | .NET |
| usbDevice | UsbDevice | Yes | Android USB device object. | Kotlin |
| setupParams | HashMap&lt;String, String> | No | Terminal configuration. See reconnection behavior if used. | Kotlin |

<Callout type="note">

Exactly one of `address` (.NET) or `usbDevice` (Kotlin) is required depending on the platform. When using `setupParams`, check the reconnection flow section for details.

</Callout>

### CreateCloud

Creates a Connector that reaches a remote terminal through the Getnet cloud. No hostname or port is required; the cloud routes each command to the registered terminal.

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| setupParams | HashMap&lt;String, String> | No | Terminal configuration. See reconnection behavior if used. |

<Callout type="note">

`CreateCloud` is available in the Kotlin and JavaScript/TypeScript libraries. When using `setupParams`, check the reconnection flow section for details.

</Callout>

### Close

Finishes all resources in memory. After this function being called you will not be able to re-use the connector object. No parameter is expected.

## Connection management

The following tables describe the connection management methods:

### Polling

Validates connectivity and terminal readiness. Must be called before device operations.

**Parameters:** none.

**Return:**

| Parameter Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message (e.g., "APPROVED"). |
| `Connected` | Bool | Whether the terminal is connected and responsive. |

### GetInfo

Retrieves device and commerce information from the POS (model, serial, network, merchant identifiers). Useful for validation or diagnostics.

**Parameters:** none.

**Return:**

| Parameter Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message (e.g., "APPROVED"). |
| `LegalName` | String | Legal name of the commerce. |
| `CommerceCuit` | String | Merchant identification (CUIT, CNPJ, or Rut). |
| `CommerceNumber` | String | Identification of the seller (sellerCode). |
| `BranchNumber` | String | Branch code (identification number). |
| `BranchName` | String | Legal name of the branch. |
| `LittleBranchName` | String | Short name of the branch. |
| `BranchAddress` | String | Full commerce address. |
| `BranchDistrict` | String | City or district of the commerce. |
| `TerminalId` | String | Logical identification of the terminal (terminalCode). |
| `SerialNumber` | String | Terminal physical serial number. |
| `TerminalModel` | String | Terminal model name. |
| `OS` | String | Android version/SDK version of the terminal. |
| `EmvModule` | String | Version of the EMV module. |
| `AppVersionName` | String | Payment application version. |
| `CommunicationUrl` | String | Communication address for terminals. |
| `PrimaryIP` | String | Current IP number of the terminal. |
| `Company` | String | Mobile network operator name (if using SIM). |
| `Apn` | String | SIM Access Point Name. |
| `SimId` | String | SIM identifier (ICCID). |
| `CommunicationType` | String | Network connection type (e.g., Wi-Fi, USB, HTTP). |
| `Wifi` | String | Name of the connected Wi-Fi network. |
| `CertificateStatus` | Boolean | True if the SDK certificate is valid. |
| `TipEnabled` | Boolean | True if tip entry is enabled. |
| `Receipt` | Boolean | True if receipt printing/content is enabled. |
| `Salesperson` | Boolean | True if salesperson code entry is enabled. |
| `InstallmentsCommerce` | Boolean | True if commerce installment plans are enabled. |
| `IssuerInstallments` | Boolean | True if issuer installment plans are enabled. |

## Device operations

The following tables describe the device operations:

### Sale

Executes a payment (single-step, installments, or QR code).

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| Amount | Long | No | Transaction value (last 2 digits = decimals). |
| SaleType | Enum | No | Card, QrCode. |
| PrintOnPos | Bool | No | Print receipt on POS. |
| EmployeeId | Int | No | Waiter ID. |
| Tip | Long | No | Tip amount. Not supported for QR. |
| Installments | Int | No | Number of installments. |
| SkipReceipt | Bool | No | Skip client receipt. |
| SkipConfirmation | Bool | No | Skip confirmation screen. |
| PlanId | String | No | Installment plan. |
| Interest | Enum | No | OnPosSelection, Interest, NoInterest. |
| OperationMode | Enum | No | `CalculatedGetnet` (terminal calculates) or `CalculatedISV` (your application calculates). Defaults to `CalculatedGetnet` if omitted. |
| CallerId | String | No | ID generated by the automation system (max 100 chars), required to later query the transaction with Check Status. No special or Unicode characters. |

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message (e.g., "APPROVED"). |
| `CommerceCode` | String | Unique branch code approved by Getnet. |
| `TerminalId` | String | Logical identification of the terminal. |
| `AuthorizationCode` | String | Transaction authorization code. |
| `Amount` | Long | Final charged amount in local currency. |
| `Last4Digits` | String | The last four digits of the customer's card. |
| `CardType` | String | Type of card used. |
| `AccountingDate` | String | Transaction timestamp at GMT (may return defaults if null). |
| `CardBrand` | String | Card brand used in the transaction. |
| `RealDate` | Date | Transaction timestamp at Local (may return defaults if null). |
| `EmployeeId` | Int | ID of the waiter/employee. |
| `Tip` | Long | Tip amount included in the sale. |
| `SaleType` | Enum | Card or QR Code. |
| `ReceiptContent` | Dict | Standardized receipt data if `PrintOnPos` is false. See [ReceiptContent Object](#receiptcontent-object). |
| `PlanId` | String | The selected installment plan (Present if applicable). |
| `Interest` | Enum | If interest was applied (Present if applicable). |
| `OperationMode` | Enum | `CalculatedGetnet` or `CalculatedISV`. May be omitted or defaulted if not sent. |
| `OriginalAmount` | Long | Initial amount before adjustments (Present if applicable). |
| `Installments` | Int | Number of installments used (Present if applicable). |
| `CallerId` | String | ID generated by the automation system (max 100 chars). |
| `CardBin` | String | The first eight digits of the customer's card (max 8). |

### Refund

Executes a refund (cancellation).

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| AuthorizationCode | String | No | Original transaction authorization code (6 digits). |
| OriginTransDate | Date | No | Date of the original transaction, in ISO8601 format with time zone. Must be no later than the current date. |
| Amount | Long | No | Refund amount (partial supported). |
| SkipConfirmation | Bool | No | Skip confirmation screen. |
| SkipReceipt | Bool | No | Client receipt not printed. |
| PrintOnPos | Bool | No | Print on POS or return in response. |
| RefundType | Enum | No | Specifies which part of a sale to refund: `SaleWithdrawal`, `Sale`, or `Withdrawal`. |

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message (e.g., "APPROVED"). |
| `CommerceCode` | String | Unique merchant code approved by Getnet. |
| `TerminalId` | String | Logical identification of the terminal. |
| `AuthorizationCode` | String | Authorization code of the refund operation. |
| `NsuLastSuccessfulMessage` | String | NSU of the last successful message. |
| `ReceiptContent` | Dict | Standardized receipt data objects; provided if `PrintOnPos` is false. See [ReceiptContent Object](#receiptcontent-object). |

### GetLastVoucher

Retrieves or reprints the last transaction voucher.

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| `PrintOnPos` | Boolean | No | Print on POS or return content. |
| `SkipReceipt` | Boolean | No | If `PrintOnPos` true: do not print client receipt. Default false. |

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message (e.g., "APPROVED"). |
| `ReceiptContent` | Dict | Standardized receipt data objects if `PrintOnPos` is false. See [ReceiptContent Object](#receiptcontent-object). |

> If the last operation was a Report type (Totals, Detailed, Shift), no voucher is available for reprint. A message indicating this scenario will be returned.

### GetReports

Retrieves Totals, Detailed, or Shift report.

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| `Type` | Enum | Yes | `Totals`, `Detailed`, or `Shift`. |
| `PrintOnPos` | Boolean | No | Print on POS or return in response. |

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message (e.g., "APPROVED"). |
| `ReportDetails` | Dict | Structured data provided if `PrintOnPos` is false. Content varies by `Type`. |

#### ReportDetails (Totals)

A summarized view of all operations, grouped into per-operation-type objects plus a global `operationTotals` object.

**Per-operation objects** — `debitOperation`, `creditOperation`, `qrcodeCreditOperation`, `qrcodeDebitOperation`, `qrcodePrePaidOperation`, `devolutionOperation`, `prePaidOperation`, and `qrcodeOperation`. Each contains:

| Field | Type | Description |
| :--- | :--- | :--- |
| `quantity` | String | Number of transactions. |
| `amount` | String | Total amount. |
| `amountSalesDiscounted` | String | Total amount from sales with discount. |
| `refundsAmount` | String | Total amount from refunds. |
| `salesCancelledQuantity` | String | Number of cancelled sales. |
| `listOperation` | String | List of Operation objects (see [ReportDetails (Detailed)](#reportdetails-detailed)). |

**`operationTotals` object** — global totals across all operations:

| Field | Type | Description |
| :--- | :--- | :--- |
| `salesAmount` | String | Total amount of sales. |
| `salesQuantity` | String | Number of sales. |
| `refundsAmount` | String | Total amount of refunds. |
| `refundsQuantity` | String | Number of refunds. |
| `tipAmount` | String | Total amount of tips. |
| `tipQuantity` | String | Number of tips. |
| `qrPctAmount` | String | Total amount of QR Codes. |
| `qrPctQuantity` | String | Number of QR Codes. |
| `totalCredit` | String | Total amount of credit sales. |
| `totalDebit` | String | Total amount of debit sales. |
| `totalPrepaid` | String | Total amount of prepaid sales. |

#### ReportDetails (Detailed)

A list of individual operations.

| Field | Type | Description |
| :--- | :--- | :--- |
| `authorizationCode` | String | Transaction authorization code. |
| `paymentId` | String | Internal unique payment identifier. |
| `opReasonMessageStatus` | String | Operation status message. |
| `timestamp` | Date | Transaction timestamp (ISO8601). |
| `brandType` | String | Card brand used. |
| `cardLastNumber` | String | Last 4 digits of the card. |
| `operationValue` | Long | Value of the operation. |
| `operation` | Enum | Operation type: credit, debit, voucher, QR code, cancellation, or refund. |

> Reports must be requested at least **2 minutes** after the last sale or shift change to ensure data synchronization.

### Shift

Shift setup, change, or get count.

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| `ShiftOperation` | Enum | Yes | `Configuration` (Setup), `Change`, or `GetShifts`. |
| `NumberOfShifts` | Int | Conditional | **Required only** for `Configuration` to set the total shift count (max 2 digits). |
| `SkipConfirmation` | Boolean | No | Skip shift change confirmation screen. |
| `PrintOnPos` | Boolean | No | Print shift data on terminal. |

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message (e.g., "APPROVED"). |
| `TotalOfShifts` | Int | Current shift count. |
| `ReportDetails` | String | Provided **only** if `PrintOnPos` is false and `ShiftOperation` is `Change`. |

### PreAuth

Manages the pre-authorization lifecycle (Create, Modify, Remove, Confirm, Retrieve).

**Parameters:**

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| `Operation` | Enum | Yes | `Create`, `Modify`, `Remove`, `Confirm`, `Retrieve`. |
| `ReservationCode` | String | No | Needed for `Modify`, `Remove`, or `Confirm` (max 5 characters). Optional, but **must be unique** if sent; the automation system is responsible for uniqueness. Named `reservationId` in the SDK. |
| `AuthorizationCode` | String | Conditional | Valid code required to identify the transaction for modification (6 digits). |
| `OriginalTransactionDate` | Date | Conditional | Required to identify the pre-authorization for `Modify`, `Remove`, or `Confirm`. In ISO8601 format with time zone. |
| `Amount` | Long | No | Amount in local currency, last 2 digits as decimals (max 9 digits). |
| `PlanId` | String | No | Installment plan ID (Argentina). |
| `Installments` | Int | No | Number of installments. |
| `Filters` | Object | No | Search criteria (only for `Retrieve`). See [PreAuth Filters](#preauth-filters). |
| `PrintOnPos` | Bool | No | Print receipt on POS or return in response. |
| `SkipReceipt` | Bool | No | Do not print client receipt. |
| `SkipConfirmation` | Bool | No | Skip confirmation screen. |
| `CallerId` | String | No | ID generated by the automation system (max 100 chars). Required to later query a `Create` transaction with Check Status. No special or Unicode characters. |

#### PreAuth Filters

Used only when `Operation` is `Retrieve`.

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `InitialDate` | Date | Start threshold for retrieving pending pre-authorizations, in ISO8601 format with time zone (default: current date). Cannot be after the current date or after `FinalDate`. |
| `FinalDate` | Date | End threshold, in ISO8601 format with time zone (default: current date). Cannot be after the current date or before `InitialDate`. |
| `AuthorizationCode` | String | Filter by specific authorization code (6 digits). |
| `ReservationCode` | String | Filter by specific reservation code (max 5 characters). |
| `Last4CardDigits` | String | Filter by last 4 digits of the card. |
| `CardBrand` | Int | Filter by card brand: `0` = ALL (default), `1` = Visa, `2` = MasterCard, `3` = Amex. |

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message (e.g., "APPROVED"). |
| `AuthorizationCode` | String | Transaction authorization code. |
| `Amount` | Long | Final amount in local currency. |
| `OriginalAmount` | Long | Value before any adjustments. |
| `PlanId` | String | The selected installment plan. |
| `Installments` | Int | Number of installments. |
| `Last4Digits` | String | Last four digits of the customer's card. |
| `CardType` | String | Type of card. |
| `AccountingDate` | Date | Transaction date and time (GMT). |
| `CardBrand` | String | Card brand used. |
| `RealDate` | Date | Transaction date and time (Local). |
| `ReceiptContent` | Dict | Standardized receipt data if `PrintOnPos` is false. See [ReceiptContent Object](#receiptcontent-object). |
| `ReservationId` | String | Reservation code identifier. |
| `CommerceCode` | String | Unique merchant code. |
| `TerminalId` | String | POS terminal code. |
| `PendingPreAuthorizations` | List | List of items (only for `Retrieve`). See [Pending Authorization Item](#pending-authorization-item). |
| `CardBin` | String | The first eight digits of the customer's card (max 8). |
| `CallerId` | String | ID generated by the automation system (max 100 chars). |

#### Pending Authorization Item

Structure of objects inside the `PendingPreAuthorizations` list.

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `TransactionDate` | Date | Date and time when processed. |
| `Amount` | Long | Transaction amount in local currency. |
| `AuthorizationCode` | String | Transaction authorization code. |
| `Last4Digits` | String | Last four digits of the card used. |
| `EntryMode` | Enum | `CHIP`, `MAGSTRIPE`, `CONTACTLESS`. |
| `CommerceCode` | String | Unique branch code. |
| `TerminalId` | String | POS terminal code. |
| `DateLimit` | Date | Expiration date for the pre-authorization. |
| `ReceiptCode` | String | Identification code printed on the receipt. |
| `ReservationId` | String | Transaction identifier provided by the user when the pre-authorization is created or updated. |

### Cancel

Cancels a command currently in progress, returning the terminal to the POS Connected screen.

**Parameters:** none.

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `6` indicates the Cancel operation executed successfully. |
| `Message` | String | Result message. |

<Callout type="note">

Only `Sale` (Card/QR), `Refund`, and `Pre-authorization` accept cancellation. Canceling a non-cancelable command returns "The operation isn't cancellable"; canceling with no active operation returns "There's no active operation to cancel". When a command is successfully canceled, the canceled command also returns `Code` `2` (canceled).

</Callout>

### Check Status

Searches for the status of a specific transaction processed in the **last 72 hours**, identified by its `CallerId`.

**Parameters:**

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| `CallerId` | String | Yes | ID generated by the automation system for the original transaction (max 100 chars). No special or Unicode characters. Must match the `CallerId` sent in the original transaction; otherwise an incorrect status may be returned. To check a **Refund**, use the same `CallerId` sent in the original `Sale`. |

**Return:**

| Field Name | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| `Code` | Int | Yes | Transaction status code (`0`–`6`). See the table below. |
| `Message` | String | Yes | Text message representing the operation result. |
| `CallerId` | String | Yes | ID generated by the automation system. |
| `Status` | Enum | Yes | Current transaction status: `APPROVED`, `AUTHORIZED`, `REFUNDED`, `CANCELED`, `REVERSED`, `NOT_FOUND`, or `UNKNOWN`. |
| `AuthorizationCode` | String | No | Transaction authorization code (6 digits). May be `null` if no transaction was found for the `CallerId`. |

**Transaction status codes:**

| Code | Status | Description |
| :--- | :--- | :--- |
| `0` | `APPROVED` | Transaction captured (approved). Used for standard card sales and QR Code with card. |
| `1` | `AUTHORIZED` | Transaction authorized (pre-authorization or QR PCT). Exclusive to QR Code PCT payments. |
| `2` | `REFUNDED` | Transaction refunded (D+1). |
| `3` | `CANCELED` | Transaction canceled (D+0). |
| `4` | `REVERSED` | Transaction reversed (undone). |
| `5` | `NOT_FOUND` | No transaction was found for the given `CallerId`. |
| `6` | `UNKNOWN` | Unknown or unmapped status. |

> **QR Code behavior:** A **QR PCT** (Point of Capture) transaction always returns `AUTHORIZED` (code `1`) — never `APPROVED`. A **QR Code with card** follows standard card behavior and returns `APPROVED` (code `0`) once captured.

<Callout type="note">

A transaction may take a short time to be fully processed at the Getnet platform. If you query it immediately after capture, you may receive `NOT_FOUND`; in that case use [Retrieve Last Voucher](/en/integrated-pos/operational-guides/retrieve-last-voucher) instead.

</Callout>

<Callout type="note">

If multiple transactions share the same `CallerId`, the system uses the most recent one to determine the status. Wait at least **2 minutes** after a refund to retrieve the most up-to-date status. Check Status supports querying the `Create` pre-authorization operation only.

</Callout>

### SwitchToNormalPos

Deactivates Integrated POS mode correctly, allowing manual use of the terminal.

**Parameters:** none.

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message. |

### Setup

Defines terminal configuration, such as a custom friendly name for identification.

| Parameter | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| `SetupParams` | Dict/Map | Yes | Identification keys and values (e.g., `friendly_name`). |

**Available settings:**

| Key | Type | Description |
| :--- | :--- | :--- |
| `friendly_name` | String | Custom name associated with every payment, refund, and pre-authorization transaction; used internally by Getnet to identify the source. Only alphanumeric and whitespace characters are allowed — no special characters (e.g. `ISV Name2` is valid; `I.S.V ? N@m!2` is not). Defaults to `ConectorApp`. |

<Callout type="note">

If you use a custom `friendly_name`, send it on **every** connection (`CreateUsb`, `CreateHttp`, or `CreateCloud`), because reconnection resets the terminal configuration.

</Callout>

**Return:**

| Field Name | Type | Description |
| :--- | :--- | :--- |
| `Code` | Int | Response code; `0` indicates success. |
| `Message` | String | Result message. |

## ReceiptContent object

When `PrintOnPos` is `false`, operations that generate a receipt (`Sale`, `Refund`, `GetLastVoucher`, `PreAuth`) return a `ReceiptContent` object — a JSON-formatted string with the receipt fields — so the automation system can print or store the receipt. If the automation system takes over printing, it **must** print at least the merchant's receipt; the customer's receipt is optional.

| Field | Type | Description |
| :--- | :--- | :--- |
| `getnetLogo` | String | Getnet logo encoded as a base64 string. |
| `sellerName` | String | Merchant's name. |
| `sellerAddress` | String | Merchant's address. |
| `cuit` | String | Unique document code. |
| `com` | String | Merchant's seller code. |
| `aid` | String | Terminal AID code. |
| `term` | String | Terminal code. |
| `authorizationCode` | String | Authorization code for this receipt. |
| `letterTypeTransaction` | String | Indicates the card input technology. |
| `dateTime` | String | Timestamp of the receipt in ISO8601 (UTC). |
| `cardLastDigits` | String | Last 4 digits of the card. |
| `brand` | String | Card brand. |
| `receiptCode` | String | Identification code printed on the receipt. |
| `amount` | String | Transaction value plus tip (if applied), in local currency. |
| `tip` | String | Tip amount. |
| `operationType` | String | Operation type. |
| `errorMessage` | String | Error message. |
| `cardholderValidationMethod` | String | Validation method used in the transaction. |

## Related resources

* [Response and Error Codes](/en/integrated-pos/reference/response-error-codes) — Code and Message values.
* [Validation Errors](https://docs.globalgetnet.com/en/products/in-store-payments/integrated-pos?doc=integrated-pos-validation-errors) — Structured `Message` returned when validation fails.
* [Installment Plans and Plan Ids](/en/integrated-pos/reference/installment-plans) — Available PlanId values.
* [Connection Models](/en/integrated-pos/first-steps-pos/connection-models) — When to use CreateHttp, CreateUsb, or CreateCloud.