Getnet DocsGetnet Docs

Métodos y parámetros

Esta referencia lista los métodos del TPV Integrado y sus parámetros. Es una consulta rápida para desarrolladores; para flujos paso a paso, usa la guía de Inicio rápido y las guías de pagos u operaciones.

¿Qué son estos métodos?

El TPV Integrado expone métodos de gestión de la conexión (CreateHttp, CreateUsb, CreateCloud, Polling, GetInfo, Close) y métodos de operación del dispositivo (Sale, Refund, PreAuth, GetReports, Shift, GetLastVoucher, etc.). Todas las operaciones del dispositivo se invocan sobre una instancia de Connector devuelta por uno de los métodos Create. Solo puede haber una operación en curso a la vez por Connector. Los nombres y los tipos de los parámetros pueden variar un poco según el SDK (.NET, Kotlin, JavaScript/TypeScript).

Solo puede haber una operación del dispositivo en curso por Connector en cualquier momento. Espera la respuesta (o el error) antes de enviar el siguiente comando. Consulta Connector y flujos de comunicación.

Métodos de creación del Connector

Las siguientes tablas describen los métodos de creación del Connector:

CreateHttp

Crea un Connector mediante HTTP (Wi-Fi o Ethernet).

ParámetroTipoObligatorioDescripción
hostnameStringSíNombre de host, IPv4 o IPv6 del dispositivo TPV.
portintNoPuerto remoto (8080 por defecto).
setupParamsHashMap<String, String>NoConfiguración del terminal. Si lo usas, consulta el comportamiento de reconexión.

CreateUsb

Crea un Connector mediante USB (serie).

ParámetroTipoObligatorioDescripciónDisponibilidad
addressStringSíDirección del puerto serie (por ejemplo, COM3, /dev/ttyACM0)..NET
usbDeviceUsbDeviceSíObjeto de dispositivo USB de Android.Kotlin
setupParamsHashMap<String, String>NoConfiguración del terminal. Si lo usas, consulta el comportamiento de reconexión.Kotlin

Se requiere exactamente uno entre address (.NET) y usbDevice (Kotlin), según la plataforma. Si usas setupParams, consulta la sección del flujo de reconexión para más detalles.

CreateCloud

Crea un Connector que alcanza un terminal remoto a través de la nube de Getnet. No se requiere nombre de host ni puerto; la nube enruta cada comando al terminal registrado.

ParámetroTipoObligatorioDescripción
setupParamsHashMap<String, String>NoConfiguración del terminal. Si lo usas, consulta el comportamiento de reconexión.

CreateCloud está disponible en las bibliotecas de Kotlin y JavaScript/TypeScript. Si usas setupParams, consulta la sección del flujo de reconexión para más detalles.

Close

Libera todos los recursos en memoria. Después de llamar a esta función, no puedes volver a usar el objeto connector. No espera ningún parámetro.

Gestión de la conexión

Las siguientes tablas describen los métodos de gestión de la conexión:

Polling

Valida la conectividad y si el terminal está listo. Debes llamarlo antes de las operaciones del dispositivo.

Parámetros: ninguno.

Retorno:

ParámetroTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado (por ejemplo, “APPROVED”).
ConnectedBoolIndica si el terminal está conectado y responde.

GetInfo

Recupera información del dispositivo y del comercio desde el TPV (modelo, serie, red, identificadores del comercio). Es útil para validación o diagnóstico.

Parámetros: ninguno.

Retorno:

ParámetroTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado (por ejemplo, “APPROVED”).
LegalNameStringRazón social del comercio.
CommerceCuitStringIdentificación del comercio (CUIT, CNPJ o Rut).
CommerceNumberStringIdentificación del vendedor (sellerCode).
BranchNumberStringCódigo de la sucursal (número de identificación).
BranchNameStringRazón social de la sucursal.
LittleBranchNameStringNombre corto de la sucursal.
BranchAddressStringDirección completa del comercio.
BranchDistrictStringCiudad o distrito del comercio.
TerminalIdStringIdentificación lógica del terminal (terminalCode).
SerialNumberStringNúmero de serie físico del terminal.
TerminalModelStringNombre del modelo del terminal.
OSStringVersión de Android o del SDK del terminal.
EmvModuleStringVersión del módulo EMV.
AppVersionNameStringVersión de la aplicación de pago.
CommunicationUrlStringDirección de comunicación de los terminales.
PrimaryIPStringNúmero de IP actual del terminal.
CompanyStringNombre del operador de red móvil (si usa SIM).
ApnStringNombre del punto de acceso (APN) de la SIM.
SimIdStringIdentificador de la SIM (ICCID).
CommunicationTypeStringTipo de conexión de red (por ejemplo, Wi-Fi, USB, HTTP).
WifiStringNombre de la red Wi-Fi conectada.
CertificateStatusBooleanTrue si el certificado del SDK es válido.
TipEnabledBooleanTrue si la entrada de propina está habilitada.
ReceiptBooleanTrue si la impresión o el contenido del recibo está habilitado.
SalespersonBooleanTrue si la entrada del código de vendedor está habilitada.
InstallmentsCommerceBooleanTrue si los planes de cuotas del comercio están habilitados.
IssuerInstallmentsBooleanTrue si los planes de cuotas del emisor están habilitados.

Operaciones del dispositivo

Las siguientes tablas describen las operaciones del dispositivo:

Sale

Ejecuta un pago (en un solo paso, en cuotas o con código QR).

ParámetroTipoObligatorioDescripción
AmountLongNoValor de la transacción (los últimos 2 dígitos son decimales).
SaleTypeEnumNoCard, QrCode.
PrintOnPosBoolNoImprime el recibo en el TPV.
EmployeeIdIntNoId del camarero.
TipLongNoImporte de la propina. No se admite para QR.
InstallmentsIntNoNúmero de cuotas.
SkipReceiptBoolNoOmite el recibo del cliente.
SkipConfirmationBoolNoOmite la pantalla de confirmación.
PlanIdStringNoPlan de cuotas.
InterestEnumNoOnPosSelection, Interest, NoInterest.
OperationModeEnumNoCalculatedGetnet (el terminal calcula) o CalculatedISV (tu aplicación calcula). Si se omite, el valor por defecto es CalculatedGetnet.
CallerIdStringNoId generado por el sistema de automatización (máx. 100 caracteres), necesario para consultar después la transacción con Check Status. No se permiten caracteres especiales ni Unicode.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado (por ejemplo, “APPROVED”).
CommerceCodeStringCódigo único de sucursal aprobado por Getnet.
TerminalIdStringIdentificación lógica del terminal.
AuthorizationCodeStringCódigo de autorización de la transacción.
AmountLongImporte final cobrado en moneda local.
Last4DigitsStringLos últimos cuatro dígitos de la tarjeta del cliente.
CardTypeStringTipo de tarjeta usada.
AccountingDateStringMarca de tiempo de la transacción en GMT (puede devolver valores por defecto si es nula).
CardBrandStringMarca de tarjeta usada en la transacción.
RealDateDateMarca de tiempo de la transacción en hora local (puede devolver valores por defecto si es nula).
EmployeeIdIntId del camarero o empleado.
TipLongImporte de la propina incluido en la venta.
SaleTypeEnumCard o QR Code.
ReceiptContentDictDatos estandarizados del recibo si PrintOnPos es false. Consulta Objeto ReceiptContent.
PlanIdStringEl plan de cuotas seleccionado (presente si corresponde).
InterestEnumIndica si se aplicó interés (presente si corresponde).
OperationModeEnumCalculatedGetnet o CalculatedISV. Puede omitirse o tomar el valor por defecto si no se envía.
OriginalAmountLongImporte inicial antes de los ajustes (presente si corresponde).
InstallmentsIntNúmero de cuotas usadas (presente si corresponde).
CallerIdStringId generado por el sistema de automatización (máx. 100 caracteres).
CardBinStringLos primeros ocho dígitos de la tarjeta del cliente (máx. 8).

Refund

Ejecuta una devolución (cancelación).

ParámetroTipoObligatorioDescripción
AuthorizationCodeStringNoCódigo de autorización de la transacción original (6 dígitos).
OriginTransDateDateNoFecha de la transacción original, en formato ISO8601 con zona horaria. No puede ser posterior a la fecha actual.
AmountLongNoImporte de la devolución (se admiten devoluciones parciales).
SkipConfirmationBoolNoOmite la pantalla de confirmación.
SkipReceiptBoolNoNo imprime el recibo del cliente.
PrintOnPosBoolNoImprime en el TPV o devuelve el contenido en la respuesta.
RefundTypeEnumNoEspecifica qué parte de una venta se devuelve: SaleWithdrawal, Sale o Withdrawal.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado (por ejemplo, “APPROVED”).
CommerceCodeStringCódigo único de comercio aprobado por Getnet.
TerminalIdStringIdentificación lógica del terminal.
AuthorizationCodeStringCódigo de autorización de la operación de devolución.
NsuLastSuccessfulMessageStringNSU del último mensaje exitoso.
ReceiptContentDictObjetos de datos estandarizados del recibo; se proporcionan si PrintOnPos es false. Consulta Objeto ReceiptContent.

GetLastVoucher

Recupera o vuelve a imprimir el comprobante de la última transacción.

ParámetroTipoObligatorioDescripción
PrintOnPosBooleanNoImprime en el TPV o devuelve el contenido.
SkipReceiptBooleanNoSi PrintOnPos es true: no imprime el recibo del cliente. Por defecto es false.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado (por ejemplo, “APPROVED”).
ReceiptContentDictObjetos de datos estandarizados del recibo si PrintOnPos es false. Consulta Objeto ReceiptContent.

Si la última operación fue de tipo Informe (Totals, Detailed, Shift), no hay comprobante disponible para reimprimir. Se devuelve un mensaje que indica esta situación.

GetReports

Recupera el informe Totals, Detailed o Shift.

ParámetroTipoObligatorioDescripción
TypeEnumSíTotals, Detailed o Shift.
PrintOnPosBooleanNoImprime en el TPV o devuelve el contenido en la respuesta.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado (por ejemplo, “APPROVED”).
ReportDetailsDictDatos estructurados que se proporcionan si PrintOnPos es false. El contenido varía según Type.

ReportDetails (Totals)

Una vista resumida de todas las operaciones, agrupada en objetos por tipo de operación más un objeto global operationTotals.

Objetos por operación — debitOperation, creditOperation, qrcodeCreditOperation, qrcodeDebitOperation, qrcodePrePaidOperation, devolutionOperation, prePaidOperation y qrcodeOperation. Cada uno contiene:

CampoTipoDescripción
quantityStringNúmero de transacciones.
amountStringImporte total.
amountSalesDiscountedStringImporte total de las ventas con descuento.
refundsAmountStringImporte total de las devoluciones.
salesCancelledQuantityStringNúmero de ventas canceladas.
listOperationStringLista de objetos Operation (consulta ReportDetails (Detailed)).

Objeto operationTotals — totales globales de todas las operaciones:

CampoTipoDescripción
salesAmountStringImporte total de las ventas.
salesQuantityStringNúmero de ventas.
refundsAmountStringImporte total de las devoluciones.
refundsQuantityStringNúmero de devoluciones.
tipAmountStringImporte total de las propinas.
tipQuantityStringNúmero de propinas.
qrPctAmountStringImporte total de los códigos QR.
qrPctQuantityStringNúmero de códigos QR.
totalCreditStringImporte total de las ventas con crédito.
totalDebitStringImporte total de las ventas con débito.
totalPrepaidStringImporte total de las ventas con prepago.

ReportDetails (Detailed)

Una lista de operaciones individuales.

CampoTipoDescripción
authorizationCodeStringCódigo de autorización de la transacción.
paymentIdStringIdentificador único interno del pago.
opReasonMessageStatusStringMensaje de estado de la operación.
timestampDateMarca de tiempo de la transacción (ISO8601).
brandTypeStringMarca de tarjeta usada.
cardLastNumberStringÚltimos 4 dígitos de la tarjeta.
operationValueLongValor de la operación.
operationEnumTipo de operación: crédito, débito, voucher, código QR, cancelación o devolución.

Debes solicitar los informes al menos 2 minutos después de la última venta o cambio de turno para asegurar la sincronización de los datos.

Shift

Configuración de turnos, cambio de turno u obtención del total de turnos.

ParámetroTipoObligatorioDescripción
ShiftOperationEnumSíConfiguration (configuración), Change o GetShifts.
NumberOfShiftsIntCondicionalObligatorio solo para Configuration, para definir el total de turnos (máx. 2 dígitos).
SkipConfirmationBooleanNoOmite la pantalla de confirmación del cambio de turno.
PrintOnPosBooleanNoImprime los datos del turno en el terminal.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado (por ejemplo, “APPROVED”).
TotalOfShiftsIntTotal de turnos actual.
ReportDetailsStringSe proporciona solo si PrintOnPos es false y ShiftOperation es Change.

PreAuth

Gestiona el ciclo de vida de la preautorización (Create, Modify, Remove, Confirm, Retrieve).

Parámetros:

ParámetroTipoObligatorioDescripción
OperationEnumSíCreate, Modify, Remove, Confirm, Retrieve.
ReservationCodeStringNoNecesario para Modify, Remove o Confirm (máx. 5 caracteres). Es opcional, pero debe ser único si lo envías; el sistema de automatización es responsable de la unicidad. Se llama reservationId en el SDK.
AuthorizationCodeStringCondicionalSe requiere un código válido para identificar la transacción que vas a modificar (6 dígitos).
OriginalTransactionDateDateCondicionalObligatorio para identificar la preautorización en Modify, Remove o Confirm. En formato ISO8601 con zona horaria.
AmountLongNoImporte en moneda local, con los últimos 2 dígitos como decimales (máx. 9 dígitos).
PlanIdStringNoId del plan de cuotas (Argentina).
InstallmentsIntNoNúmero de cuotas.
FiltersObjectNoCriterios de búsqueda (solo para Retrieve). Consulta Filtros de PreAuth.
PrintOnPosBoolNoImprime el recibo en el TPV o lo devuelve en la respuesta.
SkipReceiptBoolNoNo imprime el recibo del cliente.
SkipConfirmationBoolNoOmite la pantalla de confirmación.
CallerIdStringNoId generado por el sistema de automatización (máx. 100 caracteres). Es necesario para consultar después una transacción Create con Check Status. No se permiten caracteres especiales ni Unicode.

Filtros de PreAuth

Se usa solo cuando Operation es Retrieve.

CampoTipoDescripción
InitialDateDateLímite inicial para recuperar preautorizaciones pendientes, en formato ISO8601 con zona horaria (por defecto: la fecha actual). No puede ser posterior a la fecha actual ni a FinalDate.
FinalDateDateLímite final, en formato ISO8601 con zona horaria (por defecto: la fecha actual). No puede ser posterior a la fecha actual ni anterior a InitialDate.
AuthorizationCodeStringFiltra por un código de autorización específico (6 dígitos).
ReservationCodeStringFiltra por un código de reserva específico (máx. 5 caracteres).
Last4CardDigitsStringFiltra por los últimos 4 dígitos de la tarjeta.
CardBrandIntFiltra por marca de tarjeta: 0 = ALL (por defecto), 1 = Visa, 2 = MasterCard, 3 = Amex.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado (por ejemplo, “APPROVED”).
AuthorizationCodeStringCódigo de autorización de la transacción.
AmountLongImporte final en moneda local.
OriginalAmountLongValor antes de cualquier ajuste.
PlanIdStringEl plan de cuotas seleccionado.
InstallmentsIntNúmero de cuotas.
Last4DigitsStringÚltimos cuatro dígitos de la tarjeta del cliente.
CardTypeStringTipo de tarjeta.
AccountingDateDateFecha y hora de la transacción (GMT).
CardBrandStringMarca de tarjeta usada.
RealDateDateFecha y hora de la transacción (local).
ReceiptContentDictDatos estandarizados del recibo si PrintOnPos es false. Consulta Objeto ReceiptContent.
ReservationIdStringIdentificador del código de reserva.
CommerceCodeStringCódigo único de comercio.
TerminalIdStringCódigo del terminal TPV.
PendingPreAuthorizationsListLista de elementos (solo para Retrieve). Consulta Elemento de la lista PendingPreAuthorizations.
CardBinStringLos primeros ocho dígitos de la tarjeta del cliente (máx. 8).
CallerIdStringId generado por el sistema de automatización (máx. 100 caracteres).

Elemento de la lista PendingPreAuthorizations

Estructura de los objetos dentro de la lista PendingPreAuthorizations.

CampoTipoDescripción
TransactionDateDateFecha y hora en que se procesó.
AmountLongImporte de la transacción en moneda local.
AuthorizationCodeStringCódigo de autorización de la transacción.
Last4DigitsStringÚltimos cuatro dígitos de la tarjeta usada.
EntryModeEnumCHIP, MAGSTRIPE, CONTACTLESS.
CommerceCodeStringCódigo único de sucursal.
TerminalIdStringCódigo del terminal TPV.
DateLimitDateFecha de vencimiento de la preautorización.
ReceiptCodeStringCódigo de identificación impreso en el recibo.
ReservationIdStringIdentificador de la transacción que proporciona el usuario cuando se crea o se actualiza la preautorización.

Cancel

Cancela un comando en curso y devuelve el terminal a la pantalla POS Connected.

Parámetros: ninguno.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 6 indica que la operación Cancel se ejecutó con éxito.
MessageStringMensaje de resultado.

Solo Sale (Card/QR), Refund y Pre-authorization admiten cancelación. Cancelar un comando no cancelable devuelve “The operation isn’t cancellable”; cancelar sin una operación activa devuelve “There’s no active operation to cancel”. Cuando un comando se cancela con éxito, ese comando cancelado también devuelve Code 2 (cancelado).

Check Status

Busca el estado de una transacción específica procesada en las últimas 72 horas, identificada por su CallerId.

Parámetros:

ParámetroTipoObligatorioDescripción
CallerIdStringSíId generado por el sistema de automatización para la transacción original (máx. 100 caracteres). No se permiten caracteres especiales ni Unicode. Debe coincidir con el CallerId enviado en la transacción original; de lo contrario, puedes recibir un estado incorrecto. Para consultar una devolución, usa el mismo CallerId enviado en la Sale original.

Retorno:

CampoTipoObligatorioDescripción
CodeIntSíCódigo de estado de la transacción (0–6). Consulta la tabla siguiente.
MessageStringSíMensaje de texto que representa el resultado de la operación.
CallerIdStringSíId generado por el sistema de automatización.
StatusEnumSíEstado actual de la transacción: APPROVED, AUTHORIZED, REFUNDED, CANCELED, REVERSED, NOT_FOUND o UNKNOWN.
AuthorizationCodeStringNoCódigo de autorización de la transacción (6 dígitos). Puede ser null si no se encontró ninguna transacción para el CallerId.

Códigos de estado de la transacción:

CódigoEstadoDescripción
0APPROVEDTransacción capturada (aprobada). Se usa para ventas con tarjeta estándar y para código QR con tarjeta.
1AUTHORIZEDTransacción autorizada (preautorización o QR PCT). Exclusivo de los pagos con código QR PCT.
2REFUNDEDTransacción devuelta (D+1).
3CANCELEDTransacción cancelada (D+0).
4REVERSEDTransacción revertida (deshecha).
5NOT_FOUNDNo se encontró ninguna transacción para el CallerId indicado.
6UNKNOWNEstado desconocido o no mapeado.

Comportamiento del código QR: Una transacción QR PCT (Point of Capture) siempre devuelve AUTHORIZED (código 1), nunca APPROVED. Un código QR con tarjeta sigue el comportamiento estándar de tarjeta y devuelve APPROVED (código 0) una vez capturado.

Una transacción puede tardar un momento en procesarse por completo en la plataforma de Getnet. Si la consultas inmediatamente después de la captura, puedes recibir NOT_FOUND; en ese caso, usa Recuperar el último comprobante en su lugar.

Si varias transacciones comparten el mismo CallerId, el sistema usa la más reciente para determinar el estado. Espera al menos 2 minutos después de una devolución para obtener el estado más actualizado. Check Status solo admite consultar la operación de preautorización Create.

SwitchToNormalPos

Desactiva el modo TPV Integrado de forma correcta y permite el uso manual del terminal.

Parámetros: ninguno.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado.

Setup

Define la configuración del terminal, como un nombre descriptivo personalizado para identificarlo.

ParámetroTipoObligatorioDescripción
SetupParamsDict/MapSíClaves y valores de identificación (por ejemplo, friendly_name).

Configuraciones disponibles:

ClaveTipoDescripción
friendly_nameStringNombre personalizado asociado a cada transacción de pago, devolución y preautorización; Getnet lo usa internamente para identificar el origen. Solo se permiten caracteres alfanuméricos y espacios en blanco, sin caracteres especiales (por ejemplo, ISV Name2 es válido; I.S.V ? N@m!2 no lo es). El valor por defecto es ConectorApp.

Si usas un friendly_name personalizado, envíalo en cada conexión (CreateUsb, CreateHttp o CreateCloud), porque la reconexión restablece la configuración del terminal.

Retorno:

CampoTipoDescripción
CodeIntCódigo de respuesta; 0 indica éxito.
MessageStringMensaje de resultado.

Objeto ReceiptContent

Cuando PrintOnPos es false, las operaciones que generan un recibo (Sale, Refund, GetLastVoucher, PreAuth) devuelven un objeto ReceiptContent: una cadena con formato JSON que contiene los campos del recibo. Así el sistema de automatización puede imprimir o guardar el recibo. Si el sistema de automatización asume la impresión, debe imprimir al menos el recibo del comercio; el recibo del cliente es opcional.

CampoTipoDescripción
getnetLogoStringLogo de Getnet codificado como cadena base64.
sellerNameStringNombre del comercio.
sellerAddressStringDirección del comercio.
cuitStringCódigo único de documento.
comStringCódigo de vendedor del comercio.
aidStringCódigo AID del terminal.
termStringCódigo del terminal.
authorizationCodeStringCódigo de autorización de este recibo.
letterTypeTransactionStringIndica la tecnología de entrada de la tarjeta.
dateTimeStringMarca de tiempo del recibo en ISO8601 (UTC).
cardLastDigitsStringÚltimos 4 dígitos de la tarjeta.
brandStringMarca de tarjeta.
receiptCodeStringCódigo de identificación impreso en el recibo.
amountStringValor de la transacción más la propina (si se aplicó), en moneda local.
tipStringImporte de la propina.
operationTypeStringTipo de operación.
errorMessageStringMensaje de error.
cardholderValidationMethodStringMétodo de validación usado en la transacción.

Recursos relacionados