Pesquisar

Are you looking for test card numbers?

Would you like to contact support?

Point-of-sale icon

Referências da API de terminais

Revise nossas referências de API para implementar o padrão nexo. Para obter uma lista definitiva de especificações para o protocolo nexo, consulte o site de padrões nexo .

AbortRequest

Definição: Corpo da mensagem de solicitação de cancelamento.

Uso: Transmite as informações solicitadas para identificação da solicitação de mensagem que leva a transação a ser abortada. Uma mensagem a ser exibida no dispositivo CustomerError pode ser enviada pelo sistema de vendas (DisplayOutput).

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requirido

Estrutura de dados definida

Identificação de uma transação POI anterior.

 

AbortReason

Requirido

String

Motivo de abortar uma transação.

 

Condicional

Estrutura de dados definida

Informações a serem exibidas e a maneira de processar a exibição.

Para exibir uma mensagem de cancelamento ao cliente.

AccountType

Nome: AccountType

Tipo: Enumeração

  • Default
  • Savings
  • Checking
  • CreditCard
  • Universal
  • Investment
  • CardTotals
  • EpurseCard

Alignment

Nome: Alignment

Tipo: Enumeração

  • Left
  • Right
  • Centred
  • Justified

AllowedProduct

Definição: Códigos de produtos que são pagáveis pelo cartão de pagamento.

Uso: Produto que pode ser pago pelo cartão de pagamento.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

ProductCode

Requerido

DigitString

Código do produto do item adquirido com a transação.

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 20

EanUpc

Condicional

DigitString

Código padrão do produto do item adquirido com a transação.

 

ProductLabel

Condicional

String

Nome do produto de um item comprado com a transação.

 

AdditionalProductInfo

Condicional

String

Informações adicionais relacionadas ao item de linha.

 

AmountsReq

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Currency

Requerido

ISOCurrency

Moeda para um valor monetário.

 

RequestedAmount

Condicional

SimpleAmount

Valor solicitado pela venda para o pagamento.

 

CashBackAmount

Condicional

SimpleAmount

A parte de cash-back do valor solicitado pela venda para o pagamento.

 

TipAmount

Condicional

SimpleAmount

Valor pago para uma gorjeta. Permite a impressão da gorjeta no recibo e qualifica a parte da quantia do valor.

 

PaidAmount

Condicional

SimpleAmount

Montante já pago em caso de pagamento parcelado. Dependendo do contexto, um pagamento parcelado é um valor parcelado ou uma cesta dividida (exigida por alguns meios de pagamento como cartões de frota). O PaidAmount está presente quando o pagamento dividido é uma divisão do valor. A divisão da cesta envolve duas transações de venda e não deve ser reconhecida pelo POI.

 

MinimumAmountToDeliver

Condicional

SimpleAmount

Valor mínimo que o Sistema de vendas pode entregar para este pagamento. Para o OneTimeReservation, quando o valor máximo é desconhecido, o Sistema de vendas indica o valor mínimo permitido.

 

MaximumCashBackAmount

Condicional

SimpleAmount

Valor máximo que pode ser solicitado para devolução do dinheiro ao Sistema de Vendas. Permite que o Caixa limite o valor do cash-back a entregar ao cliente.

 

MinimumSplitAmount

Condicional

SimpleAmount

Quantidade mínima de uma divisão, que pode ser solicitada por um cliente. Permite que o comerciante limite o número de parcelas solicitada pelo cliente.

AmountsResp

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Currency

Condicional

ISOCurrency

Moeda do valor monetário.

 

AuthorizedAmount

Requerido

SimpleAmount

Valor solicitado pela venda para o pagamento.

 

TotalRebatesAmount

Condicional

SimpleAmount

Soma dos descontos no valor (valor total ou valor do item de linha) para todos os programas de fidelidade.

 

TotalFeesAmount

Condicional

SimpleAmount

Valor total de taxas financeiras.

 

CashBackAmount

Condicional

SimpleAmount

A parte do cash-back do valor solicitado pela venda para o pagamento.

 

TipAmount

Condicional

SimpleAmount

Quantia paga para uma gorjeta. Permita a impressão da gorjeta no recibo e qualifique a parte da gorjeta no valor.

 

AreaSize

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

X

Requerido

HexString

A abscissa de as coordenadas de um ponto. O valor hexadecimal no texto da abcissa das coordenadas de um ponto. O zero inicial pode ser removido (por exemplo, 3BC, 0 e 1287).

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 4

Y

Requerido

HexString

Ordenada de coordenadas de um ponto. O valor hexadecimal no texto da ordenada das coordenadas de um ponto. O zero inicial pode ser removido (por exemplo, 3BC, 0 e 1287).

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 4

AuthenticationMethod

Nome: AuthenticationMethod

Tipo: Cluster

  • Bypass
  • ManualVerification
  • MerchantAuthentication
  • OfflinePIN
  • OnlinePIN
  • PaperSignature
  • SecuredChannel
  • SecureCertificate
  • SecureNoCertificate
  • SignatureCapture
  • UnknownMethod

BalanceInquiryRequest

Definição: Conteúdo da mensagem de solicitação de consulta de saldo.

Uso: Transmite informações relacionadas à conta para a qual uma consulta de saldo é solicitada.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

Dados relacionados à conta apontada pelo cartão de pagamento.

 

Condicional

Estrutura de dados definida

Dados relacionados a um programa ou conta de fidelidade solicitado.

 

BalanceInquiryResponse

Definição: Conteúdo da mensagem de resposta de consulta de saldo.

Uso: Transmite o saldo e a identificação das contas de pagamento, fidelidade ou de valor armazenado.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descreição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Condicional

Estrutura de dados definida

Dados relacionados ao resultado de uma solicitação de consulta de saldo.

Se BalanceInquiryRequest. PaymentAccount presente.

Condicional

Estrutura de dados definida

Dados relacionados ao resultado de uma consulta de saldo da conta de fidelidade.

Se BalanceInquiryRequest. LoyaltyData presente.

Matriz Requerida

Estrutura de dados definida

 

 

BarcodeType

Nome: BarcodeType

Tipo: Enumeração

  • EAN8
  • EAN13
  • UPCA
  • Code25
  • Code128
  • PDF417
  • QRCode

CapturedSignature

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

Tamanho de uma área. Contem o tamanho da área do bloco onde a assinatura é gravada, fornecida com os valores máximos de abscissa e ordenada (X e Y). O valor máximo é 'FFFF'.

 

Matriz Requerida

Estrutura de dados definida

Coordenadas de um ponto em que a pen muda de direção ou de elevação. Contem as coordenadas de um ponto da assinatura escrita em que a pen muda de direção ou levanta onte (X e Y). Quando o assinante levanta a pen, X e Y têm o valor 'FFFF'.

 

CardAcquisitionRequest

Definição: Conteúdo da mensagem de solicitação de aquisição de cartão.

Uso: Transmite informações relacionadas aos cartões de pagamento e fidelidade para leitura e análise. Esse par de mensagens geralmente é seguido por um par de mensagens (por exemplo, pagamento ou lealdade) que se refere a esse par de mensagens de Aquisição de cartão.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Dados relacionados ao sistema de vendas.

 

Requerido

Estrutura de dados definida

Dados relacionados à aquisição e pagamento com cartão de fidelidade.

 

CardAcquisitionResponse

Definição: Conteúdo da mensagem de resposta de aquisição do cartão.

Uso: Transmite informações relacionadas aos cartões de pagamento e de fidelidade lidos e processados pelo sistema POI e inseridos pelo cliente.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Requerido

Estrutura de dados definida

Dados relacionados ao sistema de vendas.

 

Requerido

Estrutura de dados definida

Dados relacionados ao sistema POI.

 

CustomerLanguage

Condicional

ISOLanguage

Dados relacionados ao sistema POI.

 

PaymentBrand

Matriz Requerida

String

Tipo de cartão de pagamento.

Marcas disponíveis para pagamento com cartão e não escolhidas pelo cliente..

Condicional

Estrutura de dados definida

Dados relacionados ao instrumento de pagamento da transação.

Se este tipo de cartão de pagamento estiver configurado para enviar informações se a resposta do CardAcquisition.

CardAcquisitionTransaction

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

AllowedPaymentBrand

Matriz Requerida

String

 

 

AllowedLoyaltyBrand

Matriz Requerida

String

 

 

Condicional

Enumeration

 

 

CustomerLanguage

Condicional

ISOLanguage

 

 

Condicional

Cluster

 

 

ForceCustomerSelectionFlag

Condicional

Boolean

 

 

TotalAmount

Condicional

SimpleAmount

 

 

Condicional

Enumeration

 

 

CashBackFlag

Condicional

Boolean

 

 

CardData

Definição: Informações relacionadas ao cartão de pagamento usado para a transação.

Uso: Permite a aquisição dos dados do cartão pelo sistema de vendas antes da solicitação de pagamento, aquisição de cartão ou BalanceInquiry ao POI. Também pode ser enviado na resposta CardAcquisition, para ser processado pelo sistema de vendas.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

PaymentBrand

Condicional

String

Tipo de cartão de pagamento.

Se o PAN do cartão estiver legível.

MaskedPan

Condicional

String

 

 

PaymentAccountRef

Condicional

String

 

 

Condicional

Cluster

Modo de entrada das informações do instrumento de pagamento.

Obrigatório na solicitação.

CardCountryCode

Condicional

DigitString

Código do país anexado ao cartão (3 numéricos).

Se disponível no cartão.

O comprimento da string deve ser exatamente 3

ProtectedCardData

Condicional

ContentInformation

Informações sensíveis relacionadas ao cartão de pagamento, protegidas pelo CMS.

SensitiveCardData protegido pelo CMS EnvelopedData.

Condicional

Estrutura de dados definida

Informações sensíveis relacionadas ao cartão de pagamento, inseridas ou lidas pelo sistema de vendas.

Se a estrutura não estiver vazia e desprotegida.

AllowedProductCode

Matriz Requerida

DigitString

Códigos do produto que são pagáveis pelo cartão de pagamento.

Caso contrário, nem todos os produtos serão aceitos para o cartão de pagamento proposto pelo cliente. Nesse caso, o resultado é falha, ErrorCondition é Payment Restriction. Para One Time Reservation, o POI pode enviar códigos de produtos pagáveis pelo meio pagamento, mesmo que o POI não tenha enviado o SaleItem na solicitação. Se pelo menos um produto enviado na solicitação for aceito, o resultado é sucesso.

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 20

Matriz Requerida

Estrutura de dados definida

Produto pagável pelo cartão de pagamento.

 

Condicional

Estrutura de dados definida

Substituto do PAN (Primary Account Number) do cartão de pagamento para identificar o meio de pagamento do cliente. Permite, para um comerciante, identificar o cliente.

Restrição do produto pagável por um cartão.

Matriz Requerida

Estrutura de dados definida

Pedido do cliente anexado a um cliente, registrado no sistema POI. Permite o gerenciamento de pedidos de clientes pelo POI, por exemplo, em uma transação de venda multicanal ou click and collect.

 

CardReaderAPDUResponse

Definição: Conteúdo da mensagem de resposta do APDU do leitor de cartão..

Uso: Contém o resultado do serviço solicitado, resposta APDU enviada pelo chip do cartão em resposta à solicitação APDU.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

APDUData

Condicional

ByteSequence

Campo de dados do comando APDU (Lc + Data).

 

CardStatusWords

Requerido

ByteSequence

Status de uma resposta de um smartcard response a um comando (SW1-SW2).

 

O comprimento da bytesequence deve se exatamente 2

CashHandlingDevice

Definição: Status do dispositivo de manuseio de dinheiro.

Uso: Indique o status e as moedas e faturas restantes em um dispositivo de manuseio de dinheiro.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

CashHandlingOKFlag

Requerido

Boolean

Indica se o dispositivo de manuseio de dinheiro está funcionando e é utilizável.

 

Currency

Requerido

ISOCurrency

Moeda de um valor monetário.

 

Matriz Requerida

Estrutura de dados definida

Número de moedas ou notas de um determinado valor.

 

CharacterHeight

Nome: CharacterHeight

Tipo: Enumeração

  • SingleHeight
  • DoubleHeight
  • HalfHeight

CharacterStyle

Nome: CharacterStyle

Tipo: Enumeração

  • Normal
  • Bold
  • Italic
  • Underline

CharacterWidth

Nome: CharacterWidth

Tipo: Enumeração

  • SingleWidth
  • DoubleWidth

CheckData

Definição: Informações relacionadas a um cheque utilizado para a transação.

Uso: Permite que as informações do cheque sejam fornecidas pelo sistema de vendas antes de solicitar o pagamento ou armazenadas pelo sistema de vendas após o processamento do pagamento.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

BankID

Condicional

String

Identificação do banco.

Obrigatório se TrackData estiver ausente.

AccountNumber

Condicional

String

Identificação da conta do cliente.

Obrigatório se TrackData estiver ausente.

CheckNumber

Condicional

String

Identificação do cheque bancário.

Obrigatório se TrackData estiver ausente.

Condicional

Estrutura de dados definida

Faixa magnética linha de caracteres com tinta magnética.

Obrigatório se o CheckNumber estiver ausente.

CheckCardNumber

Condicional

String

Número do cartão de garantia do cheque.

Se fornecido pelo cliente.

Condicional

Enumeration

Tipo de cheque bancário.

 

Country

Condicional

ISOCountry

País do cheque bancário.

Ausente se o país do sistema de venda.

CoinsOrBills

Definição: Número de moedas ou notas de um determinado valor.

Uso: Indica o número restante de moedas ou notas de um determinado valor em um dispositivo de manuseio de dinheiro. Quando a máquina que liga com o dinheiro não possui mais moedas ou notas de um determinado valor, o número deve ser igual a 0.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

UnitValue

Requerido

SimpleAmount

Valor de uma moeda ou nota.

 

Number

Requerido

Integer

Número de elementos

 

Color

Nome: Color

Tipo: Enumeração

  • White
  • Black
  • Red
  • Green
  • Blue
  • Yellow
  • Magenta
  • Cyan

ConvertedAmount

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

AmountValue

Requerido

SimpleAmount

Valor da quantia.

 

Currency

Requerido

ISOCurrency

Moeda de um valor monetário.

 

CurrencyConversion

Definição: Informações relacionadas a uma conversão de moeda.

Uso: : Ocorreu uma conversão de moeda no pagamento e o comerciante precisa conhecer as informações relacionadas a essa conversão (por exemplo, para imprimir no recibo da venda).

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

CustomerApprovedFlag

Condicional

Boolean

Notifique se o cliente aprovou algo. Indica se o cliente aceitou uma conversão de moeda.

 

Requerido

Estrutura de dados definida

Valor após uma conversão de moeda.

 

Rate

Condicional

Decimal

Taxa de conversão de moeda.

 

Markup

Condicional

Decimal

Markup de um valor de conversão de moeda como uma porcentagem..

 

Commission

Condicional

SimpleAmount

Comissão para uma conversão de moeda.

 

Declaration

Condicional

String

Declaração a apresentar ao cliente ou ao caixa para validação.

Se uma declaração tiver que ser apresentada ao cliente.

CustomerOrder

Definição: Pedido anexado a um cliente, registrado no sistema POI.

Uso: Permite o gerenciamento de pedidos de clientes pelo POI, por exemplo, em uma
transação de venda multicanal ou click and collect.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

CustomerOrderID

Condicional

String

Identificação adicional e opcional de um pedido do cliente.

 

SaleReferenceID

Requeridos

String

Identificação de uma transação global de venda para uma sequência de transações de POI relacionadas. Identificação de uma transação de reserva para a sequência da reserva e a conclusão.

 

OpenOrderState

Condicional

Boolean

Especifica se um pedido do cliente está aberto no momento. Um pedido em aberto do cliente é um pedido aguardando operações adicionais.

 

StartDate

Requerido

ISODateTime

Data e hora do início de uma operação.

 

EndDate

Condicional

ISODateTime

Data e hora do final de uma operação.

 

ForecastedAmount

Requerido

SimpleAmount

Dependendo da escolha do sistema de venda, ele pode ser igual ao valor inicial do pedido ou ao valor global do pedido. Se ForecastedAmount for igual ao valor inicial do pedido, permitirá que o sistema siga qualquer pagamento adicional. Em caso de igualdade com o valor global do pedido, o sistema poderá acompanhar os valores restantes.

 

CurrentAmount

Requerido

SimpleAmount

Valor total de todas as transações concluídas de um pedido do cliente.

 

Currency

Condicional

ISOCurrency

Moeda de um valor monetário.

 

AccessedBy

Condicional

String

Identificação de uma entidade que acessa dados para executar uma operação. Permitir a sincronização do processamento de pedidos do cliente, quando várias partes do sistema de vendas acessam um pedido do cliente ao mesmo tempo. A entidade de venda ativa no pedido do cliente é identificada por esses dados

 

AdditionalInformation

Condicional

String

Informação não qualificada.

 

CustomerOrderReq

Nome: CustomerOrderReq

Tipo: Cluster

  • Open
  • Closed
  • Both

Device

Nome: Device

Tipo: Enumeração

  • CashierDisplay
  • CustomerDisplay
  • CashierInput
  • CustomerInput

DiagnosisRequest

Definição: Conteúdo da mensagem de solicitação de diagnóstico.

Uso: Transmite informações relacionadas ao POI de destino para o qual o diagnóstico é solicitado.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

POIID

Condicional

String

Identificação de um sistema de POI ou de um terminal de POI para o protocolo de venda para POI.

MessageHeader.POIID.

HostDiagnosisFlag

Condicional

Boolean

Indica se o diagnóstico do host é necessário.

 

AcquirerID

Matriz Requerida

DigitString

Identificação do Adquirente.

Presente se estiver solicitando apenas o diagnóstico desses hosts.

DiagnosisResponse

Definição: Conteúdo da mensagem de resposta ao diagnóstico.

Uso: Transmite o resultado do diagnóstico solicitado e uma possível mensagem a ser exibida em um dispositivo lógico.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

LoggedSaleID

Matriz Requerida

String

Terminal de venda conectado.

Se o terminal de vendas conectou-se à este Terminal POI.

Condicional

Estrutura de dados definida

Estado de um terminal de POI.

Se Response.Result é Success.

Matriz Requerida

Estrutura de dados definida

Estado de um host.

 

DisplayOutput

Definição: Informações a serem exibidas e a maneira de processar a exibição.

Uso: Este contém uma operação de exibição completa para um tipo de monitor ou dispositivo de entrada. Para os dispositivos de entrada, Diagnóstico e EnableService, ResponseRequiredFlag e MinimumDisplayTime devem estar ausentes.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

ResponseRequiredFlag

Condicional

Boolean

Pedido de uma resposta da mensagem.

 

MinimumDisplayTime

Condicional

Integer

Número de segundos em que a mensagem deve ser exibida.

 

Requerido

Enumeration

Dispositivo lógico localizado em um terminal de vendas ou em um terminal de POI, em termos de classe de informações a serem exibidas (exibição, impressão ou armazenamento) ou entrada (teclado) do caixa ou do cliente.

CashierDisplay, CustomerDisplay.

Requerido

Enumeration

Qualificação das informações a serem enviadas para um dispositivo lógico de saída, para exibição ou impressão no caixa ou para o cliente.

Status, Error, Display, POIReplication.

Requerido

Estrutura de dados definida

Conteúdo a ser exibido ou impresso.

 

Matriz Requerida

Estrutura de dados definida

 

 

OutputSignature

Condicional

ByteSequence

Assinatura específica do fornecedor da mensagem de texto a ser exibida ou impressa.

Se for necessário fornecer proteção ao fornecedor no texto a ser exibido ou impresso.

DisplayRequest

Definição: Conteúdo da mensagem de solicitação de exibição.

Uso: Transmite os dados a serem exibidos e a maneira de processar a exibição. Ele contém o conteúdo completo a ser exibido. Pode conter uma operação (o elemento DisplayOutput) por tipo de dispositivo de exibição.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Matriz Requerida

Estrutura de dados definida

Informações a serem exibidas e a maneira de processar a exibição.

Conteúdo de exibição completo para dispositivos de saída. No máximo, um par DisplayOutput por dispositivo / InfoQualify.

DisplayResponse

Definição: Conteúdo da mensagem de resposta de exibição.

Uso: Transmite o resultado da exibição, paralelo à solicitação de mensagem, exceto se a resposta não for necessária e ausente.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Matriz Necessária

Estrutura de dados definida

Informações relacionadas ao resultado de output (display, print, input).

Um por item da DisplayOutput de solicitação, e na mesma ordem.

DocumentQualifier

Nome: DocumentQualifier

Tipo: Enumeração

  • SaleReceipt
  • CashierReceipt
  • CustomerReceipt
  • Document
  • Voucher
  • Journal

EnableServiceRequest

Definição: Conteúdo da mensagem Enable Service Request.

Uso: Transmite os serviços que serão habilitados para o Terminal de POI sem a solicitação do sistema de vendas, e um possível convite para o cliente iniciar os serviços.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requeridos

Enumeration

Ação a ser realizada em uma transação.

 

Condicional

Cluster

Serviços que são ativados antes da inicialização de uma transação.

Obrigatório se TransactionAction for 'StartTransaction',caso contrário, será ausente.

Condicional

Estrutura de dados definida

Informações a serem exibidas e a maneira de processar a exibição.

 

EnableServiceResponse

Definição: Conteúdo da mensagem Enable Service Response.

Uso: transmite o resultado do processamento do processamento de Enable Service.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

EntryMode

Nome: EntryMode

Tipo: Cluster

  • RFID
  • Keyed
  • Manual
  • File
  • Scanned
  • MagStripe
  • ICC
  • SynchronousICC
  • Tapped
  • Contactless
  • Mobile

ErrorCondition

Nome: ErrorCondition

Tipo: Enumeração

  • Aborted
  • Busy
  • Cancel
  • DeviceOut
  • InsertedCard
  • InProgress
  • LoggedOut
  • MessageFormat
  • NotAllowed
  • NotFound
  • PaymentRestriction
  • Refusal
  • UnavailableDevice
  • UnavailableService
  • InvalidCard
  • UnreachableHost
  • WrongPIN

EventNotification

Definição: Conteúdo da mensagem EventNotification.

Uso: Transmite informações relacionadas ao evento e possíveis ações (manutenção, mensagem a ser exibida).
Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

TimeStamp

Requerido

ISODateTime

Data e hora de uma transação para o sistema de vendas, o sistema de POI ou o adquirente.

 

Requerido

Enumeration

Evento que o POI notifica ao sistema de venda.

 

EventDetails

Condicional

String

Informações sobre o evento que o POI notifica ao sistema de venda.

Se presente, a venda registra-o para exame mais aprofundado.

RejectedMessage

Condicional

ByteSequence

Pedido de mensagem rejeitado pelo destinatário.

Obrigatório se EventToNotify for 'Reject', ausente em outros casos.

MaintenanceRequiredFlag

Condicional

Boolean

Indica se o evento ocorrido requer uma chamada ou ação de manutenção.

 

CustomerLanguage

Condicional

ISOLanguage

Idioma do cliente.

Se o idioma for selecionado pelo sistema de vendas antes da solicitação ao POI.

Matriz Requerida

Estrutura de dados definida

Informações a serem exibidas e a maneira de processar a exibição.

Para exibir uma mensagem de evento.

EventToNotify

Nome: EventToNotify

Tipo: Enumeração

  • BeginMaintenance
  • EndMaintenance
  • Shutdown
  • Initialised
  • OutOfOrder
  • Completed
  • Abort
  • SaleWakeUp
  • SaleAdmin
  • CustomerLanguage
  • KeyPressed
  • SecurityAlarm
  • StopAssistance
  • CardInserted
  • CardRemoved
  • Reject

ForceEntryMode

Nome: ForceEntryMode

Tipo: Cluster

  • RFID
  • Keyed
  • Manual
  • File
  • Scanned
  • MagStripe
  • ICC
  • SynchronousICC
  • Tapped
  • Contactless
  • CheckReader

GenericProfile

Nome: GenericProfile

Tipo: Enumeração

  • Basic
  • Standard
  • Extended

GeographicCoordinates

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Latitude

Requerido

String

 

 

Longitude

Requerido

String

 

 

Geolocation

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

GetTotalsRequest

Definição: Conteúdo da mensagem Get Totals Request.

Uso: Transmite informações do sistema de vendas relacionadas ao escopo e ao formato dos totals a serem calculados pelo Sistema de POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Cluster

Indica a estrutura hierárquica do resultado da reconciliação da reconciliação venda para POI.

Exigir a apresentação de totals por valor do elemento incluído neste cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID).

Condicional

Estrutura de dados definida

Filtro para calcular os totals

Se a estrutura não estiver vazia.

GetTotalsResponse

Definição: Conteúdo da mensagem de resposta de reconciliação.

Uso: Transmite informações relacionadas à transação de reconciliação processada pelo sistema POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

POIReconciliationID

Requerido

DigitString

Identificação do período de reconciliação entre venda e POI.

 

Matriz Necessária

Estrutura de dados definida

Resultado do processo de reconciliação de venda para POI.

Se Response.Result for Success.

GlobalStatus

Nome: GlobalStatus

Tipo: Enumeração

  • OK
  • Busy
  • Maintenance
  • Unreachable

HostStatus

Definição: Estado de um host.

Uso: Indique a acessibilidade do host pelo Terminal POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

AcquirerID

Requerido

Estrutura de dados definida

Identificação do Adquirente.

 

IsReachableFlag

Condicional

Boolean

Indique se um host está acessível.

 

IdentificationSupport

Nome: IdentificationSupport

Tipo: Enumeração

  • NoCard
  • LoyaltyCard
  • HybridCard
  • LinkedCard

IdentificationType

Nome: IdentificationType

Tipo: Enumeração

  • PAN
  • ISOTrack2
  • BarCode
  • AccountNumber
  • PhoneNumber

InfoQualify

Nome: InfoQualify

Tipo: Enumeração

  • Status
  • Error
  • Display
  • Sound
  • Input
  • POIReplication
  • CustomerAssistance
  • Receipt
  • Document
  • Voucher

Input

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

 

 

ConfirmedFlag

Condicional

Boolean

 

 

FunctionKey

Condicional

DigitString

 

 

TextInput

Condicional

Unicode String

 

 

DigitInput

Condicional

DigitString

 

 

Password

Condicional

ContentInformation

 

 

MenuEntryNumber

Matriz Requerida

Integer

 

 

InputCommand

Nome: InputCommand

Tipo: Enumeração

  • GetAnyKey
  • GetConfirmation
  • SiteManager
  • TextString
  • DigitString
  • DecimalString
  • GetFunctionKey
  • GetMenuEntry
  • Password

InputData

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

 

 

Requerido

Enumeration

 

 

Requerido

Enumeration

 

 

NotifyCardInputFlag

Condicional

Boolean

 

 

MaxInputTime

Condicional

Integer

 

 

ImmediateResponseFlag

Condicional

Boolean

 

 

MinLength

Condicional

Integer

 

 

MaxLength

Condicional

Integer

 

 

MaxDecimalLength

Condicional

Integer

 

 

WaitUserValidationFlag

Condicional

Boolean

 

 

DefaultInputString

Condicional

String

 

 

StringMask

Condicional

String

 

 

FromRightToLeftFlag

Condicional

Boolean

 

 

MaskCharactersFlag

Condicional

Boolean

 

 

BeepKeyFlag

Condicional

Boolean

 

 

GlobalCorrectionFlag

Condicional

Boolean

 

 

DisableCancelFlag

Condicional

Boolean

 

 

DisableCorrectFlag

Condicional

Boolean

 

 

DisableValidFlag

Condicional

Boolean

 

 

MenuBackFlag

Condicional

Boolean

 

 

InputRequest

Definição: Conteúdo da mensagem de Request.

Uso: Este transmite dados para exibição e a maneira de processar a exibição e contém o conteúdo completo a ser exibido. Além da exibição no dispositivo de entrada, ele pode conter uma operação (o elemento DisplayOutput) por tipo de dispositivo de exibição.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

Condicional

Estrutura de dados definida

Informações a serem exibidas e a maneira de processar a exibição.

 

Requerido

Estrutura de dados definida

Informações relacionadas a uma solicitação de entrada.

 

InputResponse

Definição: Conteúdo da mensagem de Input Response.

Uso: Transmite o resultado da input ou o resultado das outputs, paralelo à solicitação da mensagem, exceto se a resposta não for necessária e ausente.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

Condicional

Estrutura de dados definida

Informações relacionadas ao resultado da output (exibição, impressão, entrada).

Se DisplayOutput é presente na solicitação.

Requerido

Estrutura de dados definida

Informações relacionadas ao resultado da entrada.

 

InputResult

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

Requerido

Enumeration

 

 

Requerido

Enumeration

 

 

Requerido

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Instalment

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

Condicional

Enumeration

 

 

SequenceNumber

Condicional

Integer

 

 

PlanID

Condicional

String

 

 

Period

Condicional

Integer

 

 

Condicional

Enumeration

 

 

FirstPaymentDate

Condicional

ISODate

 

 

TotalNbOfPayments

Condicional

Integer

 

 

CumulativeAmount

Condicional

SimpleAmount

 

 

FirstAmount

Condicional

SimpleAmount

 

 

Charges

Condicional

SimpleAmount

 

 

InstalmentType

Nome: InstalmentType

Tipo: Enumeração

  • DeferredInstalment
  • EqualInstalments
  • UnequalInstalments

LoginRequest

Definição: Conteúdo da mensagem de Solicitação de Login.

Usage: Este transmite as informações relacionadas à sessão (período entre um Login e o Logout a seguir) para processar.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

DateTime

Requerido

ISODateTime

Data e hora.

 

Requerido

Estrutura de dados definida

Informações relacionadas ao software do sistema de venda que gerencia o protocolo de venda para POI.

 

Condicional

Estrutura de dados definida

Informações relacionadas ao recurso de software e hardware do Terminal de vendas.

Apresente se o logon envolve um terminal de vendas.

TrainingModeFlag

Condicional

Boolean

Modo de treinamento.

O POI não realiza a transação com o Adquirente.

OperatorLanguage

Requerido

ISOLanguage

Idioma do caixa ou operador.

O valor padrão para o tipo de dispositivo é exibido.

OperatorID

Condicional

String

Identificação do caixa ou operador.

4 condições para enviá-lo: a) o sistema de vendas deseja que o POI registre-o no log de transações b) devido à reconciliação.

ShiftNumber

Condicional

String

Número do Shift .

O mesmo que OperatorID.

Condicional

Enumeration

um cartão de pagamento para identificar o meio de pagamento do cliente. Ele permite que um comerciante use um token apenas para uma transação ou por um período mais longo.

 

Condicional

Cluster

Lista de pedidos do cliente abertos, fechados ou ambos a serem enviados nas mensagens de resposta.

 

POISerialNumber

Condicional

String

Número de série de um terminal POI.

Se o login envolver um terminal POI e não o primeiro login no sistema POI.

LoginResponse

Definição: Conteúdo da mensagem de resposta de login

Uso: Transmite informações relacionadas ao login para processar.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Condicional

Estrutura de dados definida

Informações relacionadas ao sistema de POI.

se Response.Result for Success.

TokenRequestStatus

Condicional

Boolean

 

 

CustomerOrderStatus

Condicional

Boolean

 

 

LogoutRequest

Definição: Conteúdo da mensagem de Solicitação de Logout.

Uso: Vazio.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

MaintenanceAllowed

Condicional

Boolean

 

 

LogoutResponse

Definição: Conteúdo da mensagem de resposta de logoff.

Uso: Transmite o resultado do Logout.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

LoyaltyAccount

Definição: Dados relacionados a uma conta de fidelidade processada na transação.

Uso: Essa estrutura de dados transmite a identificação da conta e a marca de fidelidade associada.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrioção Regra

Requerido

Estrutura de dados definida

Identificação de uma conta fidelidade.

 

LoyaltyBrand

Condicional

String

Identificação de uma marca fidelidade.

Se um cartão é analisado.

LoyaltyAccountID

Definição: Identificação de uma conta fidelidade.

Uso: Na solicitação de mensagem de pagamento ou fidelidade, é possível identificar a conta fidelidade pelo terminal em vez do Terminal de POI (por exemplo, porque a identificação da conta é um código de barras lido pelo Caixa em um dispositivo de scanner).

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Cluster

 

 

Requerido

Enumeration

 

 

Condicional

Enumeration

 

 

LoyaltyID

Requerido

String

 

 

LoyaltyAccountReq

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

LoyaltyAccountStatus

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

 

 

CurrentBalance

Condicional

SimpleAmount

 

 

Condicional

Enumeration

 

 

Currency

Condicional

ISOCurrency

 

 

LoyaltyAcquirerData

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

LoyaltyAcquirerID

Condicional

String

 

 

ApprovalCode

Condicional

String

 

 

Condicional

Estrutura de dados definida

 

 

HostReconciliationID

Condicional

String

 

 

LoyaltyAmount

Definition: Valor de fidelidade.

Usage: Um valor concedido ou um valor a ser resgatado na conta fidelidade pode ser enviado na mensagem de solicitação de pagamento.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

 

 

Currency

Condicional

ISOCurrency

 

 

AmountValue

Requerido

SimpleAmount

 

 

LoyaltyData

Definição: Dados relacionados a um programa ou conta fidelidade.

Uso: Na mensagem solicitação de pagamento, fidelidade ou solicitação de saldo, é permitido que o terminal envie a identificação da conta fidelidade, um valor concedido ou um valor a ser resgatado na conta fidelidade.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

Referência à última CardAcquisition, para usar o mesmo cartão.

Se o ID da conta fidelidade vide de uma CardAcquisition anterior.

Condicional

Estrutura de dados definida

Identificação de uma conta fidelidade.

Se a identificação fidelidade da conta fidelidade for realizada pelo sistema de vendas.

Condicional

Estrutura de dados definida

Valor de uma conta fidelidade.

Quando o sistema de vendas deseja conceder uma conta fidelidade (não é para o BalanceInquiryRequest).

LoyaltyHandling

Nome: LoyaltyHandling

Tipo: Enumeração

  • Forbidden
  • Processed
  • Allowed
  • Proposed
  • Required

LoyaltyResponse

Definição: Conteúdo da mensagem de Loyalty Response.

Uso: Transmite informações relacionadas à transação fidelidade processada pelo sistema POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requeridos

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Requeridos

Estrutura de dados definida

Dados relacionados ao sistema de vendas.

 

Requeridos

Estrutura de dados definida

Dados relacionados ao sistema POI.

 

Matriz Requerida

Estrutura de dados definida

Dados relacionados ao resultado de uma transação de fidelidade processada.

Se a conta de fidelidade for identificada.

Matriz Requerida

Estrutura de dados definida

 

 

LoyaltyResult

Definição: Dados relacionados ao resultado de uma transação de fidelidade processada.

Uso: Na resposta da mensagem, o resultado de cada transação de marca fidelidade.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Dados relacionados a uma conta fidelidade processada na transação.

 

CurrentBalance

Condicional

SimpleAmount

Saldo de uma conta.

Se conhecido (fornecido pelo cartão ou por um host externo).

Condicional

Estrutura de dados definida

Valor de uma conta fidelidade.

Se o valor for concedido.

Condicional

Estrutura de dados definida

Dados relacionados ao adquirente da fidelidade durante uma transação de fidelidade.

Se o conteúdo não estiver vazio.

Condicional

Estrutura de dados definida

Formulário de abatimento para um prêmio.

Se o abatimento for concedido.

LoyaltyTotals

Definição: Totals das transações de fidelidade durante o período de reconciliação.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Tipo de transação para a qual os totals estão agrupados.

Award, ReverseAward, Redemption, ReverseRedemption, Rebate, ReverseRebate.

TransactionCount

Requerido

Integer

Número de transações processadas durante o período.

 

TransactionAmount

Requerido

SimpleAmount

Soma do valor da transação processada durante o período.

 

LoyaltyUnit

Nome: LoyaltyUnit

Tipo: Enumeração

  • Point
  • Monetary

MenuEntry

Definição: Uma entrada do menu para apresentar ao Caixa.

Uso: Transmite o texto da mensagem e os parâmetros da entrada do menu. Esses dados de saída podem ser fornecidos apenas para um comando de entrada, a fim de escolher uma entrada do menu.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

Características relacionadas à seleção de uma entrada do menu.

 

DefaultSelectedFlag

Condicional

Boolean

 

 

Requerido

Enumeration

 

 

Condicional

Estrutura de dados definida

 

 

Matriz Requerida

Estrutura de dados definida

 

 

OutputXHTML

Condicional

ByteSequence

 

 

MenuEntryTag

Nome: MenuEntryTag

Tipo: Enumeração

  • Selectable
  • NonSelectable
  • SubMenu
  • NonSelectableSubMenu

MessageCategory

Nome: MessageCategory

Tipo: Enumeração

  • Abort
  • Admin
  • BalanceInquiry
  • Batch
  • CardAcquisition
  • CardReaderAPDU
  • CardReaderInit
  • CardReaderPowerOff
  • Diagnosis
  • Display
  • EnableService
  • Event
  • GetTotals
  • Input
  • InputUpdate
  • Login
  • Logout
  • Loyalty
  • Payment
  • PIN
  • Print
  • Reconciliation
  • Reversal
  • Sound
  • StoredValue
  • TransactionStatus
  • Transmit

MessageClass

Nome: MessageClass

Tipo: Enumeração

  • Service
  • Device
  • Event

MessageHeader

Definição: Cabeçalho da mensagem da mensagem do protocolo Sale to POI.

Usage: Transmite informações relacionadas ao gerenciamento do protocolo Sale to POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

ProtocolVersion

Condicional

String

 

Se MessageCategory for Login ou Diagnosis.

Requeridos

Enumeration

Classe da mensagem.

 

Requerido

Enumeration

Categoria da mensagem.

 

Requerido

Enumeration

Tipo de mensagem do protocolo Sale to POI.

 

ServiceID

Condicional

String

Identificação de um par de mensagens, que processa uma transação.

Necessário se a mensagem MessageClass 'Service' ou 'Event' ou se MessageClass 'Device' e solicitação do POI ou resposta de Sale.

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 10

DeviceID

Condicional

String

Identificação de um par de mensagens do dispositivo.

Se MessageClass 'Device'.

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 10

SaleID

Requerido

String

Identificação de um sistema de venda ou de um terminal de venda para o protocolo Sale to POI.

 

POIID

Requerido

String

Identificação de um sistema de POI ou de um terminal de POI para o protocolo de Sale to POI.

 

MessageReference

Definição: Identificação de uma transação POI anterior.

Uso: To abort a transaction in progress or to request the status of a transaction from which no response has been received. It identifies the message header of the message request to abort or request the status.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

Categoria da mensagem.

CardAcquisition, Display, Input, Loyalty, Payment, Print, CardReaderAPDU, CardReaderInit, CardReaderPowerOff.

ServiceID

Condicional

String

Identificação de um par de mensagens, que processa uma transação.

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 10

DeviceID

Condicional

String

Identificação de um par de mensagens do dispositivo.

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 10

SaleID

Condicional

String

Identificação de um sistema de venda ou de um terminal para o protocolo Sale to POI.

default MessageHeader.SaleID.

POIID

Condicional

String

Identificação de um sistema de POI ou de um terminal de POI para o protocolo de Sale to POI.

default MessageHeader.POIID.

MessageType

Nome: MessageType

Tipo: Enumeração

  • Request
  • Response
  • Notification

MobileData

Definição: Informações relacionadas ao celular para a transação de pagamento.

Uso: O telefone celular é usado como um instrumento de pagamento para a transação.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

MobileCountryCode

Condicional

DigitString

Identifica o país de uma operadora de celular.

Se houver dados disponíveis.

O comprimento da string deve ser exatamente 3

MobileNetworkCode

Condicional

DigitString

Identifica a operadora de telefonia móvel dentro de um país.

Se houver dados disponíveis.

O comprimento da string deve ser maior ou igual a 2 e menor ou igual a 3

MaskedMSISDN

Condicional

DigitString

Masked Mobile Subscriber integrado com o Service Digital Network.

Se houver dados disponíveis.

Condicional

DEstrutura de dados definida

Localização geográfica especificada por coordenadas geográficas ou UTM.

Se houver dados disponíveis.

ProtectedMobileData

Condicional

ContentInformation

Informações confidenciais relacionadas ao telefone celular, protegidas pelo CMS.

SensitiveMobileData.

Condicional

Estrutura de dados definida

Informações confidenciais relacionadas ao telefone celular.

Se dados móveis não protegidos

OriginalPOITransaction

Definição: Identificação de uma transação POI anterior.

Uso: Na mensagem pagamento ou solicitação de fidelidade, é permitido usar o cartão de uma solicitação CardAcquisition ou Payment/Loyalty anterior.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

SaleID

Condicional

String

Identificação de um sistema de venda ou de um terminal de venda para o protocolo Sale to POI.

 

POIID

Condicional

String

Identificação de um sistema de POI ou de um terminal de POI para o protocolo Saelo to POI.

Se a transação original vier de outro POI.

Condicional

Estrutura de dados definida

Identificação exclusiva de uma transação de POI para um POI.

Ausente se SaleReferenceID for suficiente para identificar a transação.

ReuseCardDataFlag

Condicional

Boolean

Indica se os dados do cartão precisam ser obtidos de uma transação anterior.

 

ApprovalCode

Condicional

String

Código atribuído a uma aprovação de transação pelo Adquirente.

Se referral.

CustomerLanguage

Condicional

ISOLanguage

Idioma do cliente.

Se o idioma for selecionado pelo sistema de vendas antes da solicitação ao POI.

AcquirerID

Condicional

DigitString

Identificação do Adquirente.

Restrinja a este Adquirente, se presente.

AmountValue

Condicional

SimpleAmount

 

 

Condicional

Estrutura de dados definida

Identificação da transação pelo host responsável pela transação de valor armazenado.

Se POITransactionID não estiver presente.

OutputBarcode

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

 

 

BarcodeValue

Requerido

String

 

 

OutputContent

Definição: Conteúdo a ser exibido ou impresso.

Uso: Esta é uma sequência de elementos se eles tiverem formatos diferentes.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Formato do conteúdo a ser exibido ou impresso.

 

Condicional

Estrutura de dados definida

Referência de uma mensagem predefinida para exibição ou impressão.

Obrigatório, se OutputFormat for MessageRef, não será permitido de outra forma.

Matriz Requerida

Estrutura de dados definida

Conteúdo da mensagem de texto a ser exibida ou impressa.

Obrigatório, se OutputFormat for Text, não permitido de outra forma. Uma instância do OutputText por formato compartilhado.

OutputXHTML

Conditional

ByteSequence

Corpo do documento XHTML que contém a mensagem a ser exibida ou impressa.

Obrigatório, se OutputFormat for XHTML, não será permitido de outra forma.

Conditional

Estrutura de dados definida

Conteúdo de código de barras para exibir ou imprimir.

Obrigatório, se OutputFormat for BarCode, não será permitido de outra forma.

OutputFormat

Nome: OutputFormat

Tipo: Enumeração

  • MessageRef
  • Text
  • XHTML
  • BarCode

OutputResult

Definição: Informações relacionadas ao resultado da output (exibição, impressão, entrada).

Uso: Na resposta da mensagem, ele contém o resultado da output, se necessário na solicitação de mensagem.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Dispositivo lógico localizado em um terminal de vendas ou em um terminal de POI, em termos de classe de informações a serem exibidas (exibição, impressão ou armazenamento) ou entrada (teclado) do caixa ou do cliente.

Cópia.

Requerido

Enumeration

Qualificação das informações a serem enviadas para um dispositivo lógico de saída, para exibição ou impressão para o caixa ou cliente.

Cópia.

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

OutputText

Definição: Conteúdo da mensagem de texto a ser exibida ou impressa.

Uso: Transmite informações relacionadas ao conteúdo da mensagem de texto e seu formato. Todos os elementos de dados relacionados ao formato do texto a ser exibido ou impresso são parâmetros válidos para todo o conteúdo do texto.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Text

Requerido

Unicode String

 

 

CharacterSet

Condicional

Integer

 

 

Font

Condicional

String

 

 

StartRow

Condicional

Integer

 

 

StartColumn

Condicional

Integer

 

 

Condicional

Enumeration

 

 

Condicional

Enumeration

 

 

Condicional

Enumeration

 

 

Condicional

Enumeration

 

 

Condicional

Enumeration

 

 

EndOfLineFlag

Condicional

Boolean

 

 

PaymentAccountReq

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

PaymentAccountStatus

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

 

 

CurrentBalance

Condicional

SimpleAmount

 

 

Currency

Condicional

ISOCurrency

 

 

Condicional

Estrutura de dados definida

 

 

PaymentAcquirerData

Definição: Dados relacionados à resposta do Adquirente de pagamento.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

AcquirerID

Condicional

DigitString

Identificação do Adquirente.

Se há vários adquirentes.

MerchantID

Requerido

String

Identificação do comerciante para o adquirente.

 

AcquirerPOIID

Requerido

String

Identificação do POI para o Adquirente de pagamento.

 

Condicional

Estrutura de dados definida

Identificação da transação para o Adquirente.

Se fornecido pelo Adquirente.

ApprovalCode

Condicional

String

Código atribuído a uma aprovação de transação pelo Adquirente.

Se disponível.

HostReconciliationID

Condicional

String

 

 

PaymentData

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

 

 

SplitPaymentFlag

Condicional

Boolean

 

 

RequestedValidityDate

Condicional

ISODate

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

PaymentInstrumentData

Definição: Dados relacionados ao instrumento de pagamento da transação.

Uso: Enviado no resultado da transação de pagamento. Para um cartão, ele também pode ser enviado na resposta CardAcquisition, para ser processado pelo Sistema de Vendas.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Tipo de instrumento de pagamento.

 

ProtectedCardData

Condicional

ContentInformation

 

 

Condicional

Estrutura de dados definida

Informações relacionadas ao cartão de pagamento usado para a transação.

Se PaymentInstrumentType for 'Card' (cartão).

Condicional

Estrutura de dados definida

Informações relacionadas ao cheque usado para a transação.

Se PaymentInstrumentType é 'Check' (cheque).

Condicional

Estrutura de dados definida

Informações relacionadas ao celular para a transação de pagamento.

Se PaymentInstrumentType é 'Mobile'.

Condicional

Estrutura de dados definida

 

 

PaymentInstrumentType

Nome: PaymentInstrumentType

Tipo: Enumeração

  • Card
  • Check
  • Mobile
  • StoredValue
  • Cash

PaymentReceipt

Definição: Recibo de pagamento do cliente ou comerciante.

Uso: Se os recibos de pagamento forem impressos pelo sistema de vendas e o POI ou Sale não implementou a troca de impressões (perfil básico).

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Qualificação do documento a ser impresso para o caixa ou cliente.

SaleReceipt or CashierReceipt.

IntegratedPrintFlag

Condicional

Boolean

Tipo de impressão integrado a outras impressões.

 

RequiredSignatureFlag

Condicional

Boolean

Indica que o recibo de pagamento do titular do cartão requer uma assinatura física do Cliente.

 

Required

Estrutura de dados definida

Conteúdo a ser exibido ou impresso.

 

PaymentRequest

Definição: Conteúdo da mensagem de solicitação de pagamento.

Uso: Transmite informações relacionadas à transação de pagamento a serem processadas.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Dados relacionados ao sistema de vendas.

 

Requerido

Estrutura de dados definida

Dados relacionados à transação de pagamento e fidelidade.

 

Condicional

Estrutura de dados definida

Dados relacionados à transação de pagamento.

Se um elemento de dados estiver presente.

Matriz Requerida

Estrutura de dados definida

Dados relacionados a um programa ou conta de fidelidade.

Cartões de fidelidade usados na transação de pagamento e lidos pelo sistema de vendas.

PaymentResponse

Definição: Conteúdo da mensagem de resposta de pagamento.

Uso: Transmite informações relacionadas à transação de pagamento processada pelo sistema de POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Requerido

Estrutura de dados definida

Dados relacionados ao sistema de vendas.

Cópia.

Requerido

Estrutura de dados definida

Dados relacionados ao sistema POI.

 

Condicional

Estrutura de dados definida

Dados relacionados ao resultado de uma transação de pagamento processada.

Se um elemento de dados estiver presente.

Matriz Requerida

Estrutura de dados definida

Dados relacionados ao resultado de uma transação de lealdade processada.

Cartões de fidelidade usados na transação de pagamento.

Matriz Requerida

Estrutura de dados definida

 

 

Matriz Requerida

Estrutura de dados definida

 

 

PaymentResult

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

Informações relacionadas a uma transação parcelada. Solicitar uma parcela ao emissor ou efetuar parcelas individuais de uma transação de pagamento.

 

Condicional

Estrutura de dados definida

Informações relacionadas a uma conversão de moeda. Ocorreu uma conversão de moeda no pagamento, e o comerciante precisa conhecer as informações relacionadas a essa conversão (por exemplo, para imprimir no recibo da venda).

 

MerchantOverrideFlag

Condicional

Boolean

Indica que o comerciante forçou o resultado do pagamento com êxito. Permite que o sistema de vendas tenha certeza de que o pagamento foi forçado.

 

Condicional

Estrutura de dados definida

Valor numérico de uma assinatura manuscrita. Contenha o valor de uma assinatura manuscrita, por exemplo, a assinatura de um titular de cartão no recibo de pagamento do comerciante. Somente um formato da assinatura é permitido, ele contém: O tamanho da área do bloco em que a assinatura é gravada, fornecida com os valores máximos de abscissa e ordenada. A sequência de coordenadas em que a caneta muda de direção ou de elevação.

 

ProtectedSignature

Condicional

ContentInformation

Valor numérico de uma assinatura manuscrita. Contenha o valor de uma assinatura manuscrita, por exemplo, a assinatura de um titular de cartão no recibo de pagamento do comerciante. O formato antes da criptografia é a estrutura de dados codificados CapturedSignature. A estrutura de dados antes da criptografia inclui as tags de início e fim de uma codificação XML, o identificador e o comprimento de bytes para uma codificação ASN.1 e o membro completo ProtectedSignature para uma codificação JSON.

 

CustomerLanguage

Condicional

ISOLanguage

Idioma do cliente. Permite a escolha do idioma do cliente quando o POI exibe mensagens ou imprime texto na interface do comerciante.

 

OnlineFlag

Condicional

Boolean

Indique que o processamento da transação de pagamento exigiu a aprovação de um host. Permite que o sistema de vendas saiba se o pagamento foi online ou offline.

 

Condicional

Cluster

Método para autenticação do cliente. Permite que o sistema de vendas seja informado sobre a autenticação do cliente para a transação de pagamento.

 

ValidityDate

Condicional

ISODate

 

 

Condicional

Estrutura de dados definida

 

 

PaymentToken

Definição: Substituto do PAN (Primary Account Number) do cartão de pagamento para
identificar o meio de pagamento do cliente. Permite, para um comerciante, identificar
o cliente.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Tipo de token que substitui o PAN de um cartão de pagamento para identificar o meio de pagamento do cliente. Ele permite que um comerciante use um token apenas para uma transação ou por um período mais longo..

 

TokenValue

Requerido

String

Token de pagamento que substitui o PAN do cartão de pagamento para identificar o meio de pagamento do cliente.

 

ExpiryDateTime

Condicional

ISODateTime

Data e hora de vencimento. Limita a validade de um token de pagamento.

 

PaymentTotals

Definição: Totals Totais da transação de pagamento durante o período de reconciliação.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Tipo de transação para a qual os totals estão agrupados.

Débito, Crédito, ReverseDebit, ReverseCredit, OneTimeReservation, CompletedDeffered, FirstReservation, UpdateReservation, CompletedReservation, CashAdvance.

TransactionCount

Requerido

Integer

Número de transações processadas durante o período.

 

TransactionAmount

Requerido

SimpleAmount

Soma do valor da transação processada durante o período.

 

PaymentTransaction

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Vários valores relacionados à solicitação de pagamento e programa de fidelidade do sistema de vendas.

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Matriz Requerida

Estrutura de dados definida

 

 

PaymentType

Nome: PaymentType

Tipo: Enumeração

  • Normal
  • Refund
  • OneTimeReservation
  • FirstReservation
  • UpdateReservation
  • Completion
  • CashAdvance
  • CashDeposit
  • Recurring
  • Instalment
  • IssuerInstalment
  • PaidOut

PeriodUnit

Nome: PeriodUnit

Tipo: Enumeração

  • Daily
  • Weekly
  • Monthly
  • Annual

POICapabilities

Nome: POICapabilities

Tipo: Cluster

  • CashierDisplay
  • CashierError
  • CashierInput
  • CustomerDisplay
  • CustomerError
  • CustomerInput
  • PrinterReceipt
  • PrinterDocument
  • PrinterVoucher
  • MagStripe
  • ICC
  • EMVContactless
  • CashHandling

POIData

Definição: Dados relacionados ao sistema POI.

Uso: Na resposta da mensagem, identificação da transação do POI.on.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requeridos

Estrutura de dados definida

Identificação exclusiva de uma transação de POI para um POI.

 

POIReconciliationID

Condicional

DigitString

Identificação do período de reconciliação entre venda e POI.

Se Resultado for Sucess.

Point

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

X

Requerido

HexString

 

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 4

Y

Requerido

HexString

 

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 4

POIProfile

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

 

 

Condicional

Cluster

 

 

POISoftware

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

ManufacturerID

Requerido

String

 

 

ApplicationName

Requerido

String

 

 

SoftwareVersion

Requerido

String

 

 

CertificationCode

Requerido

String

 

 

POIStatus

Definição: Estado de um terminal POI.

Uso: Indique a disponibilidade dos componentes do terminal POI. O elemento de dados está ausente se o componente não fizer parte do terminal POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Status global de um servidor ou terminal de POI.

 

SecurityOKFlag

Condicional

Boolean

Indica se o módulo de segurança do POI está funcionando e é utilizável.

Se houver módulo de segurança.

PEDOKFlag

Condicional

Boolean

Indica se o PED está funcionando e é utilizável.

Se PED é presente.

CardReaderOKFlag

Condicional

Boolean

Indica se os leitores de cartão estão funcionando e são utilizáveis.

Se houver um dispositivo leitor de cartão.

Condicional

Enumeration

 

 

CommunicationOKFlag

Condicional

Boolean

Indica se a infraestrutura de comunicação está funcionando e utilizável.

Se houver infra-estrutura de comunicação.

Matriz Condicional

Estrutura de dados definida

Status do dispositivo de manuseio de dinheiro.

Se houver dispositivos de manuseio de dinheiro..

FraudPreventionFlag

Condicional

Boolean

Indica uma suspeita de fraude pelo sistema POI.

padrão False.

POISystemData

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

DateTime

Requerido

ISODateTime

 

 

Requerido

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

POITerminalData

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

 

 

Requerido

Cluster

 

 

Condicional

Estrutura de dados definida

 

 

POISerialNumber

Requerido

String

 

 

PredefinedContent

Definição: Referência de uma mensagem predefinida para exibição ou impressão.

Uso: Transmite informações relacionadas à mensagem predefinida.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Identificação de uma mensagem predefinida para exibir ou imprimir.

 

Language

Condicional

ISOLanguage

Identificação de um idioma.

 

PrinterStatus

Nome: PrinterStatus

Tipo: Enumeração

  • OK
  • PaperLow
  • NoPaper
  • PaperJam
  • OutOfOrder

Rebates

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

TotalRebate

Condicional

SimpleAmount

 

 

RebateLabel

Condicional

String

 

 

Matriz Requerida

Estrutura de dados definida

 

 

ReconciliationRequest

Definição: Conteúdo da mensagem de solicitação de reconciliação.

Uso: Transmite informações relacionadas à reconciliação solicitadas pelo sistema de vendas.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Tipo de reconciliação solicitada pela venda ao POI.

 

AcquirerID

Matriz Requerida

DigitString

Identificação do Adquirente.

Pode estar presente apenas se ReconciliationType for 'AcquirerReconciliation' ou 'AcquirerSynchronisation'.

POIReconciliationID

Condicional

DigitString

Identificação do período de reconciliação entre Venda e POI.

Ausente se ReconciliationType não for 'PreviousReconciliation'.

ReconciliationResponse

Definição: Conteúdo da mensagem de resposta de reconciliação.

Uso: Transmite informações relacionadas à transação de reconciliação processada pelo sistema POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Requerido

Enumeration

Tipo de reconciliação solicitada pela venda ao POI.

Copy.

POIReconciliationID

Condicional

DigitString

Identificação do período de reconciliação entre Venda e POI.

Ausente se ReconciliationType for 'AcquirerReconciliation'.

Matriz Requerida

Estrutura de dados definida

Resultado do processo de reconciliação de venda para POI.

se Response.Result for Success.

ReconciliationType

Nome: ReconciliationType

Tipo: Enumeração

  • SaleReconciliation
  • AcquirerSynchronisation
  • AcquirerReconciliation
  • PreviousReconciliation

ReferenceID

Nome: ReferenceID

Tipo: Enumeração

  • Accepted: Mostra uma tela 'Approved' sem uma animação "OK".
  • AcceptedAnimated: Mostra a tela 'Approved' regular.
  • AcceptedCustom: Mostra uma tela 'Approved' com uma animação personalizada.
  • Declined: Mostra uma tela 'Declined' sem uma animação "X".
  • DeclinedAnimated: Mostra a tela 'Declined' regular.
  • Custom: Não mostra nenhuma animação e usa a cor de fundo padrão.

RepeatedMessageResponse

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

 

 

Requerido

Estrutura de dados definida

 

 

RepeatedResponseMessageBody

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Condicional

Estrutura de dados definida

 

 

Response

Definição: Resultado de um processamento de solicitação de mensagem.

Uso: Se resultado for bem-sucedido, ErrorCondition está ausente ou não é usado no processamento da mensagem. Nos outros casos, a ErrorCondition deve estar presente e pode refinar o processamento da resposta da mensagem. O AdditionalResponse fornece mais informações sobre o sucesso ou a falha do processamento da solicitação de mensagens, para registro sem envolvimento em tempo real.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Resultado do processamento da mensagem.

 

Condicional

Enumeration

Condição que produziu um erro no processamento de uma solicitação de mensagem.

Se o resultado não for um sucesso.

AdditionalResponse

Condicional

String

Informações adicionais relacionadas ao status de processamento de uma solicitação de mensagem.

Se presente, o POI registra-o para um exame mais aprofundado.

Result

Nome: Result

Tipo: Enumeração

  • Success
  • Failure
  • Partial

ReversalReason

Nome: ReversalReason

Tipo: Enumeração

  • CustCancel
  • MerchantCancel
  • Malfunction
  • Unable2Compl

ReversalRequest

Definição: Conteúdo da mensagem de solicitação de reversão.

Uso: Transmite informações relacionadas à reversão de um pagamento anterior ou de uma transação de fidelidade.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

 

 

Requerido

Estrutura de dados definida

Identificação de uma transação POI anterior.

 

ReversedAmount

Condicional

SimpleAmount

Valor do pagamento ou lealdade a reverter.

ReversedAmount é implicitamente o AuthorizedAmount se ausente.

Requerido

Enumeration

Razão do estorno do pagamento ou da lealdade.

 

Condicional

Estrutura de dados definida

 

 

ReversalResponse

Definição: Conteúdo da mensagem de resposta de reversão.

Uso: Transmite informações relacionadas à reversão processada pelo sistema POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Condicional

Estrutura de dados definida

Dados relacionados ao sistema POI.

Se Resultado for Sucesso.

Condicional

Estrutura de dados definida

 

 

ReversedAmount

Condicional

SimpleAmount

Valor do pagamento ou fidelidade a reverter.

Cópia.

Matriz Requerida

Estrutura de dados definida

 

 

Matriz Requerida

Estrutura de dados definida

 

 

SaleCapabilities

Nome: SaleCapabilities

Tipo: Cluster

  • CashierStatus
  • CashierError
  • CashierDisplay
  • POIReplication
  • CashierInput
  • CustomerAssistance
  • CustomerDisplay
  • CustomerError
  • CustomerInput
  • PrinterReceipt
  • PrinterDocument
  • PrinterVoucher
  • MagStripe
  • ICC
  • EMVContactless

SaleData

Definição: Dados relacionados ao sistema de vendas.

Uso: Dados associados ao sistema de venda, com um valor específico durante o processamento do pagamento pelo POI, incluindo a aquisição de cartões.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

OperatorID

Condicional

String

 

 

OperatorLanguage

Condicional

ISOLanguage

Idioma do caixa ou operador.

se diferente do Login.

ShiftNumber

Condicional

String

Número do turno.

Se for diferente do Login e consulte Login .SaleData.

Requerido

Estrutura de dados definida

Identificação exclusiva de uma transação de venda.

 

SaleReferenceID

Condicional

String

Identificação de uma transação global de venda para uma sequência de transações de POI relacionadas.

Se reserva de pagamento.

Condicional

Estrutura de dados definida

Informações relacionadas ao recurso de software e hardware do Terminal de vendas.

Se o conteúdo não estiver vazio

Condicional

Enumeration

Tipo de token que substitui o PAN de um cartão de pagamento para identificar o meio de pagamento do cliente. Ele permite que um comerciante use um token apenas para uma transação ou por um período mais longo.

 

CustomerOrderID

c

String

Identificação adicional e opcional de um pedido do cliente.

 

Condicional

Cluster

Lista de pedidos do cliente abertos, fechados ou ambos a serem enviados nas mensagens de resposta.

 

SaleToPOIData

Condicional

String

SInformações de venda destinadas ao POI.

Armazenado com a transação.

SaleToAcquirerData

Condicional

String

Informações de venda destinadas ao Adquirente.

Envie ao Adquirente, se presente.

Condicional

Estrutura de dados definida

Informações de venda destinadas ao emissor.

Envie ao Adquirente, se presente.

SaleItem

Definition: Itens de venda de uma transação.

Usage: Na transação de fidelidade ou cartão de pagamento com valor agregado, os itens da venda entram no processamento da transação.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

ItemID

Requerido

Integer

Identificação do item dentro de uma transação (0 a n).

 

ProductCode

Requerido

DigitString

Código do produto do item adquirido com a transação.

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 20.

EanUpc

Condicional

DigitString

Código padrão do produto do item adquirido com a transação.

Se os dados forem enviados, o POI deve armazená-los e enviá-los se o protocolo do host permitir.

Condicional

Enumeration

Unidade de medida de uma quantidade.

Se Quantity é presente.

Quantity

Condicional

Decimal

Quantidade de produto.

Se os dados forem enviados, o POI deve armazená-los e enviá-los se o protocolo do host permitir.

UnitPrice

Condicional

SimpleAmount

Preço por unidade de produto.

Se Quantity é presente.

ItemAmount

Requerido

SimpleAmount

Valor total da linha do item

 

TaxCode

Condicional

DigitString

Tipo de impostos associados ao item de linha.

Se os dados forem enviados, o POI deve armazená-los e enviá-los se o protocolo do host permitir.

SaleChannel

Condicional

DigitString

Canal comercial ou de distribuição associado ao item de linha.

Se os dados forem enviados, o POI deve armazená-los e enviá-los se o protocolo do host permitir.

ProductLabel

Condicional

String

 

 

AdditionalProductInfo

Condicional

String

Informações adicionais relacionadas ao item de linha.

Se os dados forem enviados, o POI deve armazená-los e enviá-los se o protocolo do host permitir.

SaleItemRebate

Definição: O valor concedido que é anexado a um item como um reembolso.

Uso: Ser diferente do award which que é o valor ou a quantidade conquistada na conta de fidelidade.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

ItemID

Requerdio

Integer

Identificação do item dentro de uma transação (0 a n).

 

ProductCode

Requerido

DigitString

Código do produto do item adquirido com a transação.

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 20

EanUpc

Condicional

DigitString

 

 

Condicional

Enumeration

Unidade de medida de uma quantidade.

Se Quantity é presente.

Quantity

Condicional

Decimal

Quantidade de produto.

se o desconto for unidades adicionais.

ItemAmount

Condicional

SimpleAmount

Valor total da linha do item.

se reembolso no valor do item de linha.

RebateLabel

Condicional

String

Texto breve para qualificar um desconto em um item de linha.

Se fornecido pelo Adquirente.

SaleProfile

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

 

 

Condicional

Cluster

 

 

SaleSoftware

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

ManufacturerID

Requerido

String

 

 

ApplicationName

Requerido

String

 

 

SoftwareVersion

Requerido

String

 

 

CertificationCode

Requerido

String

 

 

SaleTerminalData

Definição: Informações relacionadas ao recurso de software e hardware do Terminal de Vendas.

Uso: Na Solicitação de Login, se um terminal de vendas estiver envolvido no login. Em outras mensagens, quando um dispositivo lógico está com defeito (SaleCapabilites) ou quando os outros dados foram alterados desde ou não estavam no Login.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Enumeration

Ambiente do Terminal.

 

Condicional

Cluster

Recursos de hardware do Terminal de Vendas.

 

Condicional

Estrutura de dados definida

Perfil funcional do terminal de vendas.

Se pelo menos um elemento estiver presente.

TotalsGroupID

Condicional

String

Identificação de um grupo de transações em um terminal de POI, com os mesmos recursos de venda.

Se presente, valor padrão para todas as transações.

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 16

SaleToIssuerData

Definição: Informações de venda destinadas ao emissor.

Uso: O Sistema POI recebe essas informações e as envia ao Adquirente para o Emissor sem nenhuma alteração.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

StatementReference

Condicional

String

R'ltulo para imprimir no extrato bancário.

Informações para imprimir no extrato bancário.

SecurityTrailer

Definição: SecurityTrailer, usado pela Adyen.

Uso: Ele contém informações relacionadas à segurança da mensagem.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

AdyenCryptoVersion

Requerido

Integer

 

 

KeyIdentifier

Requerido

String

 

 

KeyVersion

Requerido

Integer

 

 

Nonce

Requerido

ByteSequence

 

 

Hmac

Requerido

ByteSequence

 

 

SensitiveCardData

Definição: Informações confidenciais relacionadas ao cartão de pagamento, inseridas ou lidas
pelo sistema de vendas.

Uso: Essa estrutura de dados pode ser protegida por CMS (EnvelopedData). Nesse caso, a estrutura de dados
SensitiveCardData é substituída pela estrutura de dados ProtectedCardData do tipo
ContentInformationType.
Quando esses dados são protegidos, o conteúdo exato é desconhecido pelo sistema de vendas e pode incluir
todas as informações exigidas por um servidor POI de backup externo para fazer uma
transação de pagamento em lote em caso de problemas com o sistema POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

PAN

Condicional

DigitString

Número da conta principal.

 

O comprimento da string deve ser maior ou igual a 8 e menor ou igual a 28

CardSeqNumb

Condicional

DigitString

Número de sequência do cartão.

Se EntryMode for Arquivo, Chave ou Manual.

O comprimento da string deve ser maior ou igual a 2 e menor ou igual a 3

ExpiryDate

Condicional

DigitString

Data após a qual o cartão não pode ser usado.

Se EntryMode for File.

O comprimento da string deve ser exatamente 4

Matriz Condicional

Estrutura de dados definida

Faixa magnética ou linha de caracteres de tinta magnética.

Se EntryMode for MagStripe ou RFID.

SensitiveMobileData

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

MSISDN

Requerido

DigitString

 

 

ISMI

Condicional

DigitString

 

 

IMEI

Condicional

DigitString

 

 

ServiceProfiles

Nome: ServiceProfiles

Tipo: Cluster

  • Synchro
  • Batch
  • OneTimeRes
  • Reservation
  • Loyalty
  • StoredValue
  • PIN
  • CardReader
  • Sound
  • Communication

ServicesEnabled

Nome: ServicesEnabled

Tipo: Cluster

  • CardAcquisition
  • Payment
  • Loyalty

StoredValueAccountID

Definição: Identificação da conta do valor armazenado ou do cartão de valor armazenado.

Uso: Contém as identificações da conta de valor armazenado ou do cartão de valor armazenado e o produto associado vendido pelo sistema de venda para solicitações de valor armazenado.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

 

 

StoredValueProvider

Condicional

String

 

 

OwnerName

Condicional

String

 

 

ExpiryDate

Condicional

DigitString

 

 

O comprimento da string deve ser exatamente 4

Requerido

Cluster

 

 

Requerido

Enumeration

 

 

StoredValueID

Requerido

String

 

 

StoredValueAccountStatus

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

 

 

CurrentBalance

Condicional

SimpleAmount

 

Se relevante e conhecido.

StoredValueAccountType

Nome: StoredValueAccountType

Tipo: Enumeração

  • GiftCard
  • PhoneCard
  • Other

StoredValueData

Definição: Dados relacionados ao cartão de valor armazenado.

Usage: Contém a identificação das contas de valor armazenado ou dos cartões de valor armazenado, se fornecidos pelo sistema de venda, e os produtos associados vendidos pelo sistema de senda.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

StoredValueProvider

Condicional

String

Identificação do provedor da conta de valor armazenado load/reload.

Se houver mais de um provedor para gerenciar no POI e StoredValueAccountID ausente.

Requerido

Enumeration

Identification of operation to proceed on the stored value account or the stored value card.

 

Condicional

Estrutura de dados definida

Identificação da conta do valor armazenado ou do cartão de valor armazenado.

Se a identificação da conta ou cartão do valor armazenado tiver sido feita pelo Sistema de Venda antes da solicitação.

Condicional

Estrutura de dados definida

Identificação de uma transação POI anterior.

Se StoredValueTransactionType for Reverse ou Duplicate.

ProductCode

Condicional

DigitString

Código do produto do item adquirido com a transação.

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 20

EanUpc

Condicional

DigitString

Código padrão do produto do item adquirido com a transação.

 

ItemAmount

Condicional

SimpleAmount

Valor total da linha do item.

 

Currency

Condicional

ISOCurrency

Moeda de um valor monetário.

 

StoredValueRequest

Definição: Conteúdo da mensagem Stored Value Request.

Uso: Transmite as informações relacionadas à transação do valor armazenado para processar.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Dados relacionados ao sistema de vendas.

 

CustomerLanguage

Condicional

ISOLanguage

Idioma do cliente.

Se o idioma for selecionado pelo sistema de vendas antes da solicitação ao POI.

Matriz Requerida

Estrutura de dados definida

Dados relacionados ao cartão de valor armazenado.

 

StoredValueResponse

Definição: Conteúdo da mensagem Value Response.

Uso: Transmite informações relacionadas à transação de valor armazenado processada pelo sistema POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Requerido

Estrutura de dados definida

Dados relacionados ao sistema de vendas.

 

Requerido

Estrutura de dados definida

Dados relacionados ao sistema POI.

 

Matriz Requerida

Estrutura de dados definida

Resultado do carregamento / recarregamento de um cartão de valor armazenado.

Se StoredValueResponse.Result for 'Success' ou 'Partial', uma entrada por StoredValueRequest.StoredValueData carregada ou ativada.

Matriz Requerida

Estrutura de dados definida

 

 

StoredValueResult

Definição: Resultado do carregamento/recarregamento de um cartão de valor armazenado.

Uso: Para cada cartão de valor armazenado carregado ou recarregado, na mensagem de resposta StoredValue.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descriçãso Regra

Requerido

Enumeration

Identificação da operação para prosseguir na conta de valor armazenado ou no cartão de valor armazenado.

Cópia.

ProductCode

Condicional

DigitString

Código do produto do item adquirido com a transação.

Cópi.

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 20

EanUpc

Condicional

DigitString

Código padrão do produto do item adquirido com a transação.

Cópia.

ItemAmount

Condicional

SimpleAmount

Valor total da linha do item.

 

Currency

Condicional

ISOCurrency

Moeda de um valor monetário.

Cópia.

Condicional

Estrutura de dados definida

Dados relacionados ao resultado da transação do cartão de valor armazenado.

 

Condicional

Estrutura de dados definida

Identificação da transação pelo host responsável pela transação de valor armazenado.

Se fornecido pelo host.

StoredValueTransactionType

Nome: StoredValueTransactionType

Tipo: Enumeração

  • Reserve
  • Activate
  • Load
  • Unload
  • Reverse
  • Duplicate

TerminalEnvironment

Nome: TerminalEnvironment

Tipo: Enumeração

  • Attended
  • SemiAttended
  • Unattended

TokenRequestedType

Nome: TokenRequestedType

Tipo: Enumeração

  • Transaction
  • Customer

TotalDetails

Nome: TotalDetails

Tipo: Enumeração

  • POIID
  • SaleID
  • OperatorID
  • ShiftNumber
  • TotalsGroupID

TotalFilter

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descriçãso Regra

POIID

Condicional

String

 

 

SaleID

Condicional

String

 

 

OperatorID

Condicional

String

 

 

ShiftNumber

Condicional

String

 

 

TotalsGroupID

Condicional

String

 

 

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 16

TrackData

Definição: Faixa magnética ou linha de caracteres de tinta magnética..

Uso: Estrutura de dados genérica para uma faixa de cartão, usada quando o
leitor de cartão de tarja magnética está localizado no terminal de venda ou para solicitação de dispositivo de leitor de cartão de tarja magnética.
A estrutura de dados também é usada para armazenar a linha na parte inferior de um cheque bancário.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descriçãso Regra

TrackNumb

Condicional

Integer

 

 

Condicional

Enumeration

 

 

TrackValue

Requeridos

String

 

 

O comprimento da cadeia deve ser maior ou igual a 1 e menor ou igual a 104

TrackFormat

Nome: TrackFormat

Tipo: Enumeração

  • ISO
  • JIS-I
  • JIS-II
  • AAMVA
  • CMC-7
  • E-13B

TransactionAction

Nome: TransactionAction

Tipo: Enumeração

  • StartTransaction
  • AbortTransaction

TransactionConditions

Definição: Condições nas quais a transação deve ser processada.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

AllowedPaymentBrand

Matriz Requerida

String

Bandeira des cartão permitidas pelo sistema de venda para a transação de pagamento.

Restrinja a bandeira se os dados forem enviados.

AcquirerID

Matriz Requerida

DigitString

Identificação do Adquirente.

Restrinja a este Adquirente, se presente.

DebitPreferredFlag

Condicional

Boolean

O tipo de pagamento preferido é uma transação de débito e não uma transação de crédito.

O tipo de pagamento preferido é uma transação de débito e não uma transação de crédito

AllowedLoyaltyBrand

Matriz Requerida

String

Marcas ou programas de fidelidade permitidos pelo sistema de venda para a transação de fidelidade.

Restrinja a bandeira se os dados forem enviados.

Condicional

Enumeration

Tipo de processamento de programa fidelidade solicitado pelo sistema de vendas

 

CustomerLanguage

Condicional

ISOLanguage

Idioma do cliente.

Se o idioma for selecionado pelo sistema de vendas antes da solicitação ao POI.

ForceOnlineFlag

Condicional

Boolean

Indica se o caixa exige o POI force o acesso on-line ao Adquirente.

Fique online se os dados forem enviados.

Condicional

Cluster

Modo de entrada do instrumento de pagamento solicitado pelo sistema de vendas.

Restrinja o modo de entrada se enviado.

MerchantCategoryCode

Condicional

String

O código que identifica a categoria da transação (MCC).

O pagamento implica uma MCC específica.

O comprimento da sequência deve ser maior ou igual a 3 e menor ou igual a 4

TransactionIDType

Definição: Identificação de uma transação para o sistema de vendas ou o sistema de POI.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

TransactionID

Requerido

String

Unique Identificação exclusiva de uma transação. Para identificar a transação no sistema de vendas (por exemplo, número do bilhete) ou no sistema de POI.

 

TimeStamp

Requerido

ISODateTime

Data e hora de uma transação para o sistema de vendas, o sistema de POI ou o adquirente. Garante a exclusividade de uma transação e indica a hora em que o evento ocorre na mensagem EventNotification.

 

TransactionStatusRequest

Definição: Conteúdo da mensagem de solicitação TransactionStatus.

Uso: Este transmite as informações solicitadas para o status da última ou atual transação de pagamento, fidelidade ou estorno.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Condicional

Estrutura de dados definida

Identificação de uma transação POI anterior.

Presente se contiver algum dado.

ReceiptReprintFlag

Condicional

Boolean

Pedido para reimprimir os recibos de POI.

 

Matriz Condicional

Enumeration

 

 

TransactionStatusResponse

Definição: Conteúdo da mensagem de resposta do TransactionStatus.

Uso: Transmite informações relacionadas ao status da última ou atual transação de pagamento, fidelidade ou estorno.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Estrutura de dados definida

Resultado de um processamento de solicitação de mensagem.

 

Condicional

Estrutura de dados definida

Identificação de uma transação POI anterior.

se Response.Result for Success.

Conditional

Estrutura de dados definida

Conteúdo da resposta da mensagem solicitada.

Se o resultado for sucesso (processo concluído).

TransactionTotals

Definição: Resultado do processamento de reconciliação de venda para POI.

Uso: Se resultado for bem-sucedido, contém todos os totals, classificados conforme exigido por Sale na solicitação de mensagem. Finalmente, os totais da transação são fornecidos por adquirente, liquidação do adquirente e bandeira do cartão.

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

Requerido

Enumeration

Tipo de instrumento de pagamento.

 

AcquirerID

Condicional

DigitString

Identificação do Adquirente

Se disponível.

HostReconciliationID

Condicional

String

Identificador de um período de reconciliação com um host de pagamento ou fidelidade.

Se disponível.

CardBrand

Condicional

String

Tipo de pagamento ou cartão fidelidade.

Se configurado para apresentar totals por marca de cartão, e Response.Result for Success.

POIID

Condicional

String

Identificação de um sistema de POI ou de um terminal de POI para o protocolo de venda para POI.

Se solicitado na solicitação de mensagem.

SaleID

Condicional

String

Identificação de um sistema de venda ou de um terminal de venda para o protocolo Sale to POI.

Se solicitado na solicitação de mensagem.

OperatorID

Condicional

String

Identificação do caixa ou operador.

Se solicitado na solicitação de mensagem..

ShiftNumber

Condicional

String

Número do turno.

Se solicitado na solicitação de mensagem

TotalsGroupID

Condicional

String

Identificação de um grupo de transações em um terminal de POI, com os mesmos recursos de venda.

Se solicitado na solicitação de mensagem.

O comprimento da string deve ser maior ou igual a 1 e menor ou igual a 16

PaymentCurrency

Condicional

ISOCurrency

Moeda de um valor monetário..

 

Matriz Condicinal

Estrutura de dados definida

Totals da transação de pagamento durante o período de reconciliação.

Se TransactionCount e TransactionAmount não forem iguais a zero.

Condicional

Enumeration

Unidade de um valor de lealdade.

 

LoyaltyCurrency

Condicional

ISOCurrency

Moeda de um valor monetário.

Se LoyaltyUnit for Monetário.

Matriz Condicional

Estrutura de dados definida

Totais da transação de fidelidade durante o período de reconciliação.

Se TransactionCount e TransactionAmount não forem iguais a zero.

TransactionType

Nome: TransactionType

Tipo: Enumeração

  • Debit
  • Credit
  • ReverseDebit
  • ReverseCredit
  • OneTimeReservation
  • CompletedDeffered
  • FirstReservation
  • UpdateReservation
  • CompletedReservation
  • CashAdvance
  • IssuerInstalment
  • Declined
  • Failed
  • Award
  • ReverseAward
  • Redemption
  • ReverseRedemption
  • Rebate
  • ReverseRebate

TypeCode

Nome: TypeCode

Tipo: Enumeração

  • Personal
  • Company

UnitOfMeasure

Nome: UnitOfMeasure

Tipo: Enumeração

  • Case
  • Foot
  • UKGallon
  • USGallon
  • Gram
  • Inch
  • Kilogram
  • Pound
  • Meter
  • Centimetre
  • Litre
  • Centilitre
  • Ounce
  • Quart
  • Pint
  • Mile
  • Kilometre
  • Yard
  • Other

UTMCoordinates

Tipo: Estrutura de dados definida

Componente Requerimento Tipo Descrição Regra

UTMZone

Requerido

String

 

 

UTMEastward

Requerido

String

 

 

UTMNorthward

Requerido

String