Referência de parâmetros do deeplink

Esta página traz um catálogo consolidado de todas as URIs de deeplink do App2App e de seus parâmetros de requisição e resposta. A comunicação com o Getnet Payment App é feita por Android Intents usando URIs específicas. Todos os parâmetros são enviados como Extras no Intent.

Deeplinks disponíveis

O Getnet Payment App expõe os seguintes deeplinks:

URI	Função
`getnet://payment/v1/payment`	Inicia uma transação de venda.
`getnet://payment/v1/commerce-data`	Retorna os dados cadastrais do estabelecimento.
`getnet://payment/v1/refund`	Inicia um reembolso.
`getnet://payment/v1/polling`	Verifica se o Payment App consegue tratar deeplinks.
`getnet://payment/v1/get-info`	Retorna informações do terminal.
`getnet://payment/v1/last-transaction`	Retorna ou reimprime o último recibo.
`getnet://payment/v1/reports`	Retorna relatórios.
`getnet://payment/v1/cancel-operation`	Cancela uma operação de deeplink em andamento.
`getnet://payment/v1/shift`	Gerencia turnos.
`getnet://payment/v1/pre-auth`	Inicia uma pré-autorização.
`getnet://payment/v1/transaction-check-status`	Busca o status de uma transação anterior específica.

getnet://payment/v1/last-transaction é a URI de produção para reimprimir ou retornar o último recibo. getnet://payment/v1/reprint não é um deeplink App2App no esquema payment — não use. Exemplos que a mostram provavelmente vieram do esquema BR getnet://pagamento/v1/reprint, que é outro contexto.

Pagamento

URI: getnet://payment/v1/payment

Inicia uma nova transação de pagamento. O parâmetro paymentMethod seleciona cartão ou QR Code.

Parâmetros de requisição

Parâmetro	Tipo	Obrigatório	Descrição
`amount`	String	Sim	Total da transação em centavos, com duas casas decimais implícitas. Inteiro de até 9 dígitos; zeros à esquerda são aceitos, mas não são obrigatórios (ex.: `"1234"` = $12.34; `"10000"` = $100.00).
`originalAmount`	String	Não	Valor em moeda local para realizar a transação.
`receiptCode`	String	Sim	ID impresso no recibo para rastreamento do estabelecimento.
`callerId`	String	Não	Identificador único para correlacionar requisição e resposta.
`tip`	String	Não	Valor da gorjeta somado ao total da transação. Mesmo formato decimal de `amount`.
`waiterCode`	String	Condicional	Código do garçom para atribuição da gorjeta. Obrigatório quando há gorjeta.
`paymentMethod`	String	Não	`"1"`: cartão, `"2"`: QR Code. Se omitido, o terminal exibe a tela de seleção.
`installments`	Integer	Não	Número de parcelas (somente cartão de crédito).
`planId`	String	Não	ID do plano de parcelamento. Consulte Regras de parcelamento.
`interest`	Boolean	Não	Indica se o plano tem juros (`true`) ou é sem juros (`false`).
`operationMode`	String	Não	`"0"`: manual, `"1"`: calculado. Consulte Estratégia de cálculo de juros.
`skipReceipt`	Boolean	Não	`"true"` pula a tela de recibo do cliente. Padrão `"false"`.
`skipConfirmation`	Boolean	Não	`"true"` pula a tela de confirmação de valor e parcelas. Padrão `"false"`.
`allowPrintCurrentTransaction`	String	Não	`"false"` retorna os dados do recibo em `automationSlip`. Consulte Responsabilidade de impressão.

Parâmetros de resposta

Parâmetro	Tipo	Descrição
`result`	String	Resultado da transação. Consulte Códigos de resultado.
`resultDetails`	String	Mensagem detalhada do resultado da transação.
`amount`	String	Valor da transação em moeda local.
`originalAmount`	String	Valor em moeda local para realizar a transação.
`tip`	String	Valor da gorjeta da venda.
`waiterCode`	String	Código do garçom para atribuição da gorjeta.
`receiptCode`	String	Identificação impressa no recibo.
`callerId`	String	Correlaciona com a requisição do deeplink.
`nsu`	String	Código de autorização da transação Getnet, único por terminal por dia.
`nsuLastSuccesfullMessage`	String	Último NSU Getnet gerado com sucesso.
`paymentType`	String	Tipo de pagamento (crédito, débito, voucher etc.).
`brand`	String	Bandeira do cartão.
`inputType`	String	`021`: tarja magnética, `051`: chip, `071`: chip por aproximação, `801`: fallback de tarja magnética.
`installments`	String	Número de parcelas.
`planId`	String	Plano de parcelamento selecionado.
`interest`	String	Indica se houve seleção de juros (`true`/`false`).
`gmtDateTime`	String	Data e hora GMT (MMDDhhmmss, UTC 0).
`authorizationCode`	String	Código de autorização da transação.
`cardBin`	String	Primeiros 8 dígitos do cartão.
`cardLastDigits`	String	Últimos 4 dígitos do cartão.
`sellerCode`	String	Código da filial aprovado pela Getnet.
`terminalCode`	String	Código do terminal POS.
`paymentMethod`	String	`"1"`: cartão, `"2"`: QR Code.
`automationSlip`	String	Dados do recibo em JSON. Consulte Responsabilidade de impressão.

Reembolso

URI: getnet://payment/v1/refund

Reverte uma transação aprovada anteriormente. Reembolsos parciais são aceitos quando o valor é menor que o original.

Parâmetros de requisição

Parâmetro	Tipo	Obrigatório	Descrição
`authorizationCode`	String	Sim	Código da transação original, exibido como “AUT” no recibo.
`transactionDate`	String	Sim	Data da transação original no formato `dd/MM/yyyy`.
`amount`	String	Sim	Valor a ser revertido. Se for menor que o original, o reembolso é parcial.
`refundType`	String	Não	`"1"`: venda com saque, `"2"`: venda, `"3"`: saque.
`skipConfirmation`	String	Não	Pula a tela de confirmação de valor e parcelas.
`skipReceipt`	String	Não	Define se o recibo do cliente é impresso.
`allowPrintCurrentTransaction`	String	Não	`"false"` retorna os dados do recibo em `automationSlip`.

Parâmetros de resposta

Parâmetro	Tipo	Descrição
`result`	String	Resultado da transação. Consulte Códigos de resultado.
`resultDetails`	String	Mensagem detalhada do resultado da transação.
`authorizationCode`	String	Código de autorização da transação.
`commerceCode`	String	Código único do estabelecimento aprovado pela Getnet.
`amount`	String	Valor revertido em moeda local.
`gmtDateTime`	String	Data e hora GMT (MMDDhhmmss, UTC 0).
`callerId`	String	Correlaciona com a requisição do deeplink.
`nsuLastSuccesfullMessage`	String	Último NSU Getnet gerado com sucesso.
`refundTransactionDate`	String	Data do reembolso.
`refundOriginTerminal`	String	Identificador do terminal de origem do reembolso.
`automationSlip`	String	Dados do recibo em JSON.

Pré-autorização

URI: getnet://payment/v1/pre-auth

Reserva valores em um cartão de crédito para uma captura futura. O parâmetro operation seleciona a ação do ciclo de vida. Consulte Crie um pagamento pré-autorizado.

Parâmetros de requisição

Parâmetro	Tipo	Obrigatório	Descrição
`operation`	String	Sim	`"0"`: criar, `"1"`: modificar, `"2"`: remover, `"3"`: confirmar, `"4"`: consultar.
`reservation_id`	String	Condicional	Identifica a pré-autorização. Obrigatório para modificar, remover ou confirmar. Corresponde ao `authorizationRefCode` da resposta de criação.
`amount`	String	Não	Valor em moeda local a reservar.
`originalAmount`	String	Não	Valor em moeda local para realizar a transação.
`date`	String	Não	Data da transação no formato `dd/MM/yyyy`.
`installments`	String	Não	Número de parcelas (somente cartão de crédito).
`plan_id`	String	Não	ID do plano de parcelamento. Consulte Regras de parcelamento.
`interest`	String	Não	Indica se o plano tem juros (`true`/`false`).
`operationMode`	String	Não	`"0"`: manual, `"1"`: calculado.
`skipConfirmation`	String	Não	Pula a tela de confirmação.
`skipReceipt`	String	Não	Pula a tela de recibo do cliente.
`callerId`	String	Não	Correlaciona com a requisição do deeplink.
`allowPrintCurrentTransaction`	String	Não	`"false"` retorna os dados do recibo em `automationSlip`.
`filterReservationId`, `filterInitialDate`, `filterFinalDate`, `filterAuthorizationCode`, `filterCardLastDigits`, `filterAllowedBrands`	String	Não	Filtros para pré-autorizações pendentes. Envie somente quando `operation` for `"4"` (consultar).

Parâmetros de resposta

Campos principais: result, resultDetails, amount, originalAmount, authorizationRefCode (identificador da pré-autorização), authorizationCode, nsu, nsuLastSuccesfullMessage, brand, inputType, cardBin (8 dígitos), cardLastDigits, paymentType, sellerCode, terminalCode, receiptCode, callerId, gmtDateTime, automationSlip e pendingAuthorizations (preenchido somente na operação de consulta).

Polling

URI: getnet://payment/v1/polling

Verifica se o Payment App está pronto para receber comandos. Não tem parâmetros de requisição.

Parâmetros de resposta

Parâmetro	Tipo	Descrição
`result`	String	`"0"` indica que o terminal está pronto.
`resultDetails`	String	Mensagem detalhada sobre o status do terminal.

Reimpressão (última transação)

URI: getnet://payment/v1/last-transaction

Reimprime ou retorna o último recibo.

Parâmetros de requisição

Parâmetro	Tipo	Obrigatório	Descrição
`allowPrintCurrentTransaction`	String	Não	`"false"` retorna os dados do recibo em `automationSlip` em vez de imprimir.
`skipReceipt`	String	Não	`"true"` pula o recibo do cliente. Rejeitado se `allowPrintCurrentTransaction` for `"false"`.

Parâmetros de resposta

Parâmetro	Tipo	Descrição
`result`	String	Resultado da transação.
`resultDetails`	String	Mensagem detalhada do resultado.
`automationSlip`	String	Dados do recibo em JSON. Vazio quando `allowPrintCurrentTransaction` é `"true"`.

Relatórios

URI: getnet://payment/v1/reports

Recupera uma lista detalhada de vendas ou um resumo de totais do lote atual.

Parâmetros de requisição

Parâmetro	Tipo	Obrigatório	Descrição
`reportType`	String	Sim	`"0"`: vendas detalhadas, `"1"`: total de vendas.
`allowPrintCurrentTransaction`	String	Não	`"true"` imprime o relatório no terminal, `"false"` retorna somente os dados.

Parâmetros de resposta

Parâmetro	Tipo	Descrição
`result`	String	Resultado da transação.
`resultDetails`	String	Mensagem detalhada do resultado.
`reportDetails`	String	String JSON com o conteúdo do relatório. Consulte Códigos de resultado e estruturas de dados.

GetInfo

URI: getnet://payment/v1/get-info

Retorna informações técnicas e operacionais do terminal. Não tem parâmetros de requisição. A resposta inclui result, resultDetails e os campos do terminal detalhados em Códigos de resultado e estruturas de dados. Para a chamada em si, consulte Obtenha os dados do terminal e do estabelecimento.

GetCommerceData

URI: getnet://payment/v1/commerce-data

Retorna os dados cadastrais do estabelecimento. Não tem parâmetros de requisição. A resposta inclui result, resultDetails e um objeto JSON commerceData detalhado em Códigos de resultado e estruturas de dados. Para a chamada em si, consulte Obtenha os dados do terminal e do estabelecimento.

Turno

URI: getnet://payment/v1/shift

Configura, troca ou recupera informações de turno. Para as três operações passo a passo, consulte Gerencie os turnos dos operadores.

Parâmetros de requisição

Parâmetro	Tipo	Obrigatório	Descrição
`shiftOperation`	String	Sim	`"1"`: configurar os turnos disponíveis, `"2"`: trocar para o próximo turno, `"3"`: recuperar a quantidade atual de turnos.
`numberOfShifts`	String	Não	Nova quantidade de turnos quando `shiftOperation` é `"1"`.
`skipConfirmation`	String	Não	Pula a tela de confirmação da troca de turno.
`allowPrintCurrentTransaction`	String	Não	`"false"` retorna os dados em vez de imprimir.

Parâmetros de resposta

Parâmetro	Tipo	Descrição
`result`	String	Resultado da transação.
`resultDetails`	String	Mensagem detalhada do resultado.
`totalOfShifts`	String	Quantidade atual de turnos. Retornado somente quando `shiftOperation` é `"3"`.

Cancelar operação

URI: getnet://payment/v1/cancel-operation

Cancela uma operação de deeplink em andamento (Pagamento, Reembolso ou Pré-autorização). Não tem parâmetros de requisição. Consulte Cancele uma operação em andamento.

Parâmetros de resposta

Parâmetro	Tipo	Descrição
`result`	String	`"6"` indica que a operação foi cancelada com sucesso.
`resultDetails`	String	Mensagem detalhada do resultado.

Consultar status

URI: getnet://payment/v1/transaction-check-status

Busca o status de uma transação das últimas 72 horas pelo callerId. Consulte Consulte o status de uma transação.

Parâmetros de requisição

Parâmetro	Tipo	Obrigatório	Descrição
`callerId`	String	Sim	ID da transação original (máx. 100). Sem caracteres especiais ou Unicode.

Parâmetros de resposta

Parâmetro	Tipo	Descrição
`result`	String	Status da transação. Consulte Códigos de resultado e estruturas de dados.
`resultDetails`	String	Mensagem do resultado da transação.
`callerId`	String	ID gerado pela aplicação de terceiros.
`authorizationCode`	String	Código de autorização da transação. Pode ser nulo se nenhuma transação for encontrada.