Pular para o conteúdo principal

ObterLogTransacao

Obter Log Transação

atenção

Os itens descritos abaixo desse alerta são customizações liberadas a partir da release de Paykit 8.22.23.0012 (inclusive)

O Paykit poderá fornecer os logs da transação de duas maneiras, sendo elas:

  1. Via callback no final da transação financeira, ou seja, o Paykit acionará a automação passando um buffer no formato json, desta forma a automação não precisará acionar o Paykit para obter maiores detalhes da transação financeira.

  2. Via método, desta forma a automação fica a encargo de acionar o Paykit no final da transação para solicitar os logs transacionais.

Callback

Para que o Paykit forneça informações sobre uma transação recém-realizada, ele aciona a callback documentada abaixo após a transação ser concluída com o TEF, e antes de devolver o controle para a automação comercial. Para que a callback possa ser acionada, ela deve ser registrada pela automação em uma etapa anterior ao inicio da transação financeira.

RegLogTransacaoAtual

void DIRETIVA_CALLBACK RegLogTransacaoAtual(pCallBackLogTransacaoAtual p)

Este método registra a callback da automação. Nele, p contém uma diretiva de callback com a assinatura descrita na seção abaixo. A automação precisa fazer este registro antes do início da transação, preferencialmente assim que o driver do Paykit for carregado.

LogTransacaoAtual

int DIRETIVA_CALLBACK LogTransacaoAtual(char *pInfo)

Esta é a assinatura do método que a automação tem que registrar. Nela, pInfo é um buffer contendo uma mensagem com informações da transação, seguindo a estrutura abaixo. Como pode-se observar, ela é construída com apenas um JSON contendo o log da transação que está em execução e os dados referentes à rede que autorizou a transação, proveniente de um campo da resposta do TEF que atualmente é adicionado apenas para a rede Adyen. Os dados referentes ao log da transação variam de acordo com a transação que está sendo efetuada e estão descritos na seção Layout do Log da Transação.

Json de Exemplo

Clique para expandir e mostrar o JSON de exemplo

{
"Rede": {
"Codigo": 216,
"Nome": "ADYEN",
"CPF": "19824193855",
"TOKEN": "DB9NH3ZCK5JCNP65"
},
"LogTransacao": {
<Dados do log da transação de acordo com a transação que está sendo efetuada>
}
}

Após a automação retornar o controle para o Paykit (executar um return no método chamado) este buffer será destruído da memória, portanto a automação deve copiar o buffer enviado para alguma estrutura interna de controle da automação, não devendo fazer qualquer alteração no buffer enviado pelo Paykit.

ObtemLogTransacaoJson

char* DIRETIVA_CALLBACK ObtemLogTransacaoJson(char *pNumeroControle)

Esse método pode ser utilizado para retornar os dados da transação após sua aprovação. Os dados retornados serão os mesmos disponíveis através da callback LogTransacaoAtual. Os dados da transação ficarão disponíveis no PDV por 1 dia após a sua aprovação. O parâmetro pNumeroControle é opcional e caso seja passado um ponteiro nulo ou vazio serão retornados os dados da última transação efetuada.

CampoTamanhoDescrição
pNumeroControle06NNSU (número seqüencial único)

Layout do Log da Transação

O layout dos dados do log da transação variam de acordo com a transação que está sendo efetuada. Nessa seção serão descritos os layouts de cada uma das transações disponíveis

Json de Exemplo

Clique para expandir e mostrar o JSON de exemplo para uma transação de crédito

{
"LogTransacao":{
"CNPJRedeAdquirente":"01425787000104",
"CPFouCNPJ":"",
"CartaoPrePago":" ",
"CodigoBandeira":"2",
"CodigoBandeiraRede":"15",
"CodigoBandeiraSefaz":"2",
"CodigoBandeiraTerceiro":"2",
"CodigoOperadora":"113",
"CodigoProdutoRede":"",
"CodigoRedeTerceiro":"5",
"CodigoResposta":"0",
"CodigoTEFTerceiro":"1",
"Data":"22012025",
"Hora":"160101",
"NomeBandeira":"Mastercard",
"NomeOperadora":"Mastercard",
"NomePortador":"",
"NumeroAutorizacaoRede":"192165",
"NumeroAutorizador8":"7",
"NumeroCartao":"222763******8028*********************",
"NumeroControle":"005703",
"NumeroControleRede":"96744000",
"NumeroControleRedeAdicional":"096744000",
"NumeroCupom":"5",
"NumeroEmpresa":"1",
"NumeroEquipamento":"250",
"NumeroLoja":"1",
"NumeroParcelas":"0",
"TipoColetaCartao":"6",
"TipoOperacao":"AV",
"TipoRegistro":"CCR",
"ValorDesconto":"000000000000",
"ValorFinal":"000000000050",
"ValorOriginal":"000000000050",
"ValorParcela":"000000000000",
"ValorTaxaEmbarque":"000000000000",
"ValorTaxaServico":"000000000000",
"ValorTransacao":"000000000050",
"VencimentoCartao":"0829"
}
}


CCR (Transação Cartão de Crédito)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CPFouCNPJstringCPF ou CNPJ retornado na transação
CartaoPrePagostringIndicativo se é um cartão pré-pago: 'S' (Sim), 'N' (Não) ou ' ' (para redes que não informam o tipo do cartão)
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
NumeroParcelasstringNúmero de parcelas da transação
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoOperacaostringCódigo com dois dígitos que representa a forma de parcelamento utilizada na transação.
  • [AV] À Vista
  • [FL] Financiamento Lojista (sem juros)
  • [FA] Financiamento Administradora (com juros)
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CCR] Cartão de Crédito
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorParcelastring10 inteiros, 2 decimais
ValorTaxaEmbarquestring10 inteiros, 2 decimais
ValorTaxaServicostring10 inteiros, 2 decimais
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA


CCD (Transação Cartão Crediário)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
DataDebitostring<ddmmaaaa> <ddmmaaaa> Data da parcela (transação parcelada) ou Data de débito (transação pré-datada)
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
NumeroParcelasstringNúmero de parcelas da transação
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoOperacaostringCódigo com dois dígitos que representa a forma de parcelamento utilizada na transação.
  • [PC] Parcelada (com juros)
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CCD] Cartão Crediário
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorParcelastring10 inteiros, 2 decimais
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA


CDB (Transação Cartão de Débito)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CartaoPrePagostringIndicativo se é um cartão pré-pago: 'S' (Sim), 'N' (Não) ou ' ' (para redes que não informam o tipo do cartão)
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoSupervisorstringCódigo do Supervisor autorizador da Transação Forçada
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
DataDebitostring<ddmmaaaa> <ddmmaaaa> Data da parcela (transação parcelada) ou Data de débito (transação pré-datada)
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
NumeroParcelasstringNúmero de parcelas da transação
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoOperacaostringCódigo com dois dígitos que representa a forma de parcelamento utilizada na transação.
  • [PS] Parcelada (sem juros)
  • [PC] Parcelada (com juros)
  • [PD] Pré-datada
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CDB] Cartão de Débito
TipoTransacaostring
  • [0] Transação Normal
  • [1] Transação Forçada
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorParcelastring10 inteiros, 2 decimais
ValorSaquestring10 inteiros, 2 decimais
ValorTaxaEmbarquestring10 inteiros, 2 decimais
ValorTaxaServicostring10 inteiros, 2 decimais
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA


CCV (Transação Cartão Voucher)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CCV] Cartão Voucher
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA


CNC (Transação De Cancelamento)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CNC] Cancelamento
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA


CPR (Cartão Private Label)

CPL (Consulta Private Label)

SPL (Simulação Private Label)

FPL (Pagamento de Fatura Private Label)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoItemstringCódigo do item
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
NumeroParcelasstringNúmero de parcelas da transação
PlanoPagamentostringPlano informado pelo operador
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoOperacaostringCódigo com dois dígitos que representa a forma de parcelamento utilizada na transação.
  • [AV] À Vista
  • [FL] Financiamento Lojista (sem juros)
  • [FA] Financiamento Administradora (com juros)
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CPR] Cartão Private Label
  • [CPL] Consulta Private Label
  • [SPL] Simulação Private Label
  • [FPL] Pagamento de fatura Private Label
ValorDescontostring10 inteiros, 2 decimais
ValorEntradastring10 inteiros, 2 decimais
ValorFinalstringValor final da transação (Original – Desconto). 10 inteiros, 2 decimais
ValorOriginalstring10 inteiros, 2 decimais
ValorTaxaServicostring10 inteiros, 2 decimais
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA
VencimentosaPularstringNúmero de vencimentos a pular


QRC (Transação QR Code)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoPSPstringCódigo do PSP
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
IdEndToEndstringID PIX Gerado pelo Banco Central
remaining_amountstring(QRLinx) Valor que foi pago pelo cliente.
multiPspboolean(QRLinx) Identificação se a transação ocorreu com o provedor primário ou secundário, devido a instabilidades nos PSPs de PIX.
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NomePSPstringNome do PSP
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [QRC] QR Code
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorTransacaostring10 inteiros, 2 decimais
client_payer_paymentsarrayLista de pagadores da transação
client_payer_payments[].accountobjetoDados da conta do pagador
client_payer_payments[].account.bankobjetoDados do banco do pagador
client_payer_payments[].account.bank.ispbstringCódigo ISPB do banco
client_payer_payments[].account.bank.namestringNome do banco
client_payer_payments[].client_payerobjetoDados do pagador
client_payer_payments[].client_payer.document_numberstringNúmero do documento do pagador
client_payer_payments[].client_payer.document_typestringTipo do documento do pagador
client_payer_payments[].client_payer.namestringNome do pagador
client_payer_payments[].cnpjstringCNPJ associado ao pagamento
walletobjetoDados da carteira digital
wallet.cnpjstringCNPJ da carteira digital


PAA (Transação Acréscimo de Pré Autorização)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CPFouCNPJstringCPF ou CNPJ retornado na transação
CartaoPrePagostringIndicativo se é um cartão pré-pago: 'S' (Sim), 'N' (Não) ou ' ' (para redes que não informam o tipo do cartão)
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
NumeroParcelasstringNúmero de parcelas da transação
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoOperacaostringCódigo com dois dígitos que representa a forma de parcelamento utilizada na transação.
  • [AV] À Vista
  • [FL] Financiamento Lojista (sem juros)
  • [FA] Financiamento Administradora (com juros)
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [PAA] Acréscimo Pré Autorização
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorParcelastring10 inteiros, 2 decimais
ValorTaxaEmbarquestring10 inteiros, 2 decimais
ValorTaxaServicostring10 inteiros, 2 decimais
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA


CFP (Transação Confirmação de Pré Autorização)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CPFouCNPJstringCPF ou CNPJ retornado na transação
CartaoPrePagostringIndicativo se é um cartão pré-pago: 'S' (Sim), 'N' (Não) ou ' ' (para redes que não informam o tipo do cartão)
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
NumeroParcelasstringNúmero de parcelas da transação
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoOperacaostringCódigo com dois dígitos que representa a forma de parcelamento utilizada na transação.
  • [AV] À Vista
  • [FL] Financiamento Lojista (sem juros)
  • [FA] Financiamento Administradora (com juros)
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CFP] Confirmação de pré-autorização
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorParcelastring10 inteiros, 2 decimais
ValorTaxaEmbarquestring10 inteiros, 2 decimais
ValorTaxaServicostring10 inteiros, 2 decimais
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA


FRO (Transação Frota)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoCondutorstringCódigo do condutor
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
CodigoVeiculostringCódigo do veículo
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
KilometragemstringOdômetro do veículo
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
TipoColetaCartaostringCódigo com um dígito que representa a forma de entrada utilizada na transação.
  • [0] Tarja magnética
  • [1] Digitado
  • [2] Chip TIBC 1
  • [3] Chip TIBC 3
  • [4] Chip com contato EMV
  • [5] Sem contato tarja
  • [6] Sem contato EMV
  • [7] QR Code
TipoProdutostringCódigo com um dígito que representa o tipo de produto da transação.
  • [0] Pré-Pago (VCE)
  • [1] Pós-Pago (MaxiFrota)
  • [2] Outros
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [FRO] Cartão Frota
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorTransacaostring10 inteiros, 2 decimais
VencimentoCartaostringFormato MMAA


CPP (Cartão Pré-Pago)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadorastringCódigo da operadora
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroCartaostringConteúdo da trilha 2 sem bytes sentinelas
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
TipoOperacaostringCódigo com dois dígitos que representa o tipo de operação realizada.
  • [CA] Carga Cartão
  • [RE] Recarga do Cartão
  • [PG] Pagamento com Cartão Pré-pago (Vale-presente)
  • [CR] Código de Resgate de Cartão Pré-pago
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CPP] Cartão Pré-Pago
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorTransacaostring10 inteiros, 2 decimais


CBP (Pagamento Corban)

CBC (Cancelamento Corban)

CBI (Inicialização Corban)

CBF (Finalização Corban)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CMC7stringValor CMC7
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoBarrasstringCódigo de barras
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
DataVencimentostringFormato: <ddmmaaaa>
FormaPagamentostringCódigo com um dígito que identifica a forma de pagamento.
  • [1] Dinheiro
  • [2] Cheque
  • [3] Débito
  • [4] Crédito
HorastringHora que a transação foi efetuada
IndicativoCMC7stringCódigo com um dígito que identifica a forma de entrada do CMC7
  • [1] Lido
  • [2] Digitado
NomeBandeirastringNome da bandeira do cartão
NomeOperadorastringNome da operadora do cartão
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
TipoDocumentostringIndicativo da leitura do codigo de barras
  • [0] Lido oticamente
  • [1] Digitado
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CPP] Cartão Pré-Pago
TipoTransacaostringCódigo com um dígito que identifica o tipo de transação.
  • [0] Pagamento
  • [1] Cancelamento
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorTransacaostring10 inteiros, 2 decimais


CEL (Recarga de Celular)

Clique para mostrar o Objeto

ParâmetroTipoObservação
CNPJRedeAdquirentestringCNPJ da rede adquirente
CodigoAreastringCódigo da área do celular
CodigoBandeirastringCódigo da bandeira do cartão
CodigoBandeiraRedestringCódigo da bandeira na rede
CodigoBandeiraSefazstringCódigo da Bandeira na Sefaz
CodigoBandeiraTerceirostringCódigo da Bandeira do TEF de terceiro
CodigoOperadoraCelularstringCódigo da Operadora do Celular
CodigoProdutoRedestringCódigo do produto da rede utilizado na transação. Será retornado somente para as redes que o utilizarem.
CodigoRedeTerceirostringCódigo da Rede do TEF de terceiro
CodigoRespostastringCódigo de resposta da transação.
CodigoTEFTerceirostringCódigo do TEF a que se referem os campos de bandeira e rede de terceiro (1=SiTef)
DatastringData que a transação foi efetuada
HorastringHora que a transação foi efetuada
NomeBandeirastringNome da bandeira do cartão
NomeOperadoraCelularstringNome da operadora de recarga de celular
NomePortadorstringNome do portador do cartão
NumeroAutorizacaoRedestringNúmero da autorização na rede adquirente
NumeroAutorizador8stringRede Autorizadora do TEF
NumeroControlestringNSU (número seqüencial único)
NumeroControleRedestringNúmero do Controle da Rede
NumeroControleRedeAdicionalstringNSU Rede para rede Stone
NumeroCupomstringNúmero do cupom (fiscal ou não fiscal)
NumeroEmpresastringNúmero da empresa configurada no Paykit
NumeroEquipamentostringNúmero do PDV configurado no Paykit
NumeroLojastringNúmero da loja configurada no Paykit
NumeroTelefonestringNúmero do telefone
TipoRegistrostringCódigo com três dígitos que representa a o tipo da transação efetuada.
  • [CEL] Recarga de Celular
ValorDescontostringValor do desconto
ValorFinalstringValor final da transação (Original – Desconto)
ValorOriginalstringValor original da transação
ValorRecargastring10 inteiros, 2 decimais

Este conteúdo foi útil para você?