Skip to content

ParameterType

ParameterType

O ParameterType define a lista dos parâmetros de Input e Output do SDK. Abaixo segue alguns dos parâmetros suportados em cada caso.

INPUT - Parâmetros de entrada

Define a lista de parâmetros suportados pelo TransactionBuilder, através do método:

withParameter(ParameterType)

Utilizado para informar parâmetros que não estão disponíveis por default no TransactionBuilder ou suas especializações. A seguir estão listados alguns destes parâmetros:

Parâmetros de Transação - Gerais

ParameterType (input) Tipo Descrição
VALOR_TRANSACAO* N Valor total da transação (multiplicado por 100). Ex: "100” para R$ 1,00; “1000” para R$ 10,00.
Método do TransactionBuilder: withAmount
NOME_APLICACAO* AN Nome da aplicação. Ex: "AppIntegradora".
Método do TransactionBuilder: withApplicationName
VERSAO_APLICACAO AN(12) Versão da aplicação/automação. [Opcional]
CUPOM_FISCAL N Número do cupom.
Método do TransactionBuilder: withBillOfSale [Opcional]
VALOR_ENTRADA N Valor da entrada. [Opcional]
VALOR_PARCELA1 N Valor da primeira parcela. [Opcional]
DATA_PARCELA1 AN Data da primeira parcela. Formato: "dd/mm/yy". [Opcional]
DATA_PRE_DATADO AN Data do agendamento. Formato: "dd/mm/yy". [Opcional]
NUMERO_PARCELAS N Número de parcelas: "02" para duas parcelas; "03" para três parcelas. Obrigatório se TIPO_FINANCIAMENTO for parcelado. [Opcional]
TIPO_FINANCIAMENTO N "0" - À vista; "1" - Parcelado Adm; "2" - Parcelado Loja; "3" - Pré-Datado. [Obrigatório se] NUMERO_PARCELAS for informado. [Opcional]
CPF_CLIENTE N(11) CPF do Cliente sem delimitadores. [Obrigatório se] pagamento de fatura pela rede Softway. [Opcional]
CODIGO_PRODUTO_CIELO AN Permite informar os códigos dos produtos CIELO a serem considerados na transação (Ex.: "79;763;764", para os produtos PAGAMENTO CARNE ELECTRON, PAGAMENTO CARNE ELO e PAGAMENTO CARNE MASTERCARD respectivamente). [Opcional]
TRATAR_DESFAZIMENTO N Deve ser utilizado exclusivamente em vendas com múltiplos cartões. Nestes casos, deve ser informado o valor "000" para desabilitar o controle automático de desfazimento para não desfazer a transação anterior, visto que trata-se de vários pagamentos na mesma venda. O valor "001" habilita novamente o desfazimento automático caso a transação anterior esteja pendente de confirmação. Valor default: "001". [Opcional]
TRATAR_QUEDA_ENERGIA N "000" – não realizar; "001" – realizar. [Opcional]
ATUALIZA_TABELAS_NA_TROCA_PINPAD N "0" – desabilita; "1" – habilita. Valor default: habilitado. [Opcional]

Parâmetros de Configuração

Clique aqui para expandir e mostrar os parâmetros de configuração
ParameterType (input) Tipo Descrição
CNPJ_AUTOMACAO* N CNPJ da Automação, sem delimitadores.
TIMEOUT_SERVIDOR N Timeout de conexão com o servidor. Quando o parâmetro não for informado, a aplicação utiliza os valores default: 15s para transações em geral ou 90s para transações de QR Code. [Opcional]
TIPO_SERVIDOR_TEF N "0" - DTEF; "1" - Sitef; "2" - CieloMobile; "3" - RedeMobile. [Opcional]
PINPAD_ATIVO N "1" – Pinpad habilitado; "0" – Pinpad desabilitado. [Opcional]

Parâmetros de Transação - Cancelamento

Clique aqui para expandir e mostrar os parâmetros de transação de Cancelamento
ParameterType (input) Tipo Descrição
TIPO_TRANSACAO_CANCELAMENTO N Permite definir o tipo da transação a ser cancelada ("1" - CREDITO; "2" - DEBITO; "3" - QRCODE).

Parâmetros de Transação - QR Code

Clique aqui para expandir e mostrar os parâmetros de transação com QR Code
ParameterType (input) Tipo Descrição
JSON_INTEGRACAO_QR AN Parâmetro utilizado nas Transações com QR Code e na Transação de Consultas Genéricas QR. Formato: JSON.
[EM DESENVOLVIMENTO]
JSON_INTEGRACAO_QR IN - [EM DESENVOLVIMENTO]
Transação de Consultas Genéricas QR

O parâmetro JSON_INTEGRACAO_QR é obrigatório. A automação deve informar os dados de entrada no formato JSON correspondentes ao tipo de consulta. E a resposta da solicitação será através do parâmetro de saída JSON_INTEGRACAO_QR OUT.

Clique aqui para mais detalhes do parâmetro de entrada em Transações de Consultas Genéricas

Descrição dos campos:

Campo Descrição
methodRequest Valor fixo para identificar a requisição.
value O valor da transação.
document O CPF do cliente.
Carteiras Ativas para a loja no QRLinx

A automação poderá consultar as carteiras que estão disponíveis para uma determinada loja, essa consulta se faz necessária na geração de uma cobrança específica, pois assim poderá solicitar a geração do QRCode apenas para as carteiras desejadas.

JSON SCHEMA: 

{
  "type": "object",
  "required": [ "methodRequest" ],
  "properties": {
    "methodRequest"  : {
      "type" : "number",
      "const": "2"     }
  }
}

EXEMPLO: 

{
  "methodRequest": 2
}

Consulta Parcelamento (Paga Leve - QRLinx)

A automação pode consultar se o parcelamento está disponivel para o cliente, assim poderá oferecer um parcelamento de pix antes da finalização da transação.

Na integração com o PSP Paga Leve existe uma integração de PIX com a opção do parcelamento, sendo assim os campos payer, client_identification, is_pix_upfront passam a ser obrigatórios para a Transacao com QR Code e o client_phone um campo recomendado.

JSON SCHEMA: 

{
  "type": "object",
  "required": [ "methodRequest" ],
  "properties": {
    "methodRequest"   : {
      "type" : "number",
      "const": "1"      },
    "value"           : {
      "type" : "number" },
    "methodRequest"   : {
      "type" : "string" }
  }
}

EXEMPLO: 

{
  "methodRequest": 1,
  "value":1.50,
  "document":"12345678901"
}

Transação com QR Code

O parâmetro JSON_INTEGRACAO_QR é opcional, utilizado pela rede QRLinx. Os dados devem ser informados no formato JSON conforme especificação abaixo:

Clique aqui para mais detalhes do parâmetro de entrada em Transações com QR Code
JSON Schema
Clique aqui para exibir o JSON Schema 
{
"type": "object",
"required": [],
"properties": {

  "specific_wallets": {
    "type": "array",
    "items": {
      "type": "string",
      "enum": ["AME", "CASH_BERTI", "MERCADO_PAGO", "PEDE_PRONTO", "PICPAY", "PIX", "VERO"] } },

  "is_pix_upfront"  : { "type": "boolean" },

  "payments": {
    "type": "object",
    "items": {
      "required": [ "value" ],
      "properties": {
        "value:"               : {
          "type": "number",
            "maximum": 9999999.99,
            "multipleOf": 0.01   },
        "payer" : {
          "type": "object",
          "required": [],
          "properties": {
            "first_name"    : {
              "type": "string",
              "maxLength": 30 },
            "last_name"     : {
              "type": "string",
              "maxLength": 30 },
            "email"         : {
              "type": "string",
              "maxLength": 50 },
            "external_code" : {
              "type": "string",
              "maxLength": 36 },
            "client_phone"  : {
              "type": "object",
              "properties": {
                "area_code"     : {
                  "type": "string",
                  "maxLength": 4  },
                "number"        : {
                  "type": "string",
                  "maxLength": 12 },
                "extension"     : {
                  "type": "string",
                  "maxLength": 7  }
              }},
            "client_identification": {
              "type": "object",
              "required": [],
              "properties": {
                "type"          : {
                  "type": "string",
                  "maxLength": 5  ,
                  "enum": ["CPF", "CNPJ"]},
                "number"    : {
                  "type": "string",
                  "maxLength": 15 }
              }}
            }},
        "expiration_time"      : {
          "type": "integer",
          "maximum": 99          },
        "withdraw_pix"         : {
          "type": "number",
          "maximum": 9999999.99  },
        "change_pix"           : {
          "type": "number",
          "maximum": 9999999.99  }
      }}},

    "order_items": {
      "type": "object",
      "items": {
        "required": [],
        "properties": {
          "name"               : {
            "type": "string",
            "maxLength": 150     },
          "quantity"           : {
            "type": "number",
            "maximum": 9999999.99,
            "multipleOf": 0.01   },
          "amount"             : {
            "type": "number",
            "maximum": 9999999.99,
            "multipleOf": 0.01   },
          "subtotal"           : {
            "type": "number" ,
            "maximum": 9999999.99,
            "multipleOf": 0.01   },
          "discount_value"     : {
            "type": "number",
            "maximum": 9999999.99,
            "multipleOf": 0.01   },
          "add_value"          : {
            "type": "number",
            "maximum": 9999999.99,
            "multipleOf": 0.01   },
          "number_external"    : {
            "type": "string",
            "maxLength": 14      },
          "ncm"                : {
            "type": "string",
            "maxLength": 8       }
        }
      }},

    "shipping_address": {
      "type": "object",
      "items": {
        "required": [],
        "properties": {
          "street"        : {
            "type": "string",
            "maxLength": 60 },
          "postal_code"   : {
            "type": "string",
            "maxLength": 10 },
          "number"        : {
            "type": "string",
            "maxLength": 15 },
          "complement"    : {
            "type": "string",
            "maxLength": 40 },
          "state"         : {
            "type": "string",
            "maxLength": 2  },
          "district"      : {
            "type": "string",
            "maxLength": 60 },
          "city"          : {
            "type": "string",
            "maxLength": 14 },
          "ncm"           : {
            "type": "string",
            "maxLength": 60 }
        }
      }}
}
}
EXEMPLO
Clique aqui para exibir o Exemplo 
{
  "specific_wallets":[
      "PIX",
      "PICPAY" ],
  "is_pix_upfront":true,
  "payments":[
      {
          "value:":1.50,
          "payer":{
              "first_name":"Ana",
              "last_name":"Maria",
              "email":"am@linx.com.br",
              "external_code":"0",
              "client_phone":{
                  "area_code":"11",
                  "number":"982232155",
                  "extension":"0"
              },
              "client_identification":{
                  "type":"CPF",
                  "number":"12345678901"
              }
          },
          "expiration_time":100000,
          "withdraw_pix":0,
          "change_pix":0
      }
  ],
  "order_items":[
      {
          "name":"produto1",
          "quantity":1,
          "amount":1.50,
          "subtotal":1.50,
          "discount_value":0.0,
          "add_value":0.0,
          "number_external":"123",
          "ncm":"12345678"
      }
    ]
}
Descrição dos campos
specific_wallets

Este objeto é necessário para criação de uma cobrança específica, ou seja, quando a loja não deseja criar uma cobrança com todas as carteiras disponíveis.

O campo aceita apenas o nome da carteira, caso a loja não possua a informação de quais carteiras estão ativas para transacionar. A automação poderá utilizar a transação de Consultas Genéricas QR (“Consulta Carteiras”), que retorna as carteiras ativas da loja.

O campo é uma lista, pois a automação pode escolher criar a cobrança apenas com uma carteira ou mais de uma. Quando a automação for enviar a chamada para a criação de cobrança, ele deverá enviar dentre as opções da lista (conforme o JSON Schema).

is_pix_upfront

Campo para criação de PIX parcelado junto à "Paga leve".

payments

Objeto com informações necessárias à realização do pagamento. Descrição dos campos:

Campo Descrição
value Valor total da venda. Campo utilizado apenas nas transações de PIX Saque e PIX Troco
payer Informações do pagador.
expiration_time Tempo em segundos da expiração da cobrança criada.
withdraw_pix Representa o valor que o cliente deseja sacar na loja, ou seja, utilizar o PIX SAQUE.
change_pix Representa o valor que o cliente deseja de troco na transação, ou seja, utilizar o PIX TROCO.
> payer
Campo Descrição
first_name Primeiro nome do pagador
last_name Último nome do pagador.
email E-mail do pagador.
external_code Código do cliente no PSP de dados do EC.
client_phone Dados do telefone do pagador.
client_identification Natureza jurídica do pagador (Pessoa Física/Jurídica).
>> client_phone
Campo Descrição
area_code Código de área do telefone do pagador.
number Número do telefone do pagador.
extension Ramal do telefone do pagador.
>> client_identification
Campo Descrição
type Natureza jurídica do pagador. "CPF" para pessoa física; "CNPJ" para pessoa jurídica.
number Número do CPF/CNPJ do pagador. Campo obrigatório para integrações com Paga Leve.
order_items

Itens da ordem de venda.

Campo Descrição
name Descrição do item.
quantity Quantidade do item.
amount Valor total do item.
subtotal Subtotal do item.
discount_value Valor do desconto concedido.
add_value Valor adicionado à venda. Ex.: frete, embalagem.
number_external Código do item.
ncm Natureza jurídica do pagador (Pessoa Física/Jurídica).
shipping_address

Endereço para entrega da compra.

Campo Descrição
street Descrição do logradouro.
postal_code CEP do logradouro.
number Número do logradouro
complement Complemento do endereço.
state Estado/UF do endereço.
district Bairro do logradouro
city Código do item.
ncm Cidade do logradouro.
PIX Troco e PIX Saque

Segue detalhes sobre as operações de PIX Saque ou PIX Troco e seus respectivos campos obrigatórios. Não é permitido gerar uma cobrança de PIX Saque e PIX Troco em conjunto, caso os campos específicos (change_pix e withdraw_pix) sejam enviados, o QRLinx retornará erro na criação da cobrança.

PIX Troco

No caso do Pix Troco, o saque de recursos em espécie acontece junto com a realização de uma compra no agente de saque. Nesse caso, o Pix é feito pelo valor total (compra + saque). O extrato do cliente evidenciará o valor correspondente ao saque e o valor correspondente à compra.

Importante que para gerar um PIX Troco, a automação deverá enviar o campo “payments.value” conforme a compra realizada pelo cliente, e no campo “payments.change_pix” informar o valor que o cliente deseja sacar/receber de troco. Por fim, o campo “order_items.amount” representa a soma dos dois campos na criação da cobrança.

O campo change_pix de "payments" é obrigatório na criação desta cobrança.

PIX Saque

O Pix Saque permitirá que todos os clientes de qualquer participante do Pix realizem um saque em um dos pontos que ofertar o serviço. Estabelecimentos comerciais, redes de caixas eletrônicos (ATMs) compartilhados e os próprios participantes do Pix, por meio de seus ATMs próprios, poderão ofertar o serviço. Para ter acesso aos recursos em espécie, basta que o cliente faça um Pix para o agente de saque, em dinâmica similar à de um Pix normal, a partir da leitura de um QRCode mostrado ao cliente.

Importante que para gerar um PIX Saque, a automação deverá enviar o campo “payments.value” zerado, já que não está ocorrendo uma compra e sim apenas um saque junto ao estabelecimento.

O campo withdraw_pix de "payments" é obrigatório na criação desta cobrança.

Parâmetros de Transação - Frota

Clique aqui para expandir e mostrar os parâmetros de transação de Frota
ParameterType (input) Tipo Descrição
PLACA_VEICULO AN (7) Identificação da placa compreendendo os 7 dígitos da identificação do veículo.
MATRICULA_CONDUTOR N Código do motorista.
HODOMETRO N Contador da quilometragem percorrida pelo veículo.
HORIMETRO N Representa a quantidade de tempo de funcionamento do veículo.
LISTA_PRODUTOS_ABASTECIMENTO AN Lista de dados que contempla dados do abastecimento, troca de óleo ou outros serviços. Esta lista deve ser informada no formato JSON.
LISTA_PRODUTOS_ABASTECIMENTO

A lista de serviços deve ser informada no formato JSON conforme especificação abaixo:

Clique aqui para expandir e mostrar detalhes sobre LISTA_PRODUTOS_ABASTECIMENTO

  1. O campo "tipoServico" indica qual serviço foi realizado. Os valores permitidos são:

    • “0001” - para abastecimento
    • “0002” - para troca de óleo
    • “0003” - para outros serviços

  2. É permitida a entrada de apenas um registro de abastecimento e de um registro de troca de óleo. Poderá ser incluída de 1 a n registros para manutenção realizada.

Abastecimento e Troca de óleo - JSON Schema

Para estes serviços, o campo "tipoAbastecimento" é opcional. Mas caso não seja informado no JSON, será realizada a coleta durante a transação.

{
  "type": "object",
  "properties": {
    "tipoServico"           : { "type": "string" },
    "codigoServico"         : { "type": "string" },
    "tipoAbastecimento"     : { "type": "string" },
    "quantidade"            : { "type": "string" },
    "quantidade3decimais"   : { "type": "string" },
    "valorUnitario"         : { "type": "string" },
    "valorTotal"            : { "type": "string" },
    "valorTotalComDesconto" : { "type": "string" }
  },
  "required": [
    "tipoServico",
    "quantidade",
    "valorUnitario",
    "valorTotal",
    "valorTotalComDesconto"
  ]
}
Outros serviços - JSON Schema
{
  "type": "object",
  "properties": {
    "tipoServico"   : { "type": "string" },
    "codigoServico" : { "type": "string" },
    "valorTotal"    : { "type": "string" }
  },
  "required": [
    "tipoServico",
    "codigoServico",
    "valorTotal"
  ]
}
Exemplo

Para um abastecimento de 50 litros considerando que o combustível custa R$ 4,80 contabilizando um valor total de R$ 240,00:

{
  "DadosServicos": [
    {
      "tipoServico": "0001",
      "codigoServico": "1",
      "valorUnitario": "480",
      "quantidade": "5000",
      "quantidade3decimais": "50000",
      "valorTotal": "24000",
      "tipoAbastecimento": "10",
      "valorTotalComDesconto": "24000"
    },
    {
      "tipoServico": "0003",
      "codigoServico": "123",
      "valorTotal": "2500"
    }
  ]
}

Parâmetros de Transação - Split de Pagamento

Clique aqui para expandir e mostrar os parâmetros de transação Split
ParameterType (input) Tipo Descrição
DADOS_SPLIT AN Dados para transação de Split de Pagamento, no formato JSON.
DADOS_SPLIT

Os dados para Split de Pagamento devem ser informados no formato JSON conforme especificação abaixo:

JSON Schema
{
  "type": "object",
  "properties": {
    "itensSplit": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "valor"      : { "type": "string" },
          "descricao"  : { "type": "string" },
          "quantidade" : { "type": "string" },
          "codigo"     : { "type": "string" }
        },
        "required": [
          "valor",
          "descricao",
          "quantidade",
          "codigo"
        ]
      }
    },
    "recebedoresSplit": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "valor" : { "type": "string" },
          "cnpj"  : { "type": "string" },
          "tipo"  : { "type": "string" }
        },
        "required": [
          "valor",
          "cnpj",
          "tipo"
        ]
      }
    }
  },
  "required": [
    "recebedoresSplit"
  ]
}
Exemplo
{
  "itensSplit":[
    {
      "valor":"2990",
      "descricao":"descrição do item 1",
      "quantidade":"1",
      "codigo":"1A2B3C4D5E6F7"
    }
  ],
  "recebedoresSplit":[
    {
      "valor":"2000",
      "cnpj":"12345678901234",
      "tipo":"0"
    },
    {
      "valor":"8000",
      "cnpj":"12345678905678",
      "tipo":"0"
    }
  ]
}

Parâmetros de entrada exclusivos para a Rede Calcard

Clique aqui para expandir e mostrar detalhes sobre a rede Calcard

Transação de Consulta de Planos (utilizando TransactionType.PLANOS_PAGAMENTO):

Consulta de Planos (input) Tipo Descrição
NUMERO_CARTAO_AUTOMACAO N Número do cartão digitado.
VALIDADE_CARTAO_AUTOMACAO N Data de validade do cartão (Formato MMAA).

Em transações de pagamento (utilizando TransactionType.CARTAO_CREDITO):

Transação de Pagamento (input) Tipo Descrição
NUMERO_CARTAO_AUTOMACAO N Número do cartão digitado.
VALIDADE_CARTAO_AUTOMACAO N Data de validade do cartão (Formato MMAA).
CODIGO_BANDEIRA_AUTOMACAO N Código da Bandeira (Ex: "50" - Calcard).
CODIGO_PLANO_AUTOMACAO N Código do Plano (3 últimos dígitos do código do processamento do plano selecionado).

OUTPUT - Parâmetros de saída

Define a lista de parâmetros suportados pelo TransactionResult, através do método:

String getParameter(ParameterType type)

A seguir estão listados alguns destes parâmetros de retorno:

Parâmetros de Transação - Gerais

ParameterType (output) Tipo Descrição
CNPJ_LOJA N CNPJ da Loja, sem delimitadores.
CNPJ_REDE N CNPJ da Rede, sem delimitadores.
CODIGO_AUTORIZACAO N Código de autorização.
Método do TransactionResult: getAuthorizationCode
CODIGO_BANDEIRA N Código da Bandeira do cartão.
Método do TransactionResult: getBrandCode
CODIGO_BANDEIRA_SEFAZ N Código da Bandeira - Sefaz.
Método do TransactionResult: getBrandCodeSefaz
CODIGO_REDE N Código da Rede da adquirente.
Método do TransactionResult: getAcquirerCode
CODIGO_RESPOSTA N Código de resposta da Transação. "00" - Sucesso.
Método do TransactionResult: getResponseCode
CODIGO_TRANSACAO N Código da Transação.
Método do TransactionResult: getTransactionCode
COMPROVANTE AN Comprovante da transação.
Método do TransactionResult: getReceipt
COMPROVANTE_CLIENTE AN Comprovante - via do cliente.
Método do TransactionResult: getCustomerSalesReceipt
COMPROVANTE_ESTABELECIMENTO AN Comprovante - via do estabelecimento.
Método do TransactionResult: getStoreSalesReceipt
COMPROVANTE_REDUZIDO AN Comprovante reduzido.
Método do TransactionResult: getAbbreviatedReceipt
INDICE_CODIGO_BANDEIRA N Índice do código da Bandeira.
INDICE_CODIGO_REDE N Índice do código da Rede.
MENSAGEM_ERRO AN Mensagem de erro.
Método do TransactionResult: getErrorMessage
NSU AN Número Sequencial Único gerado pelo TEF.
Método do TransactionResult: getNsu
NSU_REDE AN Número Sequencial Único gerado pela Rede Adquirente.
Método do TransactionResult: getAuthorizerNsu
NSU_REDE_ADICIONAL AN (32) NSU da Rede Adquirente, para suportar valor de NSU das Redes com até 32 dígitos.
Método do TransactionResult: getAuthorizerNsuAdicional
NOME_BANDEIRA AN Nome da Bandeira do cartão.
Método do TransactionResult: getBrand
NOME_PORTADOR_CARTAO AN Nome do portador do cartão.
Método do TransactionResult: getCardHolderName
NOME_REDE AN Nome da Rede.
Método do TransactionResult: getAcquirerName
NUMERO_CARTAO N Número do cartão.
Método do TransactionResult: getCardNumber
NUMERO_EMPRESA N Número da Empresa.
NUMERO_LOJA N Número da Loja.
NUMERO_PARCELAS N Número de parcelas.
Método do TransactionResult: getInstallment
NUMERO_PDV N Número do PDV.
TIPO_FINANCIAMENTO N Tipo do Financiamento. "0" - À vista; "1" - Parcelado Adm; "2" - Parcelado Loja; "3" - Pré-Datado.
Método do TransactionResult: getFinancialType
TIPO_OPERACAO N Tipo da Operação: "01" - Débito; "02" - Crédito; "03" - Voucher; "05" - Private; "99" - Outros. getOperationType
Método do TransactionResult: getOperationType
VALIDADE_CARTAO N Data de validade do cartão no formato "MMAA".
Método do TransactionResult: getCardValidity
VALOR_DESCONTO N Valor de desconto na venda. Se este campo vier com valor superior a "0", então deverá ser aplicado como desconto. Ex: "000000000100" para R$1,00.
Método do TransactionResult: getTransactionDiscount
VALOR_PAGO N Valor total pago.
Método do TransactionResult:
VALOR_TRANSACAO N Valor total da transação (multiplicado por 100). Ex: "100" para R$ 1,00; "1000" para R$ 10,00.
Método do TransactionResult: getTransactionAmount
CARTAO_PREPAGO A (1) Indica se o cartão utilizado é pré-pago. Atualmente esta informação é retornada pela rede adquirente CIELO. ("S" - SIM; "N" - NÃO)

Parâmetros de Transação - QR Code

Clique aqui para expandir e mostrar os parâmetros de transação com QR Code
ParameterType (output) Tipo Descrição
CODIGO_PSP N Código do PSP da Transação com QR Code.
NOME_PSP AN Descrição do PSP da Transação com QR Code.
METODO_PAGAMENTO_QR AN Método de pagamento da Transação com QR Code.
Ex: "PIX".
[EM DESENVOLVIMENTO]
END_TO_END_ID N Identificador EndToEnd da Transação com QR Code.
Ex: "E10032025183507".
[EM DESENVOLVIMENTO]
JSON_DADOS_ADICIONAIS_QR AN Parâmetro de output com dados adicionais da Transação com QR Code. Formato: JSON.
Ex: "{"IdEndToEnd":"E10032025183507","multiPsp":"false"}"
[EM DESENVOLVIMENTO]
JSON_INTEGRACAO_QR AN Parâmetro de output das Consultas Genéricas QR. Formato: JSON.
[EM DESENVOLVIMENTO]
JSON_INTEGRACAO_QR OUT - [EM DESENVOLVIMENTO]
Transação de Consultas Genéricas QR

A resposta da Transação de Consultas Genéricas QR será feita através do parâmetro de saída JSON_INTEGRACAO_QR. Os dados retornados vão depender do tipo da solicitação realizada.

Clique aqui para expandir e mostrar detalhes sobre o parâmetro de saída JSON_INTEGRACAO_QR
Carteiras Ativas para a loja no QRLinx

O retorno da consulta das carteiras que estão disponíveis para uma determinada loja segue o seguinte exemplo:

EXEMPLO: 

{
  "success":true,
  "message":"Carteiras retornadas com sucesso",
  "data":[
      {
          "cnpj":"22896431000110",
          "name":"Picpay Servicos S.A",
          "trading_name":"PicPay",
          "logo_link":"https://static.linxpayhub.com.br/images/logos/LogoPicPay.png",
          "logo_link_download":"https://static.linxpayhub.com.br/images/logos/LogoPicPay.png",
          "specific_wallet":"PICPAY"
      },
      {
          "cnpj":"00000000000000",
          "name":"Pix",
          "trading_name":"Pix",
          "logo_link":"https://static.linxpayhub.com.br/images/logos/LogoPix.jpg",
          "logo_link_download":"https://static.linxpayhub.com.br/images/logos/LogoPix.jpg",
          "specific_wallet":"PIX",
          "integrationTypePixModel":{
              "id":7,
              "name":"Pagar.me",
              "priority":"Primary"
          }
      },
      {
          "cnpj":"00000000000000",
          "name":"Pix",
          "trading_name":"Pix",
          "logo_link":"https://static.linxpayhub.com.br/images/logos/LogoPix.jpg",
          "logo_link_download":"https://static.linxpayhub.com.br/images/logos/LogoPix.jpg",
          "specific_wallet":"PIX",
          "integrationTypePixModel":{
              "id":5,
              "name":"Santander",
              "priority":"Secondary"
          }
      }
    ]
}

Consulta Parcelamento (Paga Leve - QRLinx)

Essa consulta possui apenas duas mensagens de retorno “Approved” ou “Declined”, assim a loja terá a informação se o PIX parcelado está aprovado ou não para o seu cliente. Segue um exemplo:

EXEMPLO: 

{
    "sucesso":true,
    "message":"Consulta realizada com sucesso",
    "data":{
        "status":"APPROVED"
    }
}

Obs: Caso o cliente do lojista seja aprovado no pagamento do PIX parcelado, a automação deverá enviar a Transação QR Code com o campo is_pix_upfront = "false". O QRLinx retornará o link de pagamento da Paga Leve através da callback setCurrentTransactionInfo, que poderá ser exibido ou enviado para o cliente concluir o processo de pagamento.

Parâmetros de saída exclusivos para a Rede Calcard

Clique aqui para expandir e mostrar detalhes sobre a rede Calcard
Consulta de Planos (output) Tipo Descrição
PLANOS_PAGAMENTO AN Parâmetro de output da Consulta de Planos.

Detalhamento dos dados dos planos de pagamentos:

Tipo Formato Descrição
N008 DDMMAAAA Data de nascimento do portador.
A050 ASCII Nome do portador do cartão.
A001 ASCII Fixo “P”, indica consulta de plano de parcelamento.

Para cada código de processamento o bloco abaixo se repetirá:

Tipo Formato Descrição
N006 ASCII Código de Processamento.
N005 ASCII Vencimento Primeira Parcela AADDD (data Juliana).
N001 ASCII Flag Juros.
N001 ASCII Flag Pula Ciclo.

Os campos descritos abaixo podem repetir para demostrar a quantidade de parcelas do tipo de operação escolhido.

Tipo Formato Descrição
N002 ASCII Número da Parcela.
N008 ASCII Valor Primeira Parcela.
N008 ASCII Valor Demais Parcelas.
N005 ASCII Taxa de Juros.
N005 ASCII CET Anual.
A001 ASCII Finalizador de Plano. Ao término dos planos de parcelamento do código de processamento indicado, será incluído um caractere para indicar fim do plano. Esse caractere será “;
Exemplo
27021988
NOME DO CLIENTE                                   
P
91000124315000100016198000161980000000794;96400424315100400005420000054200169962031;
96400524315100500004653000046530169962031;93010224315000200008099000080990169962031;
93010324315000300005400000053990169962031;93010424315000400004048000040500169962031;
93010524315000500003238000032400169962031;94035224345110200009432000094320079017072;
94035324345110300006533000065330079017072;94035424345110400005088000050880079017072;
94035524345110500004225000042250079017072;94035624345110600003653000036530079017072;
94035724345110700003247000032470079017072;94035824345110800002945000029450079017072;
94035924345110900002713000027130079017072;94036024345111000002529000025290079017072;
96401424315100200009355000093550169962031;96401324315100300006720000067200169962031;
91000324345110100018148000181480079017072;