API de Pagamento 4.3.2

API de Pagamento
POS Digital | Getnet
Documentação
Versão 4.3.2
CLASSIFICAÇÃO DO DOCUMENTO – CONFIDENCIAL

Este documento pode conter informação confidencial e/ou
privilegiada. Se você não for o destinatário ou a pessoa autorizada a
receber este documento, não deverá utilizar, copiar, alterar, divulgar
a informação nele contida ou tomar qualquer ação baseada nessas
informações. Se você recebeu este documento por engano, por favor,
avise imediatamente o responsável, devolvendo o documento em
seguida. Agradecemos sua cooperação.
API de Pagamento - POS Digital - Getnet 1

Sumário
HISTÓRICO DE ALTERAÇÕES ................................................................................................................................ 3

SIMULADOR DA API (REBATEDOR)....................................................................................................................... 4
INTEGRAÇÃO COM A API DE PAGAMENTO .......................................................................................................... 4
DEEPLINKS DISPONÍVEIS ...................................................................................................................................... 5
PRIORIDADE DE PAGAMENTO ............................................................................................................................. 5
MODO QUIOSQUE ............................................................................................................................................... 7
RESPONSABILIDADE DE IMPRESSÃO .................................................................................................................... 8
COMO IMPRIMIR OS COMPROVANTES .............................................................................................................................. 9
INTEGRAÇÃO PREMMIA....................................................................................................................................... 9
PIX ....................................................................................................................................................................... 9
COMO UTILIZAR O PIX ................................................................................................................................................... 9
FUNCIONALIDADES .............................................................................................................................................11
PAGAMENTO............................................................................................................................................................. 12
Pagamento v1 (Deprecated) ............................................................................................................................ 15
Pagamento v2 .................................................................................................................................................. 18
Pagamento v3 .................................................................................................................................................. 21
PRÉ-AUTORIZAÇÃO..................................................................................................................................................... 26
Pré-autorização v1 ........................................................................................................................................... 27
Pré-autorização v2 ........................................................................................................................................... 29
ESTORNO ................................................................................................................................................................. 31
REIMPRESSÃO ........................................................................................................................................................... 34
INFO........................................................................................................................................................................ 35
CONSULTA STATUS ..................................................................................................................................................... 36
IDENTIFICADOR ÚNICO DE TRANSAÇÃO .............................................................................................................39
JSONS .................................................................................................................................................................40
DADOS ADICIONAIS .................................................................................................................................................... 40
TELAS ADICIONAIS...................................................................................................................................................... 40
Como montar uma tela para CPF? ................................................................................................................... 40
Como montar uma tela para Celular? .............................................................................................................. 43
PIX | ADDITIONAL INFO .............................................................................................................................................. 48
PAYLOAD DO PIX........................................................................................................................................................ 48
DADOS DO COMPROVANTE .......................................................................................................................................... 49
Comprovante | Crédito, Débito e Voucher ....................................................................................................... 50
Comprovante | Pix ........................................................................................................................................... 52

Histórico de alterações
Versão Data Descrição
3.0 12/05/2020 Ajustes na organização da documentação.
3.1 01/06/2020 Ajustes na organização da documentação.
Nova Funcionalidade: Modo Quiosque;

4.1 07/10/2020 Inserido campo “cardholderName” no retorno das
transações.
Nova Funcionalidade: Responsabilidade de
Impressão;
Inserção do campo “automationSlip”, com dados
4.2 19/02/2021
do comprovante.
Criação de exemplo de comprovante.
Novos campos: orderId e callerId.
Nova Funcionalidade: Pagamento por Pix;
Ajuste nos campos retornados da funcionalidade
4.3 23/03/2021 Responsabilidade de Impressão.
Inserção do campo “automationPixSlip”, com
dados do comprovante Pix.
4.3.1 25/08/2021 Melhorias e correções.
4.3.2 29/07/2022 Melhorias e correções.

Simulador da API (Rebatedor)
No Portal do Desenvolvedor, no menu Documentação e SDKs, disponibilizamos o aplicativo
Rebatedor. Este aplicativo simula as requisições/respostas da aplicação de pagamento, o
objetivo é proporcionar para o desenvolvedor um ambiente o mais próximo possível do app
Pagamento. Este simulador não irá realizar as transações online com cartões, todas as
funcionalidades são "não reais" e offline - simuladas.
Obs.: O apk com o texto “universal-release” no nome, pode ser instalado no terminal debug. Os
outros apks na pasta “Rebatedor - Para simuladores” podem ser utilizados em emuladores “x86”
ou “armeabi-v7a”.
Atenção: Para que seu aplicativo seja aprovado em nosso processo de certificação é obrigatório
que ele funcione em todos os modelos de terminais do POS Digital, que são: Ingenico APOS A8
e Newland N910.
Integração com a API de pagamento

A integração com a API de pagamento se dará através de deeplinks parametrizados, por
exemplo:
public class MainActivity extends AppCompatActivity {

private final int REQUEST_CODE = 10001;
private void startIntent(Bundle bundle, String deeplink){

Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(deeplink));
if(bundle != null){
intent.putExtras(bundle);
}
startActivityForResult(intent, REQUEST_CODE);
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data){
super.onActivityResult(requestCode, resultCode, data);
if(RESULT_OK == resultCode && RESQUEST_CODE == requestCode){
foo();
}
}
}

Deeplinks disponíveis
Todos os parâmetros deverão ser enviados através do Bundle do Intent e como String:
URL Função
getnet://pagamento/v1/payment Pagamento v1 (Deprecated)

getnet://pagamento/v2/payment Pagamento v2
getnet://pagamento/v3/payment Pagamento v3
getnet://pagamento/v1/pre-authorization Pré-autorização v1
getnet://pagamento/v2/pre-authorization Pré-autorização v2
getnet://pagamento/v1/refund Reembolso
getnet://pagamento/v1/reprint Reimpressão do último comprovante
getnet://pagamento/v1/getinfos Retorna informações do terminal
getnet://pagamento/v1/checksubsellers Consulta Subseller
getnet://pagamento/v1/checkstatus Consulta Status
Prioridade de pagamento
É possível desabilitar os atalhos de “Pagamento”, “Pré-autorização” e “Estorno” da
aplicação de pagamento da Getnet, para que o cliente/usuário só possa realizar pagamentos
através da sua aplicação. Neste caso, é necessário que no arquivo AndroidManifest.xml no
elemento <application> da sua aplicação, seja inserido o meta-data conforme exemplo abaixo:
<meta-data android:name="priority_pay" android:value="1" />
Quando houver o meta-data “priority_pay” com o valor igual a 1 (um), automaticamente, os

atalhos de “Pagamento”, “Pré-autorização” e “Estorno” do aplicativo Pagamento serão
desabilitados da tela inicial, conforme a imagem a seguir:

Os atalhos poderão ser habilitados novamente, através do menu “Configurações \ Atalhos –
Tela inicial” com autenticação da senha do lojista.

Atenção: Se o aplicativo conter o meta-data de bloqueio (priority_pay), é obrigatório que o
aplicativo possua atalhos para pagamentos e estorno, pois, com o meta-data, o cliente não
poderá mais acessar diretamente a aplicação da Getnet para acessas as funcionalidades.
Modo Quiosque
O Modo Quiosque é uma funcionalidade que permiti que o POS Digital que estiver em
posse do Usuário funcione como um terminal de autoatendimento.
Principais características:
• Somente um aplicativo aberto: O usuário não poderá abrir outros aplicativos;
• Senha necessária para ativar e desativar o Modo Quiosque e para acessar
configurações do terminal;
• Tela sempre ligada;
• Pronto para ser colocado em um totem de autoatendimento;
Para que seu aplicativo possa ser utilizado no Modo Quiosque é necessário que no arquivo
AndroidManifest.xml no elemento <application> da sua aplicação, seja inserido o meta-data
conforme exemplo abaixo:
<meta-data android:name="kiosk_mode" android:value="1" />
Quando houver o meta-data “kiosk_mode” com o valor igual a 1 (um), o aplicativo irá aparecer
na lista de aplicativos disponíveis para o Modo Quiosque, conforme a imagem a seguir:

O Usuário poderá ter acesso detalhado de todas as etapas e modos de uso do Modo Quiosque
dentro da própria funcionalidade, que se encontra no aplicativo Configurar do POS Digital,
conforme as imagens abaixo:
Responsabilidade de Impressão
Ao utilizar a funcionalidade Responsabilidade de Impressão o aplicativo Pagamento não
vai imprimir os comprovantes do estabelecimento e do cliente. Seu aplicativo ficará
responsável pela impressão dos comprovantes.
Para utilizar esta funcionalidade seu aplicativo deve usar o deeplink especificado nas
seções Pagamento v3, Pré-autorização v2 ou Estorno e enviar “true” no parâmetro
allowPrintCurrentTransaction.
Atenção! Para que seu aplicativo possa utilizar este parâmetro é necessário usar em
conjunto um meta-data no arquivo AndroidManifest.xml no elemento <application> da sua
aplicação, este deve estar com o valor 1, conforme exemplo abaixo:
<meta-data android:name="allow_print_permission" android:value="1" />
Na resposta do deeplink retornará o parâmetro printMerchantPreference. Neste parâmetro

retornamos se a Via do Estabelecimento deve ser impressa ou não. Ela pode variar
dependendo da escolha do Estabelecimento. Esse parâmetro deve ser verificado e a Via do
Estabelecimento deve ser impressa conforme o retorno deste parâmetro.

Como imprimir os comprovantes
As informações mandatórias de impressão dos comprovantes do cliente e do
estabelecimento são enviadas no parâmetro automationSlip, nas respostas dos deeplinks de
pagamento, pré-autorização e estorno.
Para mais detalhes de como usar estas informações para imprimir os comprovantes, veja a
seção Dados do Comprovante.
Integração Premmia
O Premmia é o programa de fidelidade da rede de postos Petrobras. Ao integrar com
este, você pode acumular e resgatar pontos em suas transações de pagamento. Para mais
informações, de como a integrar seu aplicativo com o Premmia, consulte a documentação
“Integração Premmia” que pode ser encontrada no Portal do Desenvolvedor, no menu
Documentação e SDKs.
Pix
Uma modalidade de pagamento desenvolvida pelo Banco Central onde a transação
ocorre em segundos. Gere o QR Code direto no POS Digital e o estabelecimento recebe o
dinheiro na conta bancária em até 10 segundos.
O estabelecimento pode acessar um dos canais digitais Getnet (Portal Minha Conta ou
App Getnet) e fazer a contratação por lá, digitando a mesma chave que cadastrou no seu
domicílio bancário que irá receber Pix. Com isso a opção de pagamento por Pix ficará disponível
no POS Digital do estabelecimento.
Como utilizar o Pix

Para solicitar um pagamento com Pix, o aplicativo deve chamar o deeplink especificado
na seção Pagamento v3.
Para fazer esta requisição, além das informações básicas da forma de pagamento
(amount, paymentType, etc) você também deve informar um callerId para a requisição. Neste
campo, callerId, seu aplicativo deve enviar um valor único para cada requisição realizada
(deeplink). Este identificador é de responsabilidade da automação.
Quando um QRCode é gerado e exibido na tela, ele tem um tempo de validade e
poderá ser pago durante esse período, mesmo que o QR Code não esteja mais na tela ou o

cliente clique no botão “Cancelar” na tela do POS Digital. Caso o terminal não receba um status
final da transação (sucesso, expirado, negado, etc), a transação Pix ficará com o status
Pendente.
Para consultar uma transação Pix que ficou com o status Pendente, você pode utilizar
o deeplink Consulta Status. Ao utilizar esse deeplink, será feito uma verificação do status da
transação Pix e uma tela de sucesso ou falha será exibida, dependendo do status final da
transação. Se o Pix for aprovado a via do estabelecimento será impressa, a via do cliente ficará
disponível na tela para impressão e as informações da transação serão retornadas na resposta
da requisição. Dependendo do parâmetro allowPrintCurrentTransaction enviado na
requisição, as vias podem ser impressas ou não.
Atenção: Seu aplicativo somente pode iniciar transações Pix pelo deeplink Pagamento
v3. Integrações que ocorram de outras formas, com o sistema Pix, serão reprovadas na
certificação.
Algumas informações mais detalhadas estão nas seções Pagamento v3 e Consulta

Status.

Funcionalidades
A seguir será especificado a API para cada funcionalidade disponível.
Toda funcionalidade retornará no final um resultado conforme tabela abaixo:
Tabela de Resultados das Funcionalidades:

result resultDetails
Código O que representa
0 SUCESSO Mensagem referente a operação efetuada com sucesso
1 NEGADA Mensagem referente a transação negada pelo servidor (bandeira, device,

emissor, host...)
2 CANCELADA Mensagem referente a transação cancelada (pelo servidor ou usuário)
3 FALHA Mensagem referente a falha ao completar uma transação (internet,

servidor, emissor, ...)
4 DESCONHECIDO Erro desconhecido
5 PENDENTE Transação Pix ainda pendente de resposta. É recomendado realizar uma

Consulta Status para verificar o status final da transação Pix.

Pagamento
O deeplink de pagamento irá iniciar a aplicação de pagamento da Getnet que irá tomar
conta do terminal e iniciará o fluxo de pagamento solicitando primeiramente a forma de
pagamento como ilustrado nas imagens abaixo. Se os dados já forem enviados no deeplink,
então as telas serão automaticamente “puladas”.
No final da transação de pagamento, se a transação for aprovada, irá apresentar a tela abaixo e
a impressão da via do estabelecimento iniciará automaticamente. Ao clicar em qualquer uma
das duas opções, irá apresentar a mensagem de "Remova seu cartão" e a aplicação de
pagamento irá responder somente após a remoção do cartão, com exceção das vendas com
tarja magnética.

Caso ocorra alguma falha na transação, irá apresentar a tela abaixo e a aplicação da Getnet irá
aguardar a remoção do cartão para sair.
Nas seções a seguir serão especificadas como utilizar as versões deste deeplink:
Pagamento v1 (Deprecated), Pagamento v2 e Pagamento v3.
Recomendamos fortemente que sempre utilize a última versão disponível dos deeplinks.
Exemplo de implementação

private final String ARG_RESULT = "result";
private final String ARG_RESULT_DETAILS = "resultDetails";
private final String ARG_AMOUNT = "amount";
private final String ARG_TYPE = "type";
private final String ARG_INPUT_TYPE = "inputType";
private final String ARG_INSTALLMENTS = "installments";

private final String ARG_NSU = "nsu";
private final String ARG_BRAND = "brand";
@Override
protected void onCreate(@Nullable Bundle savedInstanceState){
super.onCreate(savedInstanceState);
Bundle bundle = new Bundle();
bundle.putString("amount", "000000001000");
bundle.putString("currencyPosition", "CURRENCY_AFTER_AMOUNT");
bundle.putString("currencyCode", "986");
Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("getnet://pagamento/v1/payment"));
}
@Override
if(REQUEST_CODE == requestCode && RESULT_OK == resultCode){
String result = data.getString(ARG_RESULT);
String resultDetails = data.getString(ARG_RESULT_DETAILS);
String amount = data.getString(ARG_AMOUNT);
String type = data.getString(ARG_TYPE);
String inputType = data.getString(ARG_INPUT_TYPE);
String installments = data.getString(ARG_INSTALLMENTS);
String nsu = data.getString(ARG_NSU);
String brand = data.getString(ARG_BRAND);
}
}
}

Pagamento v1 (Deprecated)
Atenção! Esta versão do deeplink de pagamento está sendo descontinuada e em breve

não será mais suportada. Por favor utilize a última versão do deeplink: Pagamento v3.
O deeplink getnet://pagamento/v1/payment irá iniciar a aplicação de pagamento da Getnet

que irá tomar conta do terminal e iniciará o fluxo de pagamento.
Abaixo seguem as tabelas de requisição e resposta e seus respectivos parâmetros:
Request (Deprecated)
Obrigatoriedade Parâmetro Formato Descrição
Este parâmetro informa qual o tipo de

pagamento que será feito:
“credit”, “debit”, “voucher”
OPCIONAL paymentType String
Se esse campo for informado a tela de seleção
de tipo de pagamento será pulada.
Se informado “credit” no parâmetro

“paymentType” então o “creditType” deverá
ser informado com o tipo de crédito:
“creditMerchant” - Crédito parcelado Lojista
“creditIssuer” - Crédito parcelado Emissor
OPCIONAL creditType String
Se informado “credit” no parâmetro
“paymentType” então a tela de tipo de crédito
será pulada.
Crédito à vista não precisa enviar este campo.
Este parâmetro informa o número de parcelas.
OPCIONAL installments String Se informado o parâmetro “creditType” com o

valor “creditMerchant” ou “creditIssuer” então
este parâmetro deve ser informado.
12 dígitos representando o valor, considerando

os últimos 2 dígitos como casas decimais.
Exemplo: "000000001234" é equivalente R$
OPCIONAL amount String 12,34
Se não for informado, o usuário precisará

preencher o valor no app de Pagamento
"CURRENCY_AFTER_AMOUNT" ou
"CURRENCY_BEFORE_AMOUNT"
OPCIONAL currencyPosition String
Default : “CURRENCY_BEFORE_AMOUNT”

Código da moeda, de acordo com a ISO-4217
Exemplo: "986" este é código do Real (R$)
Para a lista completa das moedas acesse:
OPCIONAL currencyCode String
https://pt.wikipedia.org/wiki/ISO_4217
Default: “986”
Este parâmetro define como tem que ser

apresentada a(s) tela(s) adicional(is) após o
OPCIONAL extraScreens String portador do cartão preencher a senha.
Mais detalhes na seção Telas Adicionais.
Este parâmetro serve para o adicionar campos

para ser enviado para o host da getnet.
OPCIONAL extraData String
Mais detalhes na seção Dados Adicionais.
Bloqueia a funcionalidade de digitar o número

do portador do cartão na tela que solicitar o
cartão.
OPCIONAL disableTypedTransaction Boolean
Para desabilitar: “true”
Para habilitar: “false”
Default: “false”
Desabilita a leitora de cartões com tarja.

OPCIONAL disableMagStripe Boolean
Desabilita o espaçamento final para o corte da

via do cliente.
OPCIONAL disableCustomerSlipSpace Boolean Para desabilitar: “false”

Para habilitar: “true”
Neste parâmetro deve ser enviado um valor

único para cada pedido. Este identificador é de
responsabilidade da automação e será
OPCIONAL orderId String
repassado para o Conciliador.
String de até 50 caracteres.
Response (Deprecated)
Quando
Parâmetro Formato Descrição
retorna?
Resultado da transação, conforme a Tabela de

SEMPRE result String
Resultados das Funcionalidades.

Texto com detalhes do retorno, conforme a
OPCIONAL resultDetails String
Tabela de Resultados das Funcionalidades.

SEMPRE amount String os últimos 2 dígitos como casas decimais.
Exemplo: 000000001234 = R$ 12,34
Código de autorização da transação da Getnet

– ele é único por terminal(CV impresso no
OPCIONAL nsu String
comprovante, não pode se repetir no mesmo
dia)
OPCIONAL nsuLastSuccesfullMessage String Último NSU da GetNet gerado com sucesso
Número do CV – informação que deve ser

OPCIONAL cvNumber String
enviada no estorno - ele é único por terminal
02 - Débito
11 - Crédito a vista
SEMPRE type String 12 - Crédito parcelado Lojista
13 - Crédito parcelado Emissor
03 - Voucher
OPCIONAL brand String Bandeira do cartão utilizado
021 - tarja magnética

051 - chip
SEMPRE inputType String
071 - chip sem contato
801 - tarja magnética - fallback
OPCIONAL installments String Quantidade de parcelas selecionada
Data e hora GMT da transação

OPCIONAL gmtDateTime String (MMDDhhmmss). Este campo representa o
horário GMT
NSU gerado no terminal(DOC impresso no

OPCIONAL nsuLocal String comprovante, número sequencial por
terminal)
Código único de autorização (AUT impresso no

comprovante, pode se repetir)
OPCIONAL authorizationCode String
*Este campo é de responsabilidade da
bandeira*
OPCIONAL cardBin String Os 6 primeiros dígitos do cartão
OPCIONAL cardLastDigits String Os 4 últimos dígitos do cartão
Quando for enviada na requisição o campo

extraScreens. O retorno será o mesmo só que
OPCIONAL extraScreensResult String com o campo value do field preenchido.
Retorna o nome do portador gravado no

OPCIONAL cardholderName String
cartão, se disponível.

Neste parâmetro enviamos as informações que
devem ser incluídas nos Comprovantes
Impressos do estabelecimento e do cliente.
Seu aplicativo só é obrigado a imprimir esses
campos caso você opte por usar a
OPCIONAL automationSlip String funcionalidade Responsabilidade de
Impressão, pois nesse caso o aplicativo
Pagamento não irá imprimir os comprovantes.
Mais detalhes na seção Dados do

Comprovante.
Retorna caso um orderId tenha sido enviado na

requisição.
Este identificador é de responsabilidade da
automação e é repassado para o Conciliador.
Pagamento v2
O deeplink getnet://pagamento/v2/payment irá iniciar a aplicação de pagamento da Getnet

em modo Split de Pagamento, que irá tomar conta do terminal.
Atenção! A partir desta versão alguns campos que eram opcionais se tornaram obrigatórios.
Request

“credit”, “debit” ou “voucher(*)”
OBRIGATÓRIO paymentType String
(*) Voucher pode ser usado no Pagamento v2,
mas apenas em pagamentos sem Split de
Pagamento.
*Se informado “credit” no parâmetro

“paymentType” então o “creditType” deverá
ser informado com o tipo de crédito:
OBRIGATÓRIO(*) creditType String
“creditMerchant” - Crédito parcelado Lojista
Crédito à vista não precisa enviar este campo.
Este parâmetro informa o número de parcelas.
(*) Se informado o parâmetro “creditType”

OPCIONAL(*) installments String
com o valor “creditMerchant” ou
“creditIssuer” então este parâmetro deve ser
informado.

OBRIGATÓRIO amount String
12,34

OPCIONAL currencyCode String
Default: “986”

portador do cartão preencher a senha.
OPCIONAL(*) extraScreens String Mais detalhes na seção Telas Adicionais.
(*) Para utilizar o Split de Pagamento, não é

permitido enviar este parâmetro. Se enviado
na requisição, será retornado um erro.
Este parâmetro serve para o adicionar campos

para ser enviado para o host da Getnet.

OPCIONAL(*) extraData String
permitido enviar este parâmetro. Se enviado
na requisição, será retornado um erro.
Bloqueia a funcionalidade de digitar o número

do portador do cartão na tela que solicitar o
cartão.
OPCIONAL disableTypedTransaction boolean

OPCIONAL disableMagStripe boolean

Desabilita o espaçamento final para o corte da
via do cliente.
OPCIONAL disableCustomerSlipSpace boolean Para desabilitar: “false”


Response
Quando
retorna?



Exemplo: 000000001234 = R$ 12,34

OPCIONAL nsu String
dia)
OPCIONAL nsuLastSuccesfullMessage String Último NSU da Getnet gerado com sucesso

02 - Débito
SEMPRE type String 12 - Crédito parcelado Lojista
03 - Voucher

051 - chip

horário GMT

terminal)

bandeira*



OPCIONAL automationSlip String funcionalidade Responsabilidade de Impressão,
pois nesse caso o aplicativo Pagamento não irá
imprimir os comprovantes.

Comprovante.

requisição.
Pagamento v3
Essa versão da aplicação de Pagamento tem suporte a transações Pix e a

Responsabilidade de Impressão (Uma funcionalidade que permite que seu aplicativo imprima
os comprovantes).
O deeplink getnet://pagamento/v3/payment irá iniciar a aplicação de pagamento da

Getnet que irá tomar conta do terminal e iniciará o fluxo de pagamento.
Foi adicionado o campo allowPrintCurrentTransaction, ao utilizar este parâmetro o

aplicativo Pagamento não irá imprimir os comprovantes e seu aplicativo ficará responsável
pela impressão. Para mais detalhes veja a seção Responsabilidade de Impressão.

Foi adicionado o campo callerId. Neste campo seu aplicativo deve enviar um valor
único para cada requisição realizada (deeplink).
Atenção: Este identificador callerId é de responsabilidade da automação e deve ser

gerenciado corretamente para que se possa consultar o status de transações a partir do
deeplink Consulta Status.
Foi adicionado o campo additionalInfo. Este parâmetro serve para acrescentar

informações adicionais sobre a transação Pix que está sendo iniciada.
Request

credit
debit
OBRIGATÓRIO paymentType String voucher (*)
pix (*)
(*) Voucher e Pix podem ser usados no

Pagamento v3, mas apenas em pagamentos
sem Split de Pagamento.
*Se informado “credit” no parâmetro

“paymentType” então o “creditType”
deverá ser informado com o tipo de crédito:
“creditMerchant” - Crédito parcelado
OBRIGATÓRIO(*) creditType String
Lojista
Crédito à vista não precisa enviar este
campo.
Este parâmetro informa o número de

parcelas.
OPCIONAL(*) installments String (*) Se informado o parâmetro “creditType”

com o valor “creditMerchant” ou
“creditIssuer” então este parâmetro deve
ser informado.
12 dígitos representando o valor,

considerando os últimos 2 dígitos como
OBRIGATÓRIO amount String casas decimais.
12,34

único para cada requisição realizada
(deeplink). Este identificador é de
responsabilidade da automação e pode ser
OBRIGATÓRIO callerId String utilizado para consultar o status de
transações a partir do deeplink Consulta
Status.
Código da moeda, de acordo com a ISO-

4217
OPCIONAL currencyCode String Para a lista completa das moedas acesse:
Default: “986”

portador do cartão preencher a senha.

OPCIONAL(*) extraScreens String
permitido enviar este parâmetro. Se
enviado na requisição, será retornado um
erro.
Este parâmetro serve para o adicionar

campos para ser enviado para o host da
Getnet.

OPCIONAL(*) extraData String
permitido enviar este parâmetro. Se
enviado na requisição, será retornado um
erro.
Bloqueia a funcionalidade de digitar o

número do portador do cartão na tela que
solicitar o cartão.
OPCIONAL disableTypedTransaction boolean


OPCIONAL disableMagStripe boolean
Desabilita o espaçamento final para o corte

da via do cliente.
OPCIONAL disableCustomerSlipSpace boolean Para desabilitar: “false”

Ao habilitar este parâmetro, o aplicativo

Pagamento não vai imprimir os
comprovantes do estabelecimento e do
cliente. Seu aplicativo ficará responsável
pela impressão dos comprovantes. Mais
detalhes na seção Responsabilidade de
OPCIONAL allowPrintCurrentTransaction boolean
Impressão.
Para desabilitar: “false”


único para cada pedido. Este identificador é
de responsabilidade da automação e será
Este parâmetro serve para acrescentar

informações adicionais sobre o pagamento
Pix que está sendo iniciado. Estas
informações serão apresentadas ao
OPCIONAL additionalInfo String pagador, em seu aplicativo de pagamento,
após a leitura do QR Code Pix.
Mais detalhes na seção Pix – Additional

Info.
Response
Quando
retorna?



Exemplo: 000000001234 = R$ 12,34
Retorna o callerId que foi enviado na requisição.

SEMPRE callerId String Este identificador é de responsabilidade da
automação.
Código de autorização da transação da Getnet –

ele é único por terminal(CV impresso no
OPCIONAL nsu String
dia)

02 - Débito
12 - Crédito parcelado Lojista
SEMPRE type String
03 - Voucher
30 - Pix

051 - chip
Data e hora GMT da transação (MMDDhhmmss).

OPCIONAL gmtDateTime String
Este campo representa o horário GMT

OPCIONAL nsuLocal String
comprovante, número sequencial por terminal)

bandeira*

Retorna o nome do portador gravado no cartão,

se disponível.

Impressos do estabelecimento e do cliente para
transações de Crédito, Débito ou Voucher.

campos caso você opte por usar a funcionalidade
Responsabilidade de Impressão, pois nesse caso
OPCIONAL automationSlip String
o aplicativo Pagamento não irá imprimir os
comprovantes.
Este parâmetro não comtempla os

comprovantes de transações Pix. Este é enviado
no parâmetro pixPayloadResponse.
Mais detalhes na seção Dados do Comprovante.
Neste parâmetro retornamos se a Via do

Estabelecimento deve ser impressa ou não. Ela
pode variar dependendo da escolha do
Estabelecimento.
Esse parâmetro deve ser verificado caso você

opte por usar a funcionalidade Responsabilidade
OPCIONAL printMerchantPreference Boolean de Impressão e a Via do Estabelecimento deve
ser impressa conforme o retorno deste
parâmetro.
true – Deve ser impressa a Via do

Estabelecimento nos comprovantes de venda.
false – Não deve ser impressa a Via do

requisição.
(*)Retorna quando a requisição de pagamento

for do tipo Pix.
OPCIONAL(*) pixPayloadResponse String
Mais detalhes na seção Payload do Pix.
Pré-autorização
Este deeplink pode ser utilizado para realizar uma pré-autorização. Ao ser utilizado irá iniciar o
app Pagamento na tela de Pré-autorização.

private final String ARG_TYPE = "type";
private final String ARG_INPUT_TYPE = "inputType";
private final String ARG_INSTALLMENTS = "installments";
private final String ARG_NSU = "nsu";
private final String ARG_BRAND = "brand";
@Override
Bundle bundle = new Bundle();
bundle.putString("amount", "000000001000");
bundle.putString("currencyPosition", "CURRENCY_AFTER_AMOUNT");
bundle.putString("currencyCode", "986");
Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("getnet://pagamento/v1/pre-authorization"));
}
@Override
String type = data.getString(ARG_TYPE);
String inputType = data.getString(ARG_INPUT_TYPE);
String installments = data.getString(ARG_INSTALLMENTS);
String nsu = data.getString(ARG_NSU);
String brand = data.getString(ARG_BRAND);
}
}
}
Pré-autorização v1
O deeplink getnet://pagamento/v1/pre-authorization irá iniciar o app de Pagamento na tela

de Pré-autorização.
Request

OBRIGATÓRIO amount String
12,34
OBRIGATÓRIO currencyPosition String

OBRIGATÓRIO currencyCode String

Response
Quando retorna? Parâmetro Formato Descrição

Texto com detalhes do retorno, conforme a Tabela

de Resultados das Funcionalidades.
12 dígitos representando o valor, considerando os

SEMPRE amount String últimos 2 dígitos como casas decimais.
Exemplo: 000000001234 = R$ 12,34
Código de autorização da transação(CV impresso

OPCIONAL nsu String no comprovante, não pode se repetir no mesmo
dia)
SEMPRE type String

051 - chip
Retorna o nome do portador gravado no cartão, se

disponível.

devem ser incluídas nos Comprovantes Impressos
do estabelecimento e do cliente.
campos caso você opte por usar a funcionalidade
Responsabilidade de Impressão, pois nesse caso o
aplicativo Pagamento não irá imprimir os
comprovantes.

requisição.
Pré-autorização v2
Essa versão da aplicação de Pagamento tem suporte a Responsabilidade de Impressão, uma

funcionalidade que permite que seu aplicativo imprima os comprovantes.
O deeplink getnet://pagamento/v2/pre-authorization irá iniciar o app de Pagamento na tela

de Pré-autorização.
Foi adicionado o campo allowPrintCurrentTransaction, ao utilizar este parâmetro o

aplicativo Pagamento não irá imprimir os comprovantes e seu aplicativo ficará responsável
pela impressão. Para mais detalhes veja a seção Responsabilidade de Impressão.
Foi adicionado o campo callerId. Neste campo seu aplicativo deve enviar um valor
único para cada requisição realizada (deeplink). Atenção: Este identificador é de
responsabilidade da automação e deve ser gerenciado corretamente para que se possa
consultar o status de transações a partir do deeplink Consulta Status.
Request
12 dígitos representando o valor,

considerando os últimos 2 dígitos como
OBRIGATÓRIO amount String casas decimais.
Exemplo: "000000001234" é
equivalente R$ 12,34
OBRIGATÓRIO currencyPosition String
Código da moeda, de acordo com a ISO-

4217
Exemplo: "986" este é código do Real
OBRIGATÓRIO currencyCode String (R$)
Para a lista completa das moedas
acesse:

Neste parâmetro deve ser enviado um
valor único para cada requisição
realizada (deeplink). Este identificador é
de responsabilidade da automação e
OBRIGATÓRIO callerId String pode ser utilizado para consultar o
status de transações a partir do deeplink
Consulta Status.

cliente. Seu aplicativo ficará
responsável pela impressão dos
comprovantes. Mais detalhes na seção
OPCIONAL allowPrintCurrentTransaction boolean
Responsabilidade de Impressão.

Neste parâmetro deve ser enviado um

valor único para cada pedido. Este
identificador é de responsabilidade da
OPCIONAL orderId String automação e será repassado para o
Conciliador.
Response
Quando
retorna?

Texto com detalhes do retorno, conforme a Tabela de


SEMPRE amount String últimos 2 dígitos como casas decimais.
Exemplo: 000000001234 = R$ 12,34
Retorna o callerId que foi enviado na requisição.

SEMPRE callerId String Este identificador é de responsabilidade da
automação.
Código de autorização da transação(CV impresso no

OPCIONAL nsu String
comprovante, não pode se repetir no mesmo dia)
SEMPRE type String

051 - chip
Retorna o nome do portador gravado no cartão, se

disponível.

devem ser incluídas nos Comprovantes Impressos do
estabelecimento e do cliente.
Seu aplicativo só é obrigado a imprimir esses campos
caso você opte por usar a funcionalidade
aplicativo Pagamento não irá imprimir os
comprovantes.

requisição.
Estorno
O deeplink getnet://pagamento/v1/refund irá iniciar o app de Pagamento na tela de estorno.
Se a requisição for enviada com todos os parâmetros preenchidos, a próxima tela a ser
mostrada será a de inserir o cartão para realizar o estorno.
Se a requisição for enviada com parâmetros faltando, a próxima tela a ser mostrada será a de
preenchimento manual dos parâmetros restantes. Ao preencher os parâmetros e tocar no
botão Continuar, a tela de inserir o cartão será mostrada.
O estorno também pode ser realizado diretamente no aplicativo Pagamento, acessando a

opção Estorno e preenchendo os dados manualmente.
O parâmetro originTerminal da requisição e o campo “Terminal de origem” da tela de Estorno

do aplicativo Pagamento só podem ser utilizados caso a funcionalidade de Pré-autorização
esteja habilitada no estabelecimento. Quando este parâmetro não é informado, será utilizado
o número lógico do terminal que está executando o procedimento.
O estorno de pagamento através do deeplink ou do aplicativo Pagamento, pode ser realizado

apenas no mesmo dia. Caso o estabelecimento queira estornar uma transação que foi
realizada no dia anterior, este deve entrar em contato com a Getnet.

Request

OPCIONAL amount String últimos 2 dígitos como casas decimais.
Exemplo: 000000001234 = R$ 12,34
Data da transação a ser estornada. Por padrão será

OPCIONAL transactionDate String
o dia corrente. Enviar no formato: “dd/MM/yyyy”
Número do CV da transação a ser estornada. É o

mesmo campo que o pagamento retorna.
Número lógico do terminal que efetuou a

transação a ser estornada. Este parâmetro só pode
ser utilizado caso a funcionalidade de Pré-
OPCIONAL originTerminal String autorização esteja habilitada no estabelecimento.
Quando este parâmetro não é informado, será
utilizado o número lógico do terminal que está
executando o procedimento.

Pagamento não vai imprimir os comprovantes do
estabelecimento e do cliente. Seu aplicativo ficará
responsável pela impressão dos comprovantes.
Mais detalhes na seção Responsabilidade de
allowPrintCurrentTra
OPCIONAL boolean Impressão.
nsaction
Response
Quando
retorna?



Exemplo: 000000001234 = R$ 12,34

horário GMT

OPCIONAL nsu String
dia)

OPCIONAL nsuLocal String
comprovante, incremental por dia)
OPCIONAL nsuLastSuccesfullMessage String Último NSU da GetNet gerado com sucesso

bandeira*
Data da transação estornada. No formato:

OPCIONAL refundTransactionDate String
“ddMMyyyy”
Número do CV da transação estornada. É o

OPCIONAL refundCvNumber String
mesmo campo que o pagamento retorna.
Número lógico do terminal que efetuou a

OPCIONAL refundOriginTerminal String
transação estornada



Comprovante.

@Override
Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("getnet://pagamento/v1/refund"));
}
@Override
}

}
}
Reimpressão
O deeplink getnet://pagamento/v1/reprint irá reimprimir o último comprovante.
Abaixo segue a tabela de resposta e seus respectivos parâmetros:
Response


@Override
Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("getnet://pagamento/v1/reprint"));
}
@Override
}
}
}

Info
O deeplink getnet://pagamento/v1/getinfos irá retornar os dados do terminal via
activityResult.
Abaixo segue a tabela de resposta e seus respectivos parâmetros:
Response
String Resultado da transação, conforme a Tabela de Resultados

SEMPRE result
das Funcionalidades.
SEMPRE ec String Número do estabelecimento comercial vinculado
SEMPRE numserie String Número de série do equipamento
SEMPRE numlogic String Número lógico do equipamento vinculado
SEMPRE version String Versão da API
SEMPRE cnpjEC String CNPJ do estabelecimento vinculado à Getnet
SEMPRE nomeEC String Nome do estabelecimento vinculado
SEMPRE razaoSocialEC String Razão social do estabelecimento vinculado
SEMPRE cidadeEC String Cidade do estabelecimento, onde foi credenciado

private final String ARG_EC = "ec";
private final String ARG_NUM_SERIE = "numserie";
private final String ARG_NUM_LOGIC = "numlogic";
private final String ARG_VERSION = "version";
private final String ARG_CNPJ = "cnpjEC";
private final String ARG_NAME = "nomeEC";
private final String ARG_RAZAO_SOCIAL = "razaoSocialEC";
private final String ARG_CIDADE = "cidadeEC";
@Override
Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("getnet://pagamento/v1/getinfos"));
}
@Override
String ec = data.getString(ARG_EC);

String numSerie = data.getString(ARG_NUM_SERIE);
String numLogic = data.getString(ARG_NUM_LOGIC);
String apiVersion = data.getString(ARG_VERSION);
String cnpj = data.getString(ARG_CNPJ);
String name = data.getString(ARG_NAME);
String name = data.getString(ARG_RAZAO_SOCIAL);
String name = data.getString(ARG_CIDADE);
}
}
}
Consulta Status
Utilize o deeplink getnet://pagamento/v1/checkstatus para verificar o status de transações Pix
que ficaram pendentes ou para receber as informações de transações que já foram aprovadas,
sejam elas crédito, débito, voucher ou Pix.
Esta consulta só verifica o status e retorna informações de transações realizadas pelo

Pagamento v3. Pois, para fazer a consulta, um callerId precisa ter sido enviado na requisição
de pagamento.
Ao utilizar a Consulta Status, enviando um callerId válido, três cenários podem ocorrer:
1. Pix pendentes: Se o callerId, enviado na requisição, for de uma transação Pix que ficou
pendente de resposta no terminal, será feito uma verificação do status desta transação
Pix e uma tela de sucesso ou falha será exibida, dependendo do status. A via do
estabelecimento será impressa, a via do cliente ficará disponível na tela para impressão
e as informações da transação serão retornadas na resposta da requisição, do mesmo
modo como ocorre ao fim de transações realizadas com o deeplink Pagamento v3.
Dependendo do parâmetro allowPrintCurrentTransaction enviado na requisição, as
vias podem ser impressas ou não.
2. Transações aprovadas: Se o callerId for de uma transação que foi aprovada, seja ela
crédito, débito, voucher ou Pix, as informações da transação serão retornadas na
resposta da requisição. A tela de sucesso de transação não será exibida e os
comprovantes não serão impressos. Os campos da resposta são os mesmos que
retornam em um deeplink Pagamento v3.
3. Transações que não foram aprovadas ou com callerId desconhecido: Se o callerId for
de uma transação que não foi aprovada (falhou, negada, cancelada) ou com um callerId
diferente do que temos armazenado no terminal, o resultado da requisição será de
falha, retornando que não foram encontrados dados para o callerId informado. Isso
ocorre para transações de Crédito, Débito, Voucher ou Pix.

Atenção: Esta consulta poderá ser utilizada em transação realizadas nas últimas 24 horas no
terminal. Caso um callerId seja enviado de uma transação realizada a mais de 24 horas, o
retorno será de falha.
Request
Neste parâmetro deve-se enviar o callerId

que identifica a transação a ser consultada.
OBRIGATÓRIO callerId String Este identificador é de responsabilidade da

automação, e precisa ter sido utilizado em
uma requisição de Pagamento v3 antes da
Consulta Status.

cliente. Seu aplicativo ficará responsável pela
impressão dos comprovantes. Mais detalhes
OPCIONAL allowPrintCurrentTransaction boolean na seção Responsabilidade de Impressão.

Response



OPCIONAL amount String os últimos 2 dígitos como casas decimais.
Exemplo: 000000001234 = R$ 12,34
Retorna o callerId que foi enviado na

requisição.
OPCIONAL callerId String
automação.

OPCIONAL nsu String
dia)

02 - Débito
OPCIONAL type String 12 - Crédito parcelado Lojista
03 - Voucher

051 - chip
OPCIONAL inputType String

horário GMT

terminal)

bandeira*




Comprovante.

Neste parâmetro retornamos se a Via do
Estabelecimento deve ser impressa ou não. Ela
pode variar dependendo da escolha do
Estabelecimento.
Esse parâmetro deve ser verificado caso você

opte por usar a funcionalidade
OPCIONAL printMerchantPreference boolean Responsabilidade de Impressão e a Via do
Estabelecimento deve ser impressa conforme o
retorno deste parâmetro.
true – Deve ser impressa a Via do

false – Não deve ser impressa a Via do

requisição.
(*)Retorna quando a requisição de pagamento

for do tipo Pix.
OPCIONAL(*) pixPayloadResponse String
Mais detalhes na seção Payload do Pix.
Retorna se a transação foi estornada.

OPCIONAL refunded boolean true – Foi estornada.
false – Não foi estornada.
Identificador Único de Transação

Caso houver necessidade de criar um identificador das transações, recomendamos utilizar o
retorno dos parâmetros NSU, Número Lógico e data, concatenando os três formará um
identificador de transações único. Estes parâmetros são retornos do deeplink “Pagamento”,
com exceção do Número Lógico que é retornado no deeplink “Info”.
NSU - Código de autorização da transação Getnet, este pode se repetir em terminais e dias
diferentes.
Parâmetro: nsu
Número Lógico - Identificação do terminal em que a transação foi realizada.

Parâmetro: numlogic
Data - Data em que foi realizada a transação. Ex: 27/01/2020 = 0127.

Parâmetro: gmtDateTime

JSONs
Dados Adicionais
Este parâmetro serve para adicionar campos para serem enviados para o host da Getnet.
Atenção: Se precisar utilizar este campo, entre em contato com a Getnet.
Abaixo segue a tabela de requisição e seus respectivos campos do JSON:
Request
Obrigatoriedade Campo Formato Descrição
O campo tags é uma lista do tipo tag que possui os

campos:
String numérica de 4 dígitos. Código utilizado para
OBRIGATÓRIO extradata.tags[].tag String n4
integração com serviços específicos da Getnet.
Atenção: Se precisar utilizar este campo, entre em
contato com a Getnet.
extradata String É o conteúdo da tag. Formato String de até no máximo 99

OBRIGATÓRIO
.tags[].value ans99 caracteres.
Exemplo JSON
{
"tags": [
{
"tag": "0000",
"value": "ABCDEF1234123"
}
]
}
Telas Adicionais
Ao utilizar a funcionalidade Telas Adicionais, será apresentada uma tela adicional após o
portador do cartão preencher a senha. Nesta tela adicional pode ser requisitado ao usuário
algum dado pessoal. Este parâmetro define as informações que vão aparecer nesta tela.
Pode ser requisitado ao usuário o preenchimento de CPF ou Celular.
Como montar uma tela para CPF?
Abaixo seguem exemplos de como montar uma tela para CPF:

CPF - Exemplo JSON da requisição
{
"pages": [
{
"buttons": [
{
"action": "skip",
"key": "btn1",
"text": "Não preencher"
},
{
"action": "append",
"key": "btn2",
"text": "Continuar"
}
],
"fields": [
{
"hint": "Digite seu cpf.",
"key": "cpf",
"type": "edit_text",
"v_cpf": {
"err": "CPF inválido",
"value": "true"
},
"v_required": {

"err": "Campo obrigatório",
"value": "true"
}
}
],
"subTitle": "Digite seu cpf.",
"title": "CPF"
}
]
}
CPF - Exemplo JSON de Resposta

Exemplo de JSON de resposta com todos os campos enviados na requisição e o campo “value”
com o dado preenchido pelo usuário (sem máscara de CPF).
{
"pages": [
{
"buttons": [
{
"action": "skip",
"key": "btn1",
},
{
"action": "append",
"key": "btn2",
"text": "Continuar"
}
],
"fields": [
{
"hint": "Digite seu cpf.",
"key": "cpf",
"v_cpf": {
"err": "CPF inválido",
"value": "true"
},
"v_required": {
"value": "true"
},
"value":"01910000000"
}
],
"subTitle": "Digite seu cpf.",
"title": "CPF"
}

]
}
Como montar uma tela para Celular?
Abaixo seguem exemplos de como montar uma tela para Celular:
Celular - Exemplo JSON da requisição

{
"pages": [
{
"buttons": [
{
"action": "skip",
"key": "btn1",
},
{
"action": "append",
"key": "btn2",
"text": "Continuar"
}
],
"fields": [

{
"hint": "Digite seu telefone.",
"key": "phone",
"v_phone": {
"err": "Telefone inválido",
"value": "true"
},
"v_required": {
"value": "true"
}
}
],
"subTitle": " Digite seu telefone.",
"title": "Telefone"
}
]
}
Celular - Exemplo JSON de Resposta

Exemplo de JSON de resposta com todos os campos enviados na requisição e o campo “value”
com o dado preenchido pelo usuário (sem máscara de celular).
{
"pages": [
{
"buttons": [
{
"action": "skip",
"key": "btn1",
},
{
"action": "append",
"key": "btn2",
"text": "Continuar"
}
],
"fields": [
{
"hint": "Digite seu telefone.",
"key": "phone",
"v_phone": {
"err": "Telefone inválido",
"value": "true"
},
"v_required": {

"value": "true"
},
"value":"51999911445"
}
],
"subTitle": "Digite seu telefone.",
"title": "Telefone"
}
]
}
Abaixo seguem as tabelas de requisição e resposta e seus respectivos campos do JSON:
Request
Strings que devem ser

enviadas neste
campo:
"action":"skip"
Ignora o que foi
digitado pelo usuário
OBRIGATÓRIO extrascreens.pages[].buttons[].action String e fecha ou vai pra
próxima tela.
"action":"append"
Guarda o que o
usuário digitou e
fecha ou vai pra
próxima tela.
O nome/id para o
OBRIGATÓRIO extrascreens.pages[].buttons[].key String botão. Campo fixo:
usar “btn1” e “btn2”
Texto que vai

aparecer no botão.
Sugestão de texto
para botão esquerdo
OBRIGATÓRIO extrascreens.pages[].buttons[].text String
(“btn1”) e direito
(“btn2”): “Não
preencher” e
“Continuar”
Texto que aparece no

hint do editText.
OBRIGATÓRIO extrascreens.pages[].fields[].hint String 30
Tamanho máximo: 30
caracteres.

String numérica de 4
dígitos. Código
utilizado para
integração com
serviços específicos
OPCIONAL extrascreens.pages[].fields[].tag String 4
da Getnet.
Atenção: Se precisar
utilizar este campo,
entre em contato
com a Getnet.
Strings que podem

ser enviadas neste
campo:
"key":"cpf"
Utilize esta String
para requisitar ao
usuário o
OBRIGATÓRIO extrascreens.pages[].fields[].key String preenchimento de
CPF.
"key":"phone"
Utilize esta String
para requisitar ao
usuário o
preenchimento de
Celular.
Define o tipo de input

do field. Atualmente
OBRIGATÓRIO extrascreens.pages[].fields[].type String
é somente:
“edit_text”.
Define que o input

tem que ser um
OPCIONAL
número de CPF
(Só utilize este campo extrascreens.pages[].fields[].v_cpf
válido. Possui os
para CPF)
subcampos: “err” e
“value”.
Mensagem de erro
que aparece quando
OPCIONAL
não passar no
(Só utilize este campo extrascreens.pages[].fields[].v_cpf.err String 20
validador de CPF.
para CPF)
Tamanho máximo: 20
caracteres.
Habilita o validador
OPCIONAL de CPF ao mandar
(Só utilize este campo extrascreens.pages[].fields[].v_cpf.value String “true”.
para CPF) Opções de string:
“true” ou “false”

Define que o input
tem que ser um
OPCIONAL
número de celular
(Só utilize este campo extrascreens.pages[].fields[].v_phone
válido. Possui os
para Celular)
subcampos: “err” e
“value”.
Mensagem de erro
que aparece quando
OPCIONAL
não passar no
(Só utilize este campo extrascreens.pages[].fields[].v_ phone.err String 20
validador de Celular.
para Celular)
Tamanho máximo: 20
caracteres.
Habilita o validador
OPCIONAL de Celular ao mandar
(Só utilize este campo extrascreens.pages[].fields[].v_ phone.value String “true”.
para Celular) Opções de string:
Define o
preenchimento do
campo como
obrigatório. Verifica
OBRIGATÓRIO extrascreens.pages[].fields[].v_required
se o campo foi
preenchido pelo
usuário ao clicar no
botão “btn2”.
Mensagem de erro
mostrada ao usuário
quando o campo não
tiver sido preenchido
OBRIGATÓRIO eExtrascreens.pages[].fields[].v_required.err String 20
e o “btn2” for
apertado.
Tamanho máximo: 20
caracteres.
Habilita se o campo é
obrigatório para
OBRIGATÓRIO extrascreens.pages[].fields[].v_required.value String preencher.
Opções de string:
Texto que será

mostrado no
OBRIGATÓRIO extrascreens.pages[].subTitle String 50 subtítulo da tela.
Tamanho máximo: 50
caracteres.
Texto que será

mostrado no título da
OBRIGATÓRIO extrascreens.pages[].title String 10 tela.
Tamanho máximo: 10
caracteres.

Pix | Additional Info
Este parâmetro serve para acrescentar informações adicionais sobre o pagamento Pix que está
sendo iniciado. Estas informações serão apresentadas ao pagador, em seu aplicativo de
pagamento, após a leitura do QR Code Pix.
Abaixo segue a tabela de requisição e seus respectivos campos do JSON:
Request
Informação adicional sobre o pagamento. Este campo

representa o título da informação.
String
OBRIGATÓRIO additional_info[].name Esta informação será apresentada ao pagador, em seu
50
aplicativo de pagamento, após a leitura do QR Code Pix.
Tamanho máximo: 50 caracteres.
Informação adicional sobre o pagamento. Este campo

representa a descrição da informação.
String
OBRIGATÓRIO additional_info [].value Esta informação será apresentada ao pagador, em seu
200
aplicativo de pagamento, após a leitura do QR Code Pix.
Tamanho máximo: 200 caracteres.
Exemplo JSON
{
"additional_info": [
{
"name": "Campo1",
"value": "Informação Adicional do PSP - Recebedor"
}
]
}
Payload do Pix
Neste parâmetro retornamos informações relacionadas a transações do tipo Pix.
Abaixo segue a tabela de resposta e seus respectivos campos do JSON:
Response

Neste parâmetro enviamos as informações que devem
ser incluídas nos Comprovantes Impressos do
estabelecimento e do cliente para transações Pix.
Seu aplicativo só é obrigado a imprimir esses campos
OBRIGATÓRIO automationPixSlip JSON (String) caso você opte por usar a funcionalidade
aplicativo Pagamento não irá imprimir os comprovantes.
O campo status representa a situação da transação no

momento da resposta. Este pode retornar os seguintes
estados:
OBRIGATÓRIO status String 2
00 – Pago
81 – A pagar
86 - Expirado
OBRIGATÓRIO transactionId String 35 Código de identificação da transação Pix.
Exemplo JSON
{
"automationPixSlip": "", //Exemplo da resposta na seção Dados do Comprovante
"status": "00",
"transactionId": "000000050081910000120648"
}
Dados do Comprovante
Neste parâmetro enviamos as informações que devem ser incluídas nos Comprovantes do
estabelecimento e do cliente.
Atenção! Seu aplicativo só é obrigado a imprimir esses campos caso você opte por usar a
funcionalidade Responsabilidade de Impressão, pois nesse caso o aplicativo Pagamento não irá
Abaixo estão os subitens que virão no campo “automationSlip” ou “automationPixSlip”:
• mandatory_all_receipts_fields:
Campos obrigatórios nas Vias do Cliente e do Estabelecimento;
• mandatory_client_fields:
Campos obrigatórios na Via do Cliente;
mandatory_ec_fields:
Campos obrigatórios na Via do Estabelecimento.
Dependendo do tipo da transação (Credito, Débito, Pix, Chip, Tarja, Qr Code e etc.) alguns
campos podem vir, ou não. O aplicativo Pagamento será responsável por retornar os campos
que devem ser impressos/armazenados, ou seja, todos os campos que vierem no JSON são
mandatórios.

A coluna “Nome no comprovante” da tabela abaixo deve ser colocada à frente do campo na
hora de imprimir o comprovante. Exemplo: “authorizationCode” deve aparecer no
comprovante como “AUT”.
O formato de todos os campos é String, e os campos getnetLogo e pixLogo são em formato

String Base64.
Abaixo você pode verificar os campos para:

• Comprovantes de crédito, débito e voucher;
• Comprovantes de Pix.
Comprovante | Crédito, Débito e Voucher
Tabela de resposta e seus respectivos campos do JSON:
Response
Nome no
Campo Descrição
comprovante
mandatory_all_receipts_fields.authorizationCo
AUT Código único de autorização
de
mandatory_all_receipts_fields.brand Bandeira do cartão utilizado
Os 4 últimos dígitos do
mandatory_all_receipts_fields.cardLastDigits
cartão
mandatory_all_receipts_fields.city Cidade do estabelecimento
CPF ou CNPJ do
mandatory_all_receipts_fields.ecDocument CPF ou CNPJ
estabelecimento
mandatory_all_receipts_fields.ecName Nome do estabelecimento
mandatory_all_receipts_fields.ecNumber EC Código do estabelecimento
Logo Getnet em formato

mandatory_all_receipts_fields.getnetLogo
String base64
mandatory_all_receipts_fields.dateTime Data e hora da transação
Letra que mostra o modo de

captura da transação:
C = Chip;
mandatory_all_receipts_fields.letterTypeTransa
D = Venda digitada;
ction
M = Tarja magnética;
S = Contactless;
Q = Qr Code.
Código de autorização da
transação na Getnet – ele é
mandatory_all_receipts_fields.nsu CV
único por transação/por
terminal.

Número lógico do terminal,
mandatory_all_receipts_fields.terminal TERM
cadastrado na Getnet
Versão do aplicativo
mandatory_all_receipts_fields.version
Pagamento
Corpo da transação. Neste

campo podem vir
informações como: valor,
mandatory_client_fields.client_body
tipo da transação,
informações relativas a
parcelamento, entre outras.
Texto para informar que esta

mandatory_client_fields.receiptTypeClient
é a Via do cliente
mandatory_ec_fields.aid AID Código AID da bandeira
mandatory_ec_fields.arqc ARQC Código ARQC da transação
Corpo da transação. Neste

campo podem vir
informações como: valor,
mandatory_ec_fields.ec_body
tipo da transação,
informações relativas a
parcelamento, entre outras.
mandatory_ec_fields.nsuLocal DOC NSU gerado no terminal
Texto para informar que esta

mandatory_ec_fields.receiptTypeEc
é a Via do estabelecimento
Exemplo JSON de resposta

automationSlip={
"mandatory_all_receipts_fields": {
"authorizationCode": "006734",
"brand": "MASTERCARD",
"cardLastDigits": "4283",
"city": "PORTO ALEGRE",
"ecDocument": "69.600.609/0001-06",
"ecName": "CREDENCIAMENTO ELO V",
"ecNumber": "000000051523906",
"getnetLogo": "", //Logo da Getnet em formato String Base64
"dateTime": "09/11/21 17:27:05",
"letterTypeTransaction": "C",
"nsu": "000000443",
"terminal": "10001593",
"version": "V0A57.0004.0021"
},
"mandatory_client_fields": {
"clientBody": "CREDITO A VISTA \nVALOR: 10,00",
"receiptTypeClient": "Via Cliente"
},
"mandatory_ec_fields": {

"aid": "A0000000041010",
"arqc": "3D084907A1C169DC",
"ecBody": "CREDITO A VISTA \nVALOR: 10,00\n \nTRANSACAO APROVADA
MEDIANTE\n USO DE SENHA PESSOAL",
"nsuLocal": "000204",
"receiptTypeEc": "Via Estabelecimento"
}
}
Comprovante | Pix
Tabela de resposta e seus respectivos campos do JSON:
Response
Nome no
Campo Descrição
comprovante
Logo Getnet em formato

mandatory_all_receipts_fields.getnetLogo
String base64
Logo Pix em formato

mandatory_all_receipts_fields.pixLogo
String base64
Cidade do
mandatory_all_receipts_fields.city
estabelecimento
mandatory_all_receipts_fields.amount VALOR Valor da transação
Código de autorização da
transação na Getnet – ele
mandatory_all_receipts_fields.nsu CV
é único por
transação/por terminal.
mandatory_all_receipts_fields.dateTime Data e hora da transação
Número lógico do
mandatory_all_receipts_fields.terminal TERM terminal, cadastrado na
Getnet.
Identificador da
mandatory_all_receipts_fields.transaction_id ID/TRANSAÇÃO
transação Pix
Texto para informar que

mandatory_all_receipts_fields.payer.title estes são os Dados do
Cliente
PSP do Cliente (Ex:

mandatory_all_receipts_fields.payer.pspName
Banco)
mandatory_all_receipts_fields.payer.name Nome do Cliente
Documento do Cliente
mandatory_all_receipts_fields.payer.document
(CPF ou CNPJ)

mandatory_all_receipts_fields.receiver.title estes são os Dados do
Estabelecimento
PSP do Estabelecimento
mandatory_all_receipts_fields.receiver.pspName
(Ex: Banco)
Nome do
mandatory_all_receipts_fields.receiver.name
Estabelecimento
Documento do
mandatory_all_receipts_fields.receiver.document Estabelecimento (CPF ou
CNPJ)
Texto extra informativo

que deve ser mostrado
mandatory_all_receipts_fields.slip_footer
no comprovante quando
enviado

mandatory_client_fields.receiptTypeClient
esta é a Via do cliente

mandatory_ec_fields.receiptTypeEc esta é a Via do
estabelecimento
Exemplo JSON de resposta

automationPixSlip={
"mandatory_all_receipts_fields": {
"getnetLogo": "", //Logo da Getnet em formato String Base64
"pixLogo": "", //Logo do Pix em formato String Base64
"city": "PORTO ALEGRE",
"amount": "R$ 126,20",
"nsu": "000000443",
"dateTime": "09/11/21 17:27:05",
"terminal": "10001593",
"transaction_id": "123412341234123",
"payer": {
"title": "Dados do Cliente",
"pspName": "PSP BANCO XYZ",
"name": "João Silva",
"document": "123*****-09"
},
"receiver": {
"title": "Dados do Estabelecimento",
"pspName": "PSP BANCO XYZ",
"name": "Restaurante X",
"document": "12.345.678/0001-90"
},
"slip_footer": "Informativo de Taxas..."
},
"mandatory_client_fields": {
"receiptTypeClient": "Via Cliente"

},
"mandatory_ec_fields": {
"receiptTypeEc": "Via Estabelecimento"
}
}
Exemplo de comprovante
Disponibilizamos para download arquivos de exemplo de como montar os comprovantes com

os dados recebidos. O arquivo Exemplo de Comprovante pode ser baixado no Portal do
Desenvolvedor (https://getstore.getnet.com.br/developer), na seção Documentação e SDKs.
No arquivo Exemplo de Comprovante você irá encontrar os seguintes exemplos:

• receipt_example.xml – Exemplo de estruturação de um comprovante em XML para
transações Crédito, Débito e Voucher;

• pix_receipt_example.xml – Exemplo de estruturação de um comprovante em XML
para transações Pix;

• SlipUtil.java – Exemplo de como mapear os campos do XML para colocar as
informações vindas do JSON para transações Crédito, Débito e Voucher;

• PixReceipt.kt – Exemplo de como mapear os campos do XML para colocar as
informações vindas do JSON para transações Pix;

• AutomationSlip.kt e PixSlip.kt – Data Class principal da estrutura;
o Data Class MandatoryAllReceiptsFields – Representa o JSON dos campos
mandatórios para ambas as vias do comprovante;
o Data Class MandatoryClientFields – Representa o JSON dos campos
mandatórios da via do cliente;
o Data Class MandatoryEcFields – Representa o JSON dos campos mandatórios
da via do estabelecimento;
Abaixo imagens do comprovante de Crédito, Débito ou Voucher montado com os arquivos do

Exemplo de Comprovante:

Visualização do XML no Android Studio Comprovante impresso no POS Digital
Abaixo imagens do comprovante Pix montado com os arquivos do Exemplo de Comprovante:
Visualização do XML no Android Studio Comprovante impresso no POS Digital

Atenção! Caso os comprovantes sejam reimpressos, é obrigatório imprimir a palavra
reimpressão da seguinte forma: ****REIMPRESSÃO****
Em letras maiúscula, em negrito, com tamanho de fonte maior que dos outros campos e com
asteriscos antes e depois do texto. Esta regra vale para as Vias do Cliente e do
Estabelecimento.
Exemplo de comprovante de reimpressão Exemplo de comprovante de reimpressão

API de Pagamento 4.3.2

Enviado por

Dados do documento

Descrição original:

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

API de Pagamento 4.3.2

Enviado por

Direitos autorais:

Formatos disponíveis

API de Pagamento

POS Digital | Getnet

CLASSIFICAÇÃO DO DOCUMENTO – CONFIDENCIAL

API de Pagamento - POS Digital - Getnet 1

HISTÓRICO DE ALTERAÇÕES ................................................................................................................................ 3

API de Pagamento - POS Digital - Getnet 2

Versão Data Descrição

3.0 12/05/2020 Ajustes na organização da documentação.

3.1 01/06/2020 Ajustes na organização da documentação.

Nova Funcionalidade: Modo Quiosque;

4.3.1 25/08/2021 Melhorias e correções.

4.3.2 29/07/2022 Melhorias e correções.

API de Pagamento - POS Digital - Getnet 3

Integração com a API de pagamento

public class MainActivity extends AppCompatActivity {

private void startIntent(Bundle bundle, String deeplink){

API de Pagamento - POS Digital - Getnet 4

getnet://pagamento/v1/payment Pagamento v1 (Deprecated)

<meta-data android:name="priority_pay" android:value="1" />

Quando houver o meta-data “priority_pay” com o valor igual a 1 (um), automaticamente, os

API de Pagamento - POS Digital - Getnet 5

API de Pagamento - POS Digital - Getnet 6

<meta-data android:name="kiosk_mode" android:value="1" />

API de Pagamento - POS Digital - Getnet 7

<meta-data android:name="allow_print_permission" android:value="1" />

Na resposta do deeplink retornará o parâmetro printMerchantPreference. Neste parâmetro

API de Pagamento - POS Digital - Getnet 8

Como utilizar o Pix

API de Pagamento - POS Digital - Getnet 9

Algumas informações mais detalhadas estão nas seções Pagamento v3 e Consulta

API de Pagamento - POS Digital - Getnet 10

Tabela de Resultados das Funcionalidades:

Código O que representa

0 SUCESSO Mensagem referente a operação efetuada com sucesso

1 NEGADA Mensagem referente a transação negada pelo servidor (bandeira, device,

2 CANCELADA Mensagem referente a transação cancelada (pelo servidor ou usuário)

3 FALHA Mensagem referente a falha ao completar uma transação (internet,

4 DESCONHECIDO Erro desconhecido

5 PENDENTE Transação Pix ainda pendente de resposta. É recomendado realizar uma

API de Pagamento - POS Digital - Getnet 11

API de Pagamento - POS Digital - Getnet 12

public class MainActivity extends AppCompatActivity {

API de Pagamento - POS Digital - Getnet 13

API de Pagamento - POS Digital - Getnet 14

Atenção! Esta versão do deeplink de pagamento está sendo descontinuada e em breve

O deeplink getnet://pagamento/v1/payment irá iniciar a aplicação de pagamento da Getnet

Abaixo seguem as tabelas de requisição e resposta e seus respectivos parâmetros:

Obrigatoriedade Parâmetro Formato Descrição

Este parâmetro informa qual o tipo de

Se informado “credit” no parâmetro

Este parâmetro informa o número de parcelas.

OPCIONAL installments String Se informado o parâmetro “creditType” com o

12 dígitos representando o valor, considerando

Se não for informado, o usuário precisará

API de Pagamento - POS Digital - Getnet 15

Este parâmetro define como tem que ser

Mais detalhes na seção Telas Adicionais.

Este parâmetro serve para o adicionar campos

Bloqueia a funcionalidade de digitar o número

Desabilita a leitora de cartões com tarja.

Para desabilitar: “true”

Desabilita o espaçamento final para o corte da

OPCIONAL disableCustomerSlipSpace Boolean Para desabilitar: “false”