These docs are for v1.0. Click to read the latest docs for v4.1.

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:

ClasseDescrição
PlugPagClasse principal da biblioteca.
Essa classe é responsável pelas transações.
PlugPagAbortResultResultado obtido ao solicitar um cancelamento de operação, enquanto a operação está em andamento.
PlugPagActivationDataDados de ativação do terminal.
PlugPagAppIdentificationIdentificação do aplicativo.
PlugPagBeepDataConfiguração de beep.
PlugPagCustomPrinterLayoutClasse para customização da dialog de impressão da via do cliente.
PlugPagEventDataDados de eventos gerados durante transações para atualização de eventos no aplicativo.
PlugPagExceptionTipo principal de exceções geradas pelo PlugPag.
PlugPagInitializationResultResultado da inicialização do terminal
PlugPagLedDataConfiguração de LED.
PlugPagNearFieldCardDataDados para leitura/escrita de NFC.
PlugPagNFCAuthDados de autenticação do NFC.
PlugPagNFCInfosResultResultado de uma requisição para obter informações de NFC.
PlugPagNFCResultResultado de uma leitura/escrita NFC.
PlugPagPaymentDataInformações de um pagamento a ser realizado.
PlugPagPrinterDataInformações de uma impressão a ser realizada.
PlugPagPrintResultResultado de uma requisição de impressão.
PlugPagSimpleNFCDataDados para escrita em um cartão NFC.
PlugPagTransactionResultResultado de uma transação.
PlugPagVoidDataInformações de um estorno a ser realizado.
PreferedNetworkEnum com configurações de conexão (dados móveis).
TerminalCapabilitiesConstantes de funcionalidades do terminal.
PlugPagTransactionResultResultado de transações de venda e estorno com sucesso.
PlugPagPreAutoDataDados para criar uma pré-autorização
PlugPagEffectuatePreAutoDataDados para efetivar uma pré-autorização criada
PlugPagCmdExchangeResultDados 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.

InterfaceDescrição
PlugPagAbortListenerInterface com métodos que são chamados durante uma transação assíncrona de abort.
PlugPagActivationListenerInterface com métodos que são chamados durante uma ativação e/ou durante uma desativação assíncrona.
PlugPagInstallmentsListenerInterface com métodos que são chamados ao realizar o cálculo de parcelas de forma assíncrona.
PlugPagIsActivatedListenerInterface com métodos que são chamados durante uma verificação se está ou não ativado assíncrona.
PlugPagLastTransactionListenerInterface com métodos que são chamados ao tentar obter de forma assíncrona a última transação aprovada.
PlugPagNFCListenerInterface com métodos que são chamados durante uma leitura ou uma escrita assíncrona em um cartão NFC.
PlugPagPaymentListenerInterface com métodos que são chamados durante uma transação assíncrona de pagamento.
PlugPagEventListenerInterface com método chamado quando um evento é enviado durante uma transação.
PlugPagPrinterListenerInterface 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

TipoRetorno
intRET_OK
Código utilizado para indicar sucesso nas operações.
Valor: 0
intREQUEST_CODE_AUTHENTICATION
Código utilizado para iniciar a Activity de autenticação.
Valor: 46981
intTYPE_CREDITO
Tipo de pagamento: crédito.
Valor: 1
intTYPE_DEBITO
Tipo de pagamento: débito
Valor: 2
intTYPE_VOUCHER
Tipo de pagamento: voucher (vale refeição)
Valor: 3
intTYPE_QRCODE
Tipo de pagamento: qrcode elo.
Valor: 4
intTYPE_PIX
Tipo de pagamento: qrcode pix.
Valor: 5
intTYPE_QRCODE_CREDITO
Tipo de pagamento: qrcode crédito
Valor: 7
intINSTALLMENT_TYPE_A_VISTA
Forma de parcelamento: à vista
Valor: 1
intINSTALLMENT_TYPE_PARC_VENDEDOR
Forma de parcelamento: parcelamento vendedor
Valor: 2
intINSTALLMENT_TYPE_PARC_COMPRADOR
Forma de parcelamento: parcelamento comprador
Valor: 3
intERROR_REQUIREMENTS_MISSING_PERMISSIONS
Código de retorno para indicar erro de falta de permissões do aplicativo.
Valor: -3000
intERROR_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 retornoMé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.
IntauthNFCCardDirectly(authData: PlugPagNFCAuth)
Realiza a autenticação do sistema NFC usado. Retorna sucesso com código 1 e falha com código -1.
voidasyncAbort(listener: PlugPagAbortListener)
Solicita o cancelamento da operação atual de forma assíncrona.
voidasyncAbortNFC(listener: PlugPagAbortListener)
Aborta uma operação de leitura/escrita NFC de forma assíncrona.
voidasyncCalculateInstallments(saleValue: String,listener:PlugPagInstallmentsListener)
Calcula o valor das parcelas de forma assíncrona.
voidasyncDeactivate(activationData:PlugPagActivationData,listener:PlugPagActivationListener)
Realiza a desativação do terminal de forma assíncrona.
voidasyncGetLastApprovedTransaction(listener:PlugPagLastTransactionListener)
Obtém a última transação aprovada de forma assíncrona.
voidasyncIsAuthenticated(isActivatedListener:PlugPagIsActivatedListener)
Verifica se há um usuário autenticado de forma assíncrona.
voidasyncReadNFC(cardData: PlugPagNearFieldCardData,listener: PlugPagNFCListener)
Realiza leitura do conteúdo de um cartão NFC de forma assíncrona.
voidasyncReprintCustomerReceipt(listener:PlugPagPrinterListener)
Realiza a reimpressão da via do cliente de forma assíncrona.
voidasyncReprintEstablishmentReceipt(listener:PlugPagPrinterListener)
Realiza a reimpressão da via do estabelecimento de forma assíncrona.
voidasyncWriteNFC(cardData: PlugPagNearFieldCardData,listener: PlugPagNFCListener)
Realiza escrita em um cartão NFC de forma assíncrona.
intbeep(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.
voiddisposeSubscriber()
Realiza o dispose do subscriber atual.
voiddoAsyncInitializeAndActivatePinpad(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.
voiddoAsyncVoidPayment(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.
StringgetApplicationCode()
Retorna o código da aplicação.Esse código é uma constante da biblioteca.
PlugPagTransactionResult getLastApprovedTransaction()Obtém a última transação aprovada.
StringgetLibVersion()
PlugPagNFCInfosResult getNFCInfos(cardType: Int)Obtém as informações de um cartão NFC. Retorna o as informações de cartão NFC
BooleanhasCapability(capability: Int)
Verifica se o terminal tem uma funcionalidade especifica. Retorna true se houver a funcionalidade, false caso contrário.
intinitBTConnection(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.
voidinvalidateAuthentication()
Invalida uma autenticação. Equivalente a realizar um logout
booleanisAuthenticated()
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.
voidrequestAuthentication(PlugPagAuthenticationListener listener)
Solicita autenticação. O resultado da autenticação é notificado ao listener que é passado no parâmetro listener.
voidsetEventListener(PlugPagEventListener listener)
Armazena a referência de uma instância de interface que receberá os eventos gerados durante as transações.
IntsetLed(ledData: PlugPagLedData)
Define os LEDs que serão acesos. Retorna sucesso com código 1 e falha com código -1.
voidsetPlugPagCustomPrinterLayout(PlugPagCustomPrinterLayout).
Permite customizar elementos da dialog de impressão da via do cliente.
BooleansetPreferredNetwork(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.
voidsetPrinterListener(listener: PlugPagPrinterListener)
Armazena a referência de uma instância de interface que receberá os eventos gerados durante uma impressão.
intsetVersionName(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.
IntstartNFCCardDirectly()
Inicia a antena NFC para uso. Retorna sucesso com código 1 e falha com código -1.
IntstopNFCCardDirectly()
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.
IntreadNFCCardDirectly(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.
IntwriteToNFCCardDirectly(cardData: PlugPagSimpleNFCData)
Realiza escrita em um cartão NFC diretamente. Retorna sucesso com código 1 e falha com código -1.
BooleansetMockState(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
PlugPagNFCInfosResultDirectlydetectNfcCardDirectly(cardType: Int, timeout: Int)
Retorna o resultado da detecção do cartão NFC
IntdetectNfcRemoveDirectly(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
IntjustAuthNfcDirectly(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

TipoMétodo e Descrição
intgetResult()
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

TipoMétodo e Descrição
StringgetName()
Retorna o nome do aplicativo.
StringgetVersion()
Retorna a versão do aplicativo.

PlugPagEventData

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

Constantes

TipoRetorno
intEVENT_CODE_CUSTOM_MESSAGE
Código de evento indicando mensagem customizada pela PlugPag.
Valor: -2
intEVENT_CODE_DEFAULT
Código padrão de evento. Utilizado quando nenhum evento foi enviado.
Valor: -1
intEVENT_CODE_WAITING_CARD
Código de evento indicando que o leitor está aguardando o usuário inserir o cartão.
Valor: 0
intEVENT_CODE_INSERTED_CARD
Código de evento indicando que o cartão foi inserido.
Valor: 1
intEVENT_CODE_PIN_REQUESTED
Código de evento indicando que o leitor está aguardando o usuário digitar a senha.
Valor: 2
intEVENT_CODE_PIN_OK
Código de evento indicando que a senha digitada foi validada com sucesso.
Valor: 3
intEVENT_CODE_SALE_END
Código de evento indicando o fim da transação.
Valor: 4
intEVENT_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
intEVENT_CODE_INSERTED_KEY
Código de evento indicando que a senha foi digitada.
Valor: 6
intEVENT_CODE_WAITING_REMOVE_CARD
Código de evento indicando que o terminal está aguardando o usuário remover o cartão.
Valor: 7
intEVENT_CODE_REMOVED_CARD
Código de evento indicando que o cartão foi removido do terminal.
Valor: 8
intEVENT_CODE_CVV_REQUESTED
Código de evento indicando que foi solicitado o CVV..
Valor: 9
intEVENT_CODE_CVV_OK
Código de evento indicando que o CVV foi inserido corretamente.
Valor: 10
intEVENT_CODE_CAR_BIN_REQUESTED
Código de evento indicando que foi solicitado o BIN.
Valor: 11
intEVENT_CODE_CAR_BIN_OK
Código de evento indicando que o BIN foi inserido corretamente.
Valor: 12
intEVENT_CODE_CAR_HOLDER_REQUESTED
Código de evento indicando que foi solicitado o CVV.
Valor: 13
intEVENT_CODE_CAR_HOLDER_OK
Código de evento indicando que o HOLDER foi inserido corretamente.
Valor: 14
intEVENT_CODE_ACTIVATION_SUCCESS
Código de evento indicando que a ativação foi feita corretamente.
Valor: 15
intEVENT_CODE_DIGIT_PASSWORD
Código de evento indicando que a um número da senha foi digitado.
Valor: 16
intEVENT_CODE_NO_PASSWORD
Código de evento indicando que a senha foi apagada.
Valor: 17
intEVENT_CODE_SALE_APPROVED
Código de evento indicando a venda foi aprovada.
Valor: 18
intEVENT_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

TipoMétodo e Descrição
intgetEventCode()
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

TipoMétodo e Descrição
intgetAmount()
Retorna o valor a ser pago, em centavos.
intgetInstallments()
Retorna o número de parcelas do pagamento.
intgetInstallmentType()
Retorna o tipo de parcelamento.
Valores: PlugPag.INSTALLMENT_TYPE_A_VISTA ou PlugPag.INSTALLMENT_TYPE_PARC_VENDEDOR
intgetType()
Retorna o tipo de pagamento.
Valores: PlugPag.TYPE_CREDITO, PlugPag.TYPE_DEBITO ou PlugPag.TYPE_VOUCHER.
StringgetUserReference()
Retorna o código de venda.
booleangetPartialPayEnabled()
Retorna o valor true caso o pagamento aceite autorização parcial.
booleangetPaymentCarne()
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

TipoMétodo e Descrição
PlugPagPaymentDatabuild()
Cria um PlugPagPaymentData com os dados armazenados no Builder.
BuildersetAmount(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.
BuildersetInstallments(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.
BuildersetInstallmentType(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.
BuildersetType(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.
BuildersetUserReference(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.
BuildersetPaymentCarne(boolean paymentCarne)
Define se o pagamento poderá ser do tipo Carnê. Caso não sejam atribuídos valores, seu padrão é desligado (false).
BuildersetPartialPayEnabled(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

TipoMétodo e Descrição
StringgetAmount()
Retorna o valor transacionado.
StringgetAvailableBalance()
Retorna o saldo da conta, caso o método de pagamento seja PlugPag.TYPE_VOUCHER.
StringgetBin()
Retorna os 6 (quatro) últimos dígitos do cartão utilizado.
StringgetCardApplication()
Retorna a aplicação do cartão.
StringgetCardBrand()
Retorna a bandeira do cartão utilizado.
StringgetBuyerName()
Retorna o nome do proprietário da carteira PIX.
StringgetCardCryptogram()
Retorna o criptograma do cartão.
StringgetDate()
Retorna a data da transação.
StringgetErrorCode()
Se um erro ocorreu durante a transação, retorna o código de erro.
StringgetExtendedHolderName()
Retorna o nome completo do titular do cartão utilizado.
StringgetHolder()
Retorna os 4 últimos dígitos do cartão utilizado.
StringgetHolderName()
Retorna o nome do titular do cartão utilizado.
StringgetHostNsu()
Retorna um identificador único do host (servidor).
StringgetLabel()
Retorna o label do cartão utilizado.
StringgetMessage()
Retorna uma mensagem do resultado da transação, definida pela biblioteca.
intgetResult()
Retorna o código do resultado.
StringgetTerminalSerialNumber()
Retorna o número de série do terminal ou leitor utilizado para efetuar o pagamento.
StringgetTime()
Retorna o horário da transação.
StringgetTransactionCode()
Retorna o código da transação.
StringgetTransactionId()
Retorna o ID da transação.
StringgetUserReference()
Retorna o código de venda o pagamento efetuado.
StringgetOriginalAmount()
Retorna o código de venda o pagamento efetuado.
StringgetInstallments()
Retorna a quantidade de parcelas da transação.
StringgetReaderModel()
Retorna o modelo do equipamento.
StringgetTypeTransaction()
Retorna o tipo da transação.
StringgetPaymentType()
Retorna qual o tipo de pagamento a transação se relaciona.
StringgetAppIdentification()
Retorna qual o valor preenchido no parametro appNamenote.
StringgetAutoCode()
Retorna o codigo de autorização.
StringgetPreAutoDueDate()
Retorna a data da transação.
StringgetPreAutoOriginalAmont()
Retorna o valor da transação.

PlugPagTransactionResult.Builder

Construtor de objetos PlugPagTransactionResult.

Construtores

  • Builder ()
    Cria um construtor de objetos PlugPagTransactionResult.

Métodos

TipoMétodo e Descrição
PlugPagTransactionResultbuild()
Constrói uma instância da classe PlugPagTransactionResult utilizando os dados armazenados.
BuildersetAmount(String amount)
Define o valor da transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetAvailableBalance(String availableBalance)
Define o saldo disponível.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetBin(String bin)
Define o BIN do cartão utilizado na transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetCardApplication(String cardApplication)
Define a aplicação do cartão utilizado na transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetCardBrand(String cardBrand)
Define a bandeira do cartão utilizado na transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetCardCryptogram(String cardCryptogram)
Define o criptograma do cartão utilizado na transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetDate(String date)
Define a data da transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetExtendedHolderName(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.
BuildersetHolder(String holder)
Define o nome do titular do cartão.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetHolderName(String holderName)
Define o nome do titular do cartão.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetHostNsu(String hostNsu)
Define o NSU do host que executou a transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetLabe(String label)
Define o label do cartão utilizado.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetMessage(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.
BuildersetTerminalSerialNumber(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.
BuildersetTime(String time)
Define o horário da transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetTransactionCode(String transactionCode)
Define o código da transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetTransactionId(String transactionId)
Define o ID da transação.
Retorna a referência do próprio Builder para chamadas encadeadas.
BuildersetUserReference(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

TipoMétodo e Descrição
StringgetTransactionCode()
Retorna o código da transação que será estornada.
StringgetTransactionId()
Retorna o ID da transação que será estornada.
IntgetPrintReceipt()
Retorna se será impresso comprovante na transação.
IntgetVoidType()
Retorna o tipo de estorno que será realizado.

PlugPagVoidData.Builder

Construtor de objetos PlugPagVoidData.

Construtores

  • Builder ()
    Cria um construtor de objetos PlugPagVoidData.

Método

TipoMétodo e Descrição
PlugPagVoidDatabuild()
Constrói uma instância da classe PlugPagVoidData utilizando os dados armazenados.
BuildersetTransactionCode(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.
BuildersetTransactionId(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

TipoMétodo e Descrição
voidsetButtonBanckgroundColor(String hexaCodeColor)
Modifica a cor de fundo dos botões da dialog.
voidsetButtonBackgroundColorDisabled(String hexaCodeColor)
Modifica a cor de fundo dos botões da dialog quando desativados.
voidsetCancelTextColor(String hexaCodeColor)
Altera a cor do texto do botão de cancelar da dialog.
voidsetSendSMSTextColor(String hexaCodeColor)
Altera a cor do texto do botão de enviar sms da dialog.
voidsetConfirmTextColor(String hexaCodeColor)
Altera a cor do texto do botão de confirmar da dialog.
voidsetTitle(String titleText)
Seta o texto a ser mostrado na dialog.
voidsetTitleColor(String hexaCodeColor)
Altera a cor do texto mostrado na dialog.
voidsetWindowBackgroundColor(String hexaCodeColor)
Modifica a cor de fundo da dialog.
voidsetMaxTimeShowPopup(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

TipoMétodo e Descrição
intgetStartSlot()
Retorna o primeiro slot a ser escrito/lido
intgetEndSlot()
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.
intgetResult()
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

TipoMétodo e Descrição
intgetResult()
Retorna PlugPag.RET_OK quando sucesso.
intgetMessage()
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

TipoMétodo e Descrição
String filePathgetFilePath()
Retorna o caminho de arquivo a ser impresso.
int printerQualitygetPrinterQuality()
Retorna a qualidade da impressão. Os valores podem variar de 1 a 4, onde 4 indica a maior qualidade da impressão.
int stepgetStep()
Retorna o espaçamento a ser feito após a impressão terminar.