2. A API
A API para consultar transações retorna uma quantidade padrão de 500 transações (configurável através de parâmetros na chamada para quantidade até 500 transações). Portanto, durante a extração de transações é necessário verificar o campo UpdateTimestamp, que indica o horário de atualização de cada transação. A cada consulta, será necessário obter o UpdateTimestamp da transação mais recente e utiliza-lo como filtro para a próxima consulta.
Em caso de transações pendentes, elas se apresentarão para consulta mesmo que ainda pendente e quando forem capturadas serão reapresentadas em consultas posteriores, com o status atualizado. Portanto, é importante identificar o UniqueId de cada transação e a cada aparição nas consultas, elas deverão ser atualizadas na base que fez a consulta. Em casos de transações de cancelamento, como são de fato novas transações, elas possuem seus próprios UniqueIds, mas possuem um campo adicional: OriginalTransactionId, referenciando a transação original de venda. Ex: é feita a primeira consulta e o UpdateTimestamp mais recente é 2019-05-23 14:03:39.000. A próxima consulta deverá ter o filtro "UpdateTimestamp": "2019-05-23 14:03:39.000", retornando as transações atualizadas a partir deste horário.
IMPORTANTE
A API também permite consultar através de outros filtros, conforme exemplos abaixo.
| Campo | Descrição | Tipo |
|---|---|---|
| AffiliationCompanyDataDisplayName | Nome da afiliação | Texto |
| AffiliationCompanyDataTaxId | CPF/CNPJ do dono da afiliação | Texto |
| AffiliationNumber | Código da afiliação junto ao adquirente | Texto |
| Amount | Valor da transação em centavos | Inteiro |
| AuthorizerCode | Código do autorizador | Texto |
| AuthorizerExternalReference | NSU ou código interno da transação | Texto |
| AuthorizerName | Nome do autorizador | Texto |
| CardBIN | BIN do cartão de crédito utilizado na transação | Texto |
| CardDataCardHolderName | Nome do portador impresso no cartão | Texto |
| CardDataCardName | Nome da bandeira do cartão retornado pelo autorizador | Texto |
| CardDataExpirationDate | Validade do cartão em formato AAMM(ex: 2602 = Fevereiro/2026) | Texto |
| CardDataMaskedCardNumber | Número do cartão de crédito, com máscara. Alguns adquirentes retornam o BIN (6 primeiros dígitos) outros retornam apenas os 4 últimos | Texto |
| CardDataType | Tipo de cartão: 01 Crédito 02 Débito 04 Voucher 08 Private Label 16 Frota 128 Outros | Inteiro |
| CardEntryMode | Tipo de entrada do cartão: 1- Digitado 2- Tarja Magnética 4- Chip com contato 8- Chip sem contato 16- Fallback de chip de tarja 32- Chip sem contato simulando tarja 64- Chip sem contato EMV 128- Transação necessita de fallback 256- Fallback de tarja para digitado | Inteiro |
| CardHolderVerificationFlags | Tipos de autenticação do portador. Este campo é um mapa de Bits, isso quer dizer que uma transação pode ter mais do que uma autenticação e o resultado será a soma das entradas listadas abaixo. 1- Assinatura do portador requerida 2- Senha do portador verifica off-line 4- Senha offline do portador foi bloqueada na última apresentação inválida 8- Senha do portador capturada para verificação online | Inteiro |
| CardNumberMaskDefault | Número do cartão (truncado) | Texto |
| DefaultCardName | Nome da bandeira do cartão padronizado pela PayGo | Texto |
| FinancingDataInstallmentsNumber | Quantidade de parcelas | Inteiro |
| FinancingDataType | Tipo de financiamento 01 À Vista 02 Parcelado Emissor 03 Parcelado Estabelecimento 04 Pré Datado | Inteiro |
| FullReceiptCopy | Recibo retornado pelo adquirente | Texto |
| InternalLocalReference | Número único da transação no sistema Muxx por afiliação | Texto |
| POSCompanyDataDisplayName | Nome do dono do terminal (Nome impresso no recibo caso seja um sub-adquirente) | Texto |
| POSCompanyDataTaxId | CPF/CNPJ do dono do terminal | Texto |
| POSDataDescription | Nome do ponto de captura | Texto |
| POSDataTypeDescription | Descrição do tipo do ponto de captura. POS Muxx, LibC ou Pay&Go | Texto |
| POSDataIdentifier | Número do ponto de captura (identificador do terminal) | Texto |
| POSTimestamp | Data e hora da transação (Formato) | Texto ("aaaa-mm-dd hh:mm:ss") |
| POSSerialNumber | Serial do equipamento que realizou a transação | Texto |
| ProductName | Nome do produto (Ex: Crédito à vista ou crédito parcelado) | Texto |
| ResultMessage | Mensagem informativa do resultado da Transação | Texto |
| ServerTimestamp | Horário do Servidor da Transação (Brasília) | Data e hora ("aaaa-mm-dd hh:mm:ss") |
| SimCardNumberICCID | Id do SimCard utilizado no equipamento que realizou a transação (Integrated Circuit Card ID) | Texto |
| SimCardNumberIMSI | IMSI do SimCard utilizado no equipamento que realizou a transação (International Mobile Subscriber Identity) | Texto |
| Status | Código do status da transação (vide tabela) | Inteiro |
| Type | Tipo de transação (vide tabela) | Inteiro |
| UniqueId | Número único da transação no sistema Muxx. Este número é a chave primária do registro do banco de dados que deverá ser enviado na busca | Inteiro longo |
| UpdateTimestamp | Data Hora da última atualização da transação | Data e hora ("aaaa-mm-dd hh:mm:ss") |
Updated over 2 years ago