Endpoint Meios de pagamento (finalizadores) (v1)
Descrição geral
Meios de pagamento (finalizadores)
URL
“/public-api/v1/commons/finalizador“
Verbos suportados
GET
Status HTTP
• 200 = OK;
• 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.
JSON Exemplo
{"id":1, "codigo":0, "abreviacao":"Texto", "tecla":0, "nome":"Texto", "entrada":0, "troco":0, "integracao":0, "tipodocumento":0, "venda":0, "recebimento":0, "cartaofidelidade":0, "recargacelular":0, "sangria":0, "valepresente":0, "adiantamento":0, "prepago":0, "ticketrefeicao":0, "garantiaestendida":0, "cliente":0, "tipoparcela":0, "valor":0, "imprimecheque":0, "tipoverificacao":0, "cpf":0, "data":0, "banco":0, "agencia":0, "conta":0, "emitente":0, "maximoparcelas":0, "tipodocumentoretaguarda":"Texto", "idtipodocumentodebito":1, "tipocobrancaretaguarda":"Texto", "tipovencimento":0, "tipoimpressao":0, "tiporetaguarda":0, "tipocartaoproprio":0, "formatocontaspagar":0, "valormaximo":"0.00", "tipoedicaoparcela":0, "pularparames":0, "doacao":0, "teclavenda":0, "teclarecebimento":0, "teclavalepresente":0, "diasuso":0, "quantidademaxima":0, "cartaofidelidadevalor":"0.00", "cartaofidelidadepontos":0, "modelocomprovante":"Texto", "valorminimoparcela":"0.00", "cadastracliente":0, "formapagamentonfce":"Texto", "linhasentreparcelas":0, "idplanoconta":1, "informarautorizacaopos":0, "agruparcentavosprimeiraparcela":0, "enviarmobilepdv":0, "finalizadorrapido":0, "enviaruniplusshop":0, "taxa":"0.00", "idadministradoracartao":1, "nomerede":"Texto", "idcontacorrente":1, "idtipodocumentovoucher":1, "percentualdesconto":"0.00", "percentualacrescimo":"0.00"}Exemplos
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/finalizador
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/commons/finalizador/${id}
Lista dos campos do JSON
| Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
|---|---|---|---|---|---|---|
| id | ID | Inteiro | ||||
| codigo | Código | Inteiro | ||||
| abreviacao | Abreviação do nome | Caractere | 20 | |||
| tecla | Número da tecla de função | Inteiro | ||||
| nome | Nome | Caractere | 50 | |||
| entrada | Habilitado para entrada de financiamento | Inteiro | ||||
| troco | Identifica se o meio de pagamento permite troco | Inteiro | ||||
| integracao | Tipo de Integração | Inteiro | ||||
| tipodocumento | Tipo do documento | Inteiro | ||||
| venda | Habilita o meio de pagamento para a operacao de venda | Inteiro | ||||
| recebimento | Habilita o meio de pagamento para a operação de recebimento | Inteiro | ||||
| cartaofidelidade | Habilita o meio de pagamento para a operação de resgate de produto do cartão fidelidade | Inteiro | ||||
| recargacelular | Habilita o meio de pagamento para a operação de recarga de celular | Inteiro | ||||
| sangria | Habilita o meio de pagamento para a operação de sangria | Inteiro | ||||
| valepresente | Habilita o meio de pagamento para a operação de vale presente | Inteiro | ||||
| adiantamento | Habilita o meio de pagamento para a operação de adiantamento | Inteiro | ||||
| prepago | Habilita o meio de pagamento para a operação de Pré-pago | Inteiro | ||||
| ticketrefeicao | Habilita o meio de pagamento para a operação de Ticket refeição | Inteiro | ||||
| garantiaestendida | Habilita o meio de pagamento para a operação de garantia estendida | Inteiro | ||||
| cliente | Identifica o cliente na operação | Inteiro | ||||
| tipoparcela | Tipo da parcela | Inteiro | ||||
| valor | Informa o valor do meio de pagamento | Inteiro | ||||
| imprimecheque | Imprime cheque para o meio de pagamento | Inteiro | ||||
| tipoverificacao | Tipo da verificação | Inteiro | ||||
| cpf | Identifica o CPF do cliente | Inteiro | ||||
| data | Identifica a data de emissão | Inteiro | ||||
| banco | Edita número do banco quando tipo do finalizador for cheque | Inteiro | ||||
| agencia | Edita número da agencia quando tipo do finalizador for cheque | Inteiro | ||||
| conta | Edita número da conta quando tipo do finalizador for cheque | Inteiro | ||||
| emitente | Edita o nome do emitente quando tipo do finalizador for cheque | Inteiro | ||||
| maximoparcelas | Número máximo parcelas | Inteiro | ||||
| tipodocumentoretaguarda | tipodocumentoretaguarda | Caractere | 3 | |||
| idtipodocumentodebito | Id do Tipo de documento financeiro quando for venda em TEF debito | Inteiro | ||||
| tipocobrancaretaguarda | Tipo de cobrança na retaguarda | Caractere | 3 | |||
| tipovencimento | Tipo de vencimento | Inteiro | ||||
| tipoimpressao | Tipo de impressão | Inteiro | ||||
| tiporetaguarda | Tipo da retaguarda | Inteiro | ||||
| tipocartaoproprio | Tipo do cartão próprio | Inteiro | ||||
| formatocontaspagar | Formato contas a pagar | Inteiro | ||||
| valormaximo | Valor máximo permitido | Decimal | 12 | 2 | ||
| tipoedicaoparcela | Tipo edição parcela | Inteiro | ||||
| pularparames | Identifica se o meio de pagamento pula o mês para da promoção | Inteiro | ||||
| doacao | Habilita o meio de pagamento para de doação | Inteiro | ||||
| teclavenda | Número da tecla de função quando venda ou 0=default | Inteiro | ||||
| teclarecebimento | Número da tecla de função quando recebimento ou 0=default | Inteiro | ||||
| teclavalepresente | Número da tecla de função quando vale presente ou 0=default | Inteiro | ||||
| diasuso | Número de dias para uso do documento | Inteiro | ||||
| quantidademaxima | Quantidade máxima permitida | Inteiro | ||||
| cartaofidelidadevalor | O valor base para cálculo de pontos do cartão fidelidade | Decimal | 12 | 2 | ||
| cartaofidelidadepontos | Número de pontos para o cartão fidelidade, conforme o valor definido | Inteiro | ||||
| modelocomprovante | Modelo de impressão do comprovante | Caractere | ||||
| valorminimoparcela | Valor mínimo da parcela | Decimal | 12 | 2 | ||
| cadastracliente | Possibilita cadastrar cliente caso ele não exista | Inteiro | ||||
| formapagamentonfce | Forma de pagamento para a NFC-e | Caractere | 2 | |||
| linhasentreparcelas | Quantidade de linhas que irão separar uma parcela da outra | Inteiro | ||||
idplanoconta | ID do plano de conta | Inteiro | ||||
| informarautorizacaopos | Informar número de autorização do POS | Inteiro | ||||
| agruparcentavosprimeiraparcela | Agrupa os centavos das demais parcelas na primeira | Inteiro | ||||
| enviarmobilepdv | Enviar finalizador para mobile PDV | Inteiro | ||||
| finalizadorrapido | Define como finalizador rápido no mobile PDV | Inteiro | ||||
| enviaruniplusshop | Enviar finalizador Uniplus shop | Inteiro | ||||
| taxa | Percentual da taxa cobrada pelo meio de pagamento | Decimal | 5 | 2 | ||
| idadministradoracartao | ID da administradora cartão/Carteira digital | Inteiro | ||||
| nomerede | Nome da administradora cartão/Carteira digital | Caractere | 50 | |||
idcontacorrente | ID da conta corrente | Inteiro | ||||
| idtipodocumentovoucher | ID do Tipo de documento financeiro quando for venda em TEF voucher | Inteiro | ||||
| percentualdesconto | Percentual desconto aplicado para o meio de pagamento | Decimal | 5 | 2 | ||
| percentualacrescimo | Percentual acréscimo aplicado para o meio de pagamento | Decimal | 5 | 2 |
Conteúdo Relacionado
Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• API Rest (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda