Providers (Classes)

A biblioteca PlugPagService é composta de um conjunto de classes. A classe principal chama-se PlugPag, mas é necessário utilizar classes auxiliares para configurações e trocas de informações. Segue abaixo uma lista com classes que compõem a biblioteca:

Classe	Descrição
PlugPag	Classe principal da biblioteca.
	Essa classe é responsável pelas transações.
PlugPagAbortResult	Resultado obtido ao solicitar um cancelamento de operação, enquanto a operação está em andamento.
PlugPagActivationData	Dados de ativação do terminal.
PlugPagAppIdentification	Identificação do aplicativo.
PlugPagBeepData	Configuração de beep.
PlugPagCustomPrinterLayout	Classe para customização da dialog de impressão da via do cliente.
PlugPagEventData	Dados de eventos gerados durante transações para atualização de eventos no aplicativo.
PlugPagException	Tipo principal de exceções geradas pelo PlugPag.
PlugPagInitializationResult	Resultado da inicialização do terminal
PlugPagLedData	Configuração de LED.
PlugPagNearFieldCardData	Dados para leitura/escrita de NFC.
PlugPagNFCAuth	Dados de autenticação do NFC.
PlugPagNFCInfosResult	Resultado de uma requisição para obter informações de NFC.
PlugPagNFCResult	Resultado de uma leitura/escrita NFC.
PlugPagPaymentData	Informações de um pagamento a ser realizado.
PlugPagPrinterData	Informações de uma impressão a ser realizada.
PlugPagPrintResult	Resultado de uma requisição de impressão.
PlugPagSimpleNFCData	Dados para escrita em um cartão NFC.
PlugPagTransactionResult	Resultado de uma transação.
PlugPagVoidData	Informações de um estorno a ser realizado.
PreferedNetwork	Enum com configurações de conexão (dados móveis).
TerminalCapabilities	Constantes de funcionalidades do terminal.
PlugPagTransactionResult	Resultado de transações de venda e estorno com sucesso.
PlugPagPreAutoData	Dados para criar uma pré-autorização
PlugPagEffectuatePreAutoData	Dados para efetivar uma pré-autorização criada
PlugPagCmdExchangeResult	Dados do retorno do comando APDU (retorna o comando de resposta)

Interfaces

As interfaces visam facilitar e padronizar algumas chamadas de métodos de forma assíncrona.

Interface	Descrição
PlugPagAbortListener	Interface com métodos que são chamados durante uma transação assíncrona de abort.
PlugPagActivationListener	Interface com métodos que são chamados durante uma ativação e/ou durante uma desativação assíncrona.
PlugPagInstallmentsListener	Interface com métodos que são chamados ao realizar o cálculo de parcelas de forma assíncrona.
PlugPagIsActivatedListener	Interface com métodos que são chamados durante uma verificação se está ou não ativado assíncrona.
PlugPagLastTransactionListener	Interface com métodos que são chamados ao tentar obter de forma assíncrona a última transação aprovada.
PlugPagNFCListener	Interface com métodos que são chamados durante uma leitura ou uma escrita assíncrona em um cartão NFC.
PlugPagPaymentListener	Interface com métodos que são chamados durante uma transação assíncrona de pagamento.
PlugPagEventListener	Interface com método chamado quando um evento é enviado durante uma transação.
PlugPagPrinterListener	Interface com métodos chamados quando um evento é enviado durante uma impressão.

API

Abaixo segue a descrição da interface pública da biblioteca PlugPagService:

PlugPag

Essa é a classe principal da biblioteca. É por meio dessa classe que é possível realizar transações na Moderninha Smart.

Constantes

Tipo	Retorno
int	RET_OK
	Código utilizado para indicar sucesso nas operações.
	Valor: 0
int	REQUEST_CODE_AUTHENTICATION
	Código utilizado para iniciar a Activity de autenticação.
	Valor: 46981
int	TYPE_CREDITO
	Tipo de pagamento: crédito.
	Valor: 1
int	TYPE_DEBITO
	Tipo de pagamento: débito
	Valor: 2
int	TYPE_VOUCHER
	Tipo de pagamento: voucher (vale refeição)
	Valor: 3
int	TYPE_QRCODE
	Tipo de pagamento: qrcode elo.
	Valor: 4
int	TYPE_PIX
	Tipo de pagamento: qrcode pix.
	Valor: 5
int	TYPE_QRCODE_CREDITO
	Tipo de pagamento: qrcode crédito
	Valor: 7
int	INSTALLMENT_TYPE_A_VISTA
	Forma de parcelamento: à vista
	Valor: 1
int	INSTALLMENT_TYPE_PARC_VENDEDOR
	Forma de parcelamento: parcelamento vendedor
	Valor: 2
int	INSTALLMENT_TYPE_PARC_COMPRADOR
	Forma de parcelamento: parcelamento comprador
	Valor: 3
int	ERROR_REQUIREMENTS_MISSING_PERMISSIONS
	Código de retorno para indicar erro de falta de permissões do aplicativo.
	Valor: -3000
int	ERROR_REQUIREMENTS_ROOT_PERMISSION
	Código de retorno para indicar que o aparelho possui permissões de root.
	Valor: -3001

Construtores

PlugPag (Context context, PlugPagAppIdentification appIdentification)
Cria uma instância do PlugPag utilizando context para acessar dados e recursos do dispositivo e identificando as transações com os dados do aplicativo fornecidos em appIdentification.
Gera uma exceção se context ou appIdentification forem nulos.

Métodos

Tipo de retorno	Método e Descrição
PlugPagAbortResult abort()	Solicita o cancelamento da operação atual.
	O cancelamento da transação não ocorre instantaneamente, pois depende do fluxo da transação.
	Retorna o resultado da solicitação de cancelamento.
PlugPagNFCResult abortNFC()	Aborta uma operação de leitura/escrita NFC.
Int	authNFCCardDirectly(authData: PlugPagNFCAuth)
	Realiza a autenticação do sistema NFC usado. Retorna sucesso com código 1 e falha com código -1.
void	asyncAbort(listener: PlugPagAbortListener)
	Solicita o cancelamento da operação atual de forma assíncrona.
void	asyncAbortNFC(listener: PlugPagAbortListener)
	Aborta uma operação de leitura/escrita NFC de forma assíncrona.
void	asyncCalculateInstallments(saleValue: String,listener:PlugPagInstallmentsListener)
	Calcula o valor das parcelas de forma assíncrona.
void	asyncDeactivate(activationData:PlugPagActivationData,listener:PlugPagActivationListener)
	Realiza a desativação do terminal de forma assíncrona.
void	asyncGetLastApprovedTransaction(listener:PlugPagLastTransactionListener)
	Obtém a última transação aprovada de forma assíncrona.
void	asyncIsAuthenticated(isActivatedListener:PlugPagIsActivatedListener)
	Verifica se há um usuário autenticado de forma assíncrona.
void	asyncReadNFC(cardData: PlugPagNearFieldCardData,listener: PlugPagNFCListener)
	Realiza leitura do conteúdo de um cartão NFC de forma assíncrona.
void	asyncReprintCustomerReceipt(listener:PlugPagPrinterListener)
	Realiza a reimpressão da via do cliente de forma assíncrona.
void	asyncReprintEstablishmentReceipt(listener:PlugPagPrinterListener)
	Realiza a reimpressão da via do estabelecimento de forma assíncrona.
void	asyncWriteNFC(cardData: PlugPagNearFieldCardData,listener: PlugPagNFCListener)
	Realiza escrita em um cartão NFC de forma assíncrona.
int	beep(beepData: PlugPagBeepData)
	Toca um beep
	Retorna sucesso com código 1 e falha com código -1.
String[]	calculateInstallments(saleValue: String)
	Calcula o valor das parcelas. Retorna os valores das parcelas.
PlugPagTransactionResult doPayment(PlugPagPaymentData paymentData)	Efetua um pagamento. Retorna o resultado da transação.
PlugPagInitializationResult deactivate(activationData: PlugPagActivationData)	Realiza a desativação do terminal. Retorna o resultado de uma desativação.
void	disposeSubscriber()
	Realiza o dispose do subscriber atual.
void	doAsyncInitializeAndActivatePinpad(activationData:PlugPagActivationData, listener: PlugPagActivationListener)
	Realiza a inicialização e a ativação do terminal para uso através do código de ativação de forma assíncrona.
void	doAsyncVoidPayment(voidData: PlugPagVoidData, listener:PlugPagPaymentListener)
	Efetua um estorno de forma assíncrona de um pagamento identificado pelos dados contidos em voidData.
PlugPagAppIdentification getAppIdentification()	Retorna a identificação do aparelho definido no construtor da classe.
String	getApplicationCode()
	Retorna o código da aplicação.Esse código é uma constante da biblioteca.
PlugPagTransactionResult getLastApprovedTransaction()	Obtém a última transação aprovada.
String	getLibVersion()
PlugPagNFCInfosResult getNFCInfos(cardType: Int)	Obtém as informações de um cartão NFC. Retorna o as informações de cartão NFC
Boolean	hasCapability(capability: Int)
	Verifica se o terminal tem uma funcionalidade especifica. Retorna true se houver a funcionalidade, false caso contrário.
int	initBTConnection(PlugPagDevice deviceInformation)
	Configura a conexão bluetooth utilizando os dados de deviceInformation.
	Retorna PlugPag.RET_OK em caso de sucesso.
PlugPagInitializationResult initializeAndActivatePinpad(activationData:PlugPagActivationData)	Realiza a inicialização e a ativação do terminal para uso através do código de ativação.
	Retorna o resultado da inicialização.
void	invalidateAuthentication()
	Invalida uma autenticação. Equivalente a realizar um logout
boolean	isAuthenticated()
	Verifica se há um usuário autenticado. Retorna true se houver um usuário autenticado, false caso contrário.
PlugPagPrintResult printFromFile(printerData: PlugPagPrinterData)	Solicita a impressão de um arquivo.
PlugPagPrintResult reprintCustomerReceipt()	Solicita a reimpressão da via do cliente.
PlugPagPrintResult reprintStablishmentReceipt()	Solicita a reimpressão da via do estabelecimento.
void	requestAuthentication(PlugPagAuthenticationListener listener)
	Solicita autenticação. O resultado da autenticação é notificado ao listener que é passado no parâmetro listener.
void	setEventListener(PlugPagEventListener listener)
	Armazena a referência de uma instância de interface que receberá os eventos gerados durante as transações.
Int	setLed(ledData: PlugPagLedData)
	Define os LEDs que serão acesos. Retorna sucesso com código 1 e falha com código -1.
void	setPlugPagCustomPrinterLayout(PlugPagCustomPrinterLayout).
	Permite customizar elementos da dialog de impressão da via do cliente.
Boolean	setPreferredNetwork(preferedNetwork: Int)
	Configura a tipo de rede Preferido com 1 (4G/3G/2G), 2 (3G/2G), 3 (2G). Retorna sucesso com true e falha com false.
void	setPrinterListener(listener: PlugPagPrinterListener)
	Armazena a referência de uma instância de interface que receberá os eventos gerados durante uma impressão.
int	setVersionName(String appName, String appVersion)
	Define o nome e a versão do aplicativo que está integrando com o PlugPagService.
	appName pode ter no máximo 25 caracteres.
	appVersion pode ter no máximo 10 caracteres.
	Retorna um código de erro se um dos parâmetros for nulo ou vazio.
Int	startNFCCardDirectly()
	Inicia a antena NFC para uso. Retorna sucesso com código 1 e falha com código -1.
Int	stopNFCCardDirectly()
	Finaliza o sistema de NFC em uso. Retorna sucesso com código 1 e falha com código -1.
PlugPagNFCResult readFromNFCCard(PlugpagNearFieldCardData cardData)	Realiza leitura do conteúdo de um cartão NFC. Retorna sucesso com código 1 e falha com código -1.
Int	readNFCCardDirectly(cardData: PlugPagSimpleNFCData)
	Realiza leitura do conteúdo de um cartão NFC diretamente.
	Retorna sucesso com código 1 e falha com código -1.
PlugPagTransactionResult voidPayment(PlugPagVoidData voidData)	Efetua um estorno de um pagamento identificado pelos dados contidos em voidData.
	Retorna o resultado da transação.
PlugPagNFCResult writeToNFCCard(PlugpagNearFieldCardData cardData)	Realiza escrita em um cartão NFC. Retorna sucesso com código 1 e falha com código -1.
Int	writeToNFCCardDirectly(cardData: PlugPagSimpleNFCData)
	Realiza escrita em um cartão NFC diretamente. Retorna sucesso com código 1 e falha com código -1.
Boolean	setMockState(mock: Boolean)
	True - Ativa o fluxo de mock.
	False - Desativa o fluxo de mock.
	Retorna true se mock foi atualizado com sucesso.
PlugPagTransactionResult getPreAutoData()	Realiza a busca de uma pré-autorização através do cartão do usuário
	Retorna o resultado da criação da pré-autorização
PlugPagTransactionResult doPreAutoCancel(transactionId : String, transactionCode : String)	Realiza ao cancelamento de uma pré-autorização criada. Retorna o resultado do cancelamento da pré-autorização
PlugPagTransactionResult doEffectuatePreAuto(paymentData: PlugPagEffectuatePreAutoData)	Realiza a efetivação e uma pré-autorização
	Retorna o resultado da efetivação da pré-autorização
PlugPagTransactionResult doPreAutoCreate(plugPagPreAutoData: PlugPagPreAutoData)	Realiza a criação de uma pré-autorização
	Retorna o resultado da criação de uma pré-autorização
PlugPagNFCInfosResultDirectly	detectNfcCardDirectly(cardType: Int, timeout: Int)
	Retorna o resultado da detecção do cartão NFC
Int	detectNfcRemoveDirectly(detectRemove:PlugPàgNFCDetectRemoveCard)
	Realiza a detecção da remoção do cartão NFC diretamente com o hardware sem nenhum tipo de gerenciamento extra.
	Retorna o resultado da remoção do cartão
Int	justAuthNfcDirectly(plugPagNFCAuthDirectly:PlugPagNFCAuthDirectly)
	Realiza a autenticação do cartão NFC diretamente com o hardware sem nenhum tipo de gerenciamento extra
	Retorna o resultado da autenticação do cartão
PlugPagCmdExchangeResult apduCommand(command: ByteArray, dataLength: Int)	Realiza a chamada APDU com os parametros de commando a ser enviado
	Retornar as informações do comando apdu enviado

PlugPagAbortResult

Essa classe contém dados resultantes de uma solicitação de cancelamento de operação.

Construtores

PlugPagAbortResult (int result)
Cria um container de dados resultantes de um cancelamento de operação com o código result.

Método

Tipo	Método e Descrição
int	getResult()
	Retorna o código de resultado da solicitação de cancelamento de operação.

PlugPagAppIdentification

Essa classe representa a identificação de um aplicativo.

Construtores

PlugPagAppIdentification (String name, String version)
Cria uma identificação do aplicativo, definindo seu nome e sua versão com os valores de name e version, respectivamente.
Gera uma exceção se name ou version forem nulos ou vazios.
Os tamanhos limite para name e version são, respectivamente, 25 e 10 caracteres.

Método

Tipo	Método e Descrição
String	getName()
	Retorna o nome do aplicativo.
String	getVersion()
	Retorna a versão do aplicativo.

PlugPagEventData

Essa classe representa um evento gerado pela biblioteca PlugPag para o aplicativo de integração.

Constantes

Tipo	Retorno
int	EVENT_CODE_CUSTOM_MESSAGE
	Código de evento indicando mensagem customizada pela PlugPag.
	Valor: -2
int	EVENT_CODE_DEFAULT
	Código padrão de evento. Utilizado quando nenhum evento foi enviado.
	Valor: -1
int	EVENT_CODE_WAITING_CARD
	Código de evento indicando que o leitor está aguardando o usuário inserir o cartão.
	Valor: 0
int	EVENT_CODE_INSERTED_CARD
	Código de evento indicando que o cartão foi inserido.
	Valor: 1
int	EVENT_CODE_PIN_REQUESTED
	Código de evento indicando que o leitor está aguardando o usuário digitar a senha.
	Valor: 2
int	EVENT_CODE_PIN_OK
	Código de evento indicando que a senha digitada foi validada com sucesso.
	Valor: 3
int	EVENT_CODE_SALE_END
	Código de evento indicando o fim da transação.
	Valor: 4
int	EVENT_CODE_AUTHORIZING
	Código de evento indicando que o terminal está aguardando autorização da senha digitada para prosseguir com a transação.
	Valor: 5
int	EVENT_CODE_INSERTED_KEY
	Código de evento indicando que a senha foi digitada.
	Valor: 6
int	EVENT_CODE_WAITING_REMOVE_CARD
	Código de evento indicando que o terminal está aguardando o usuário remover o cartão.
	Valor: 7
int	EVENT_CODE_REMOVED_CARD
	Código de evento indicando que o cartão foi removido do terminal.
	Valor: 8
int	EVENT_CODE_CVV_REQUESTED
	Código de evento indicando que foi solicitado o CVV..
	Valor: 9
int	EVENT_CODE_CVV_OK
	Código de evento indicando que o CVV foi inserido corretamente.
	Valor: 10
int	EVENT_CODE_CAR_BIN_REQUESTED
	Código de evento indicando que foi solicitado o BIN.
	Valor: 11
int	EVENT_CODE_CAR_BIN_OK
	Código de evento indicando que o BIN foi inserido corretamente.
	Valor: 12
int	EVENT_CODE_CAR_HOLDER_REQUESTED
	Código de evento indicando que foi solicitado o CVV.
	Valor: 13
int	EVENT_CODE_CAR_HOLDER_OK
	Código de evento indicando que o HOLDER foi inserido corretamente.
	Valor: 14
int	EVENT_CODE_ACTIVATION_SUCCESS
	Código de evento indicando que a ativação foi feita corretamente.
	Valor: 15
int	EVENT_CODE_DIGIT_PASSWORD
	Código de evento indicando que a um número da senha foi digitado.
	Valor: 16
int	EVENT_CODE_NO_PASSWORD
	Código de evento indicando que a senha foi apagada.
	Valor: 17
int	EVENT_CODE_SALE_APPROVED
	Código de evento indicando a venda foi aprovada.
	Valor: 18
int	EVENT_CODE_SALE_NOT_APPROVED
	Código de evento indicando que a venda não foi aprovada.
	Valor: 19

Construtores

PlugPagEventData (int eventCode)
Cria um identificador de evento gerado pela biblioteca para o aplicativo de integração, com o código eventCode.

Método

Tipo	Método e Descrição
int	getEventCode()
	Retorna o código do evento gerado.

PlugPagPaymentData

Essa classe representa os dados de um pagamento. É nessa classe que são definidas informações de tipo de pagamento, valor a ser pago e parcelas, além e outras informações gerenciais.

Construtores

PlugPagPaymentData (int paymentType, int amount, int installmentType, int installments, String userReference)
Cria um conjunto de informações necessários para iniciar um pagamento. O pagamento configurado será do tipo paymentType, com o valor amount, com parcelamento do tipo installmentType, com installments número de parcelas, identificado por userReference.
O parâmetro amount definido é o valor em centavos a ser pago. Para um pagamento de R$ 1,50, o amount deverá ser de 150.
O valor de userReference deve conter apenas letras (não acentuadas) e números. Esse campo é limitado a 10 caracteres.
Gera uma exceção se o userReference for nulo ou vazio.
PlugPagPaymentData (int paymentType, int amount, int installmentType, int installments, String userReference, Boolean printReceipt)
Cria um conjunto de informações necessários para iniciar um pagamento. O pagamento
configurado será do tipo paymentType, com o valor amount, com parcelamento do tipo installmentType, com installments número de parcelas, identificado por userReference.

O parâmetro amount definido é o valor em centavos a ser pago. Para um pagamento de R$1,50, o amount deverá ser de 150.

O valor de userReference deve conter apenas letras (não acentuadas) e números. Esse campo é limitado a 10 caracteres.

O parâmetro partialPay indicará se no pagamento poderá ocorrer um pagamento do tipo parcial¹, seu padrão é desligado.

Gera uma exceção caso:

O userReference for nulo ou vazio;
O pagamento por carnê for diferente do tipo Débito ou Crédito;
A quantidade de parcelas for menor ou igual a 0;
O valor da venda for inferior a R$1,00.

¹ Pagamento parcial: Quando o limite de crédito do pagador é atingido, ao invés do
bloqueio da venda (por falta de saldo), é feita uma venda com todo o limite disponível,
deixando o restante da transação pendente.

Método

Tipo	Método e Descrição
int	getAmount()
	Retorna o valor a ser pago, em centavos.
int	getInstallments()
	Retorna o número de parcelas do pagamento.
int	getInstallmentType()
	Retorna o tipo de parcelamento.
	Valores: PlugPag.INSTALLMENT_TYPE_A_VISTA ou PlugPag.INSTALLMENT_TYPE_PARC_VENDEDOR
int	getType()
	Retorna o tipo de pagamento.
	Valores: PlugPag.TYPE_CREDITO, PlugPag.TYPE_DEBITO ou PlugPag.TYPE_VOUCHER.
String	getUserReference()
	Retorna o código de venda.
boolean	getPartialPayEnabled()
	Retorna o valor true caso o pagamento aceite autorização parcial.
boolean	getPaymentCarne()
	Retorna o valor true caso o pagamento for carnê.

PlugPagPaymentData.Builder

Construtor de objetos PlugPagPaymentData.

Construtores

Builder ()
Cria um construtor de objetos PlugPagPaymentData.

Métodos

Tipo	Método e Descrição
PlugPagPaymentData	build()
	Cria um PlugPagPaymentData com os dados armazenados no Builder.
Builder	setAmount(int amount)
	Define o valor a ser pago.
	Retorna a referência do próprio Builder para chamadas encadeadas.
	O valor de amount deve ser fornecido em centavos. Por exemplo, se o valor desejado é de R$1,50, deve-se passar o valor 150.
	Gera uma exceção se amount não for maior do que zero.
Builder	setInstallments(int installments)
	Retorna a quantidade de parcelas do pagamento.
	Retorna a referência do próprio Builder para chamadas encadeadas.
	Se installments for igual a 1, o tipo de parcelamento é automaticamente definido para PlugPag.INSTALLMENT_TYPE_A_VISTA.
	Gera uma exceção se installments não for maior do que zero.
Builder	setInstallmentType(int installmentType)
	Define o tipo de parcelamento.
	Valores válidos para installmentType são PlugPag.INSTALLMENT_TYPE_A_VISTA e PlugPag.INSTALLMENT_TYPE_PARC_VENDEDOR.
	Retorna a referência do próprio Builder para chamadas encadeadas.
	Gera uma exceção se installmentType for inválido.
Builder	setType(int type)
	Define o tipo de pagamento.
	Valores válidos para type são PlugPag.TYPE_CREDITO, PlugPag.TYPE_DEBITO e PlugPag.TYPE_VOUCHER.
	Retorna a referência do próprio Builder para chamadas encadeadas.
	Gera uma exceção se type for inválido.
Builder	setUserReference(String userReference)
	Define o código de venda.
	Retorna a referência do próprio Builder para chamadas encadeadas.
	O valor de userReference deve conter apenas letras (não acentuadas) e números. Esse campo é limitado a 10 caracteres.
	Gera uma exceção se userReference for nulo ou vazio.
Builder	setPaymentCarne(boolean paymentCarne)
	Define se o pagamento poderá ser do tipo Carnê. Caso não sejam atribuídos valores, seu padrão é desligado (false).
Builder	setPartialPayEnabled(boolean partialPayEnabled)
	Define se no pagamento, poderá ocorrer um pagamento parcial¹.
	Caso não sejam atribuídos valores, seu padrão é desligado (false).
	¹ Pagamento parcial: Quando o limite de crédito do pagador é atingido, ao invés do bloqueio da venda (por falta de saldo), é feita uma venda com todo o limite disponível, deixando o restante da transação pendente.

PlugPagTransactionResult

Essa classe representa o resultado de uma transação.

Construtores

PlugPagTransactionResult(String message, String errorCode, String transactionCode, String transactionId, String date, String time, String hostNsu, String cardBrand, String bin, String holder, String userReference, String terminalSerialNumber, String amount, String availableBalance, String cardApplication, String label, String holderName, String extendedHolderName, Int result, String readerModel, String nsu, String autoCode, Char installments, Int originalAmount, String buyerName, Int paymentType, String typeTransaction, String appIdentification, String cardHash, String mPreAutoDueDate, String mPreAutoOriginalAmount)
Cria um objeto para armazenar um conjunto de informações resultantes de uma transação.
PlugPagTransactionResult(String message, String errorCode ,String transactionCode, String transactionId, String date, String time, String hostNsu, String cardBrand, String bin, String holder, String userReference, String terminalSerialNumber, String amount, String availableBalance, String cardApplication, String label, String holderName, String extendedHolderName, String readerModel, String nsu, String autoCode, Char installments, Int originalAmount, String buyerName, Int paymentType, String typeTransaction, String appIdentification, String cardHash, String mPreAutoDueDate, String mPreAutoOriginalAmount)
Cria um objeto para armazenar um conjunto de informações resultantes de uma transação, adicionando o código de resultado result.

Métodos

Tipo	Método e Descrição
String	getAmount()
	Retorna o valor transacionado.
String	getAvailableBalance()
	Retorna o saldo da conta, caso o método de pagamento seja PlugPag.TYPE_VOUCHER.
String	getBin()
	Retorna os 6 (quatro) últimos dígitos do cartão utilizado.
String	getCardApplication()
	Retorna a aplicação do cartão.
String	getCardBrand()
	Retorna a bandeira do cartão utilizado.
String	getBuyerName()
	Retorna o nome do proprietário da carteira PIX.
String	getCardCryptogram()
	Retorna o criptograma do cartão.
String	getDate()
	Retorna a data da transação.
String	getErrorCode()
	Se um erro ocorreu durante a transação, retorna o código de erro.
String	getExtendedHolderName()
	Retorna o nome completo do titular do cartão utilizado.
String	getHolder()
	Retorna os 4 últimos dígitos do cartão utilizado.
String	getHolderName()
	Retorna o nome do titular do cartão utilizado.
String	getHostNsu()
	Retorna um identificador único do host (servidor).
String	getLabel()
	Retorna o label do cartão utilizado.
String	getMessage()
	Retorna uma mensagem do resultado da transação, definida pela biblioteca.
int	getResult()
	Retorna o código do resultado.
String	getTerminalSerialNumber()
	Retorna o número de série do terminal ou leitor utilizado para efetuar o pagamento.
String	getTime()
	Retorna o horário da transação.
String	getTransactionCode()
	Retorna o código da transação.
String	getTransactionId()
	Retorna o ID da transação.
String	getUserReference()
	Retorna o código de venda o pagamento efetuado.
String	getOriginalAmount()
	Retorna o código de venda o pagamento efetuado.
String	getInstallments()
	Retorna a quantidade de parcelas da transação.
String	getReaderModel()
	Retorna o modelo do equipamento.
String	getTypeTransaction()
	Retorna o tipo da transação.
String	getPaymentType()
	Retorna qual o tipo de pagamento a transação se relaciona.
String	getAppIdentification()
	Retorna qual o valor preenchido no parametro appNamenote.
String	getAutoCode()
	Retorna o codigo de autorização.
String	getPreAutoDueDate()
	Retorna a data da transação.
String	getPreAutoOriginalAmont()
	Retorna o valor da transação.

PlugPagTransactionResult.Builder

Construtor de objetos PlugPagTransactionResult.

Construtores

Builder ()
Cria um construtor de objetos PlugPagTransactionResult.

Métodos

Tipo	Método e Descrição
PlugPagTransactionResult	build()
	Constrói uma instância da classe PlugPagTransactionResult utilizando os dados armazenados.
Builder	setAmount(String amount)
	Define o valor da transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setAvailableBalance(String availableBalance)
	Define o saldo disponível.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setBin(String bin)
	Define o BIN do cartão utilizado na transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setCardApplication(String cardApplication)
	Define a aplicação do cartão utilizado na transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setCardBrand(String cardBrand)
	Define a bandeira do cartão utilizado na transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setCardCryptogram(String cardCryptogram)
	Define o criptograma do cartão utilizado na transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setDate(String date)
	Define a data da transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setExtendedHolderName(String extendedHolderName)
	Define o nome completo do titular do cartão utilizado na transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setHolder(String holder)
	Define o nome do titular do cartão.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setHolderName(String holderName)
	Define o nome do titular do cartão.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setHostNsu(String hostNsu)
	Define o NSU do host que executou a transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setLabe(String label)
	Define o label do cartão utilizado.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setMessage(String message)
	Define a mensagem do resultado da transação que será construído.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setTerminalSerialNumber(String terminalSerialNumber)
	Define o número de série do terminal ou leitor utilizado na transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setTime(String time)
	Define o horário da transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setTransactionCode(String transactionCode)
	Define o código da transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setTransactionId(String transactionId)
	Define o ID da transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
Builder	setUserReference(String userReference)
	Define o código de venda da transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.

PlugPagVoidData

Essa classe representa os dados de um estorno.

É nessa classe que são definidos dados necessários para solicitar o estorno de um pagamento.

Construtores

PlugPagVoidData (String transactionCode, String transactionId, Boolean printReceipt, Int VoidType)
Cria um conjunto de informações para solicitar o estorno de um pagamento identificado pelo transactionCode e transactionId fornecidos.
O parâmetro printReceipt é opcional e indicará se deverá ser impresso os comprovantes da transação.
O parâmetro voidType é opcional e indicará qual o tipo de estorno ira ser realizado.
Gera uma exceção se transactionCode for nulo ou vazio.
PlugPagVoidData (String transactionCode, String transactionId, Int VoidType)
Cria um conjunto de informações para solicitar o estorno de um pagamento identificado pelo transactionCode e transactionId fornecidos.
O parâmetro voidType é opcional e indicará qual o tipo de estorno ira ser realizado.
Gera uma exceção se transactionCode for nulo ou vazio.
PlugPagVoidData (String transactionCode, String transactionId) Cria um conjunto de informações para solicitar o estorno de um pagamento identificado pelo transactionCode e transactionId fornecidos. Gera uma exceção se transactionCode for nulo ou vazio.

Métodos

Tipo	Método e Descrição
String	getTransactionCode()
	Retorna o código da transação que será estornada.
String	getTransactionId()
	Retorna o ID da transação que será estornada.
Int	getPrintReceipt()
	Retorna se será impresso comprovante na transação.
Int	getVoidType()
	Retorna o tipo de estorno que será realizado.

PlugPagVoidData.Builder

Construtor de objetos PlugPagVoidData.

Construtores

Builder ()
Cria um construtor de objetos PlugPagVoidData.

Método

Tipo	Método e Descrição
PlugPagVoidData	build()
	Constrói uma instância da classe PlugPagVoidData utilizando os dados armazenados.
Builder	setTransactionCode(String transactionCode)
	Define o código da transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.
	Gera uma exceção se transactionCode for nulo ou vazio.
Builder	setTransactionId(String transactionid)
	Define o ID da transação.
	Retorna a referência do próprio Builder para chamadas encadeadas.

PlugPagCustomPrinterLayout

Essa classe representa os elementos a serem customizados da dialog de impressão da via do cliente.

Construtor

PlugPagCustomPrinterLayout ()
Cria um construtor de objetos PlugPagCustomPrinterLayout.

Método

Tipo	Método e Descrição
void	setButtonBanckgroundColor(String hexaCodeColor)
	Modifica a cor de fundo dos botões da dialog.
void	setButtonBackgroundColorDisabled(String hexaCodeColor)
	Modifica a cor de fundo dos botões da dialog quando desativados.
void	setCancelTextColor(String hexaCodeColor)
	Altera a cor do texto do botão de cancelar da dialog.
void	setSendSMSTextColor(String hexaCodeColor)
	Altera a cor do texto do botão de enviar sms da dialog.
void	setConfirmTextColor(String hexaCodeColor)
	Altera a cor do texto do botão de confirmar da dialog.
void	setTitle(String titleText)
	Seta o texto a ser mostrado na dialog.
void	setTitleColor(String hexaCodeColor)
	Altera a cor do texto mostrado na dialog.
void	setWindowBackgroundColor(String hexaCodeColor)
	Modifica a cor de fundo da dialog.
void	setMaxTimeShowPopup(Integer time)
	Altera o tempo de exibição do popup.
	Se existir valor para esse atributo o popup fecha automaticamente de acordo com o tempo estabelecido em segundos.

📘
Todos os itens são opcionais. Caso não sejam setados, obeterão seus valores defaults.

PlugPagNFCResult

Essa classe representa o retorno de uma leitura ou escrita a um cartão NFC.

Construtor

PlugPagNFCResult (int startSlot, int endSlot, HashMap<String, Byte[]>[] slots, int result)

Métodos

Tipo	Método e Descrição
int	getStartSlot()
	Retorna o primeiro slot a ser escrito/lido
int	getEndSlot()
	Retorna o último slot a ser escrito/lido.
HashMap<String, Byte[]>[]	getSlots()
	Retorna as informações as serem escritas/lidas de cada slot.
	No total, são 64 slots onde, cada slot, possui um HashMap contendo duas informações: data e pwd. Pwd retorna a senha de deste slot e data retorna o valor que foi lido/escrito naquele slot.

int	getResult()
	Retorna 1 para sucesso e –1 para falha.

PlugPagPrintResult

Essa classe representa o retorno de uma requisição de impressão pelo PlugPagService.

Construtor

PlugPagPrintResult (int result, String message, String errorCode)

Métodos

Tipo	Método e Descrição
int	getResult()
	Retorna PlugPag.RET_OK quando sucesso.
int	getMessage()
	Retorna a mensagem de erro da operação.
HashMap<String, Byte[]>[]	getErrorCode()
	Retorna o código de erro da operação.

PlugPagPrinterData

Essa classe representa os dados de uma impressão a ser realizada.

A impressão é feita a partir de um arquivo de imagem( jpeg, bmp ou png). O arquivo deve ser uma imagem com 1155px de largura, mas caso seja enviada uma imagem com um tamanho maior, ela será redimensionada para se adequar à largura da bobina. O arquivo fornecido e todo o caminho até ele deve estar acessível para o PlugPagService

Construtor

PlugPagPrinterData (String filePath, Int printerQuality, Int step)

Métodos

Tipo	Método e Descrição
String filePath	getFilePath()
	Retorna o caminho de arquivo a ser impresso.
int printerQuality	getPrinterQuality()
	Retorna a qualidade da impressão. Os valores podem variar de 1 a 4, onde 4 indica a maior qualidade da impressão.
int step	getStep()
	Retorna o espaçamento a ser feito após a impressão terminar.