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

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:

Parameter (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.
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).
TIPO_TRANSACAO_CANCELAMENTO	N	Permite definir o tipo da transação a ser cancelada ("1" - CREDITO; "2" - DEBITO; "3" - QRCODE).
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. O valor default é "001".
VALOR_ENTRADA	N	Valor da entrada.
VALOR_PARCELA1	N	Valor da primeira parcela.
DATA_PARCELA1	AN	Data da primeira parcela. Formato: "dd/mm/yy".
DATA_PRE_DATADO	AN	Data do agendamento. Formato: "dd/mm/yy".
DADOS_SPLIT	AN	Dados para transação de Split de Pagamento, no formato JSON.

LISTA_PRODUTOS_ABASTECIMENTO

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

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"
        }
    ]
}

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"
    }
  ]
}

Output

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:

Parameter (output)	Tipo	Descrição
CARTAO_PREPAGO	A (1)	Indica se o cartão utilizado é pré-pago. Atualmente esta informação é retornada pela adquirente CIELO. ("S" - SIM; "N" - NÃO)
NSU_REDE_ADICIONAL	AN (32)	Para suportar valor de NSU das Redes com até 32 dígitos.