Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Este método é responsável pela criação de novos FormaPagtonovas operadoras

  • Endpoint: /api/retaguarda/v2/FormaPagtosOperadoras
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Este endpoint recebe uma lista de FormaPagtos Operadoras para que possam ser enviados vários na mesma requisição

Aviso

Para que a baixa do FormaPagto criado da Operadora criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  18 15 = FormaPagto Operadora

Expandir
titleExemplo de body da requisição

[
    {
        "descricao": "string",
        "descricaoFiscal": "string",
        "permiteTroco": 0,
        "idRetaguardaFormaPagTroco": "string",
        "valorMinimoAceito": "string",
        "codigoSistemaExterno": "string",
        "situacao": 0,
        "codigoModalidadePagamento": 0,
        "tipo": 0,
        "tipoCliente": 0,
        "formasPagtoCondicoes": [
            {
                "idRetaguarda""codigoTef": "string",
                "idRetaguardaFormaPagtoadministradora": "string",
                "idRetaguardaCondicaoPagto": "string",
                "situacao": 0
            }
        ],
        "formasPagtoDadosComplementares": [
            {
                "idRetaguarda": "string",
                "idRetaguardaFormaPagto": "string",
                "idRetaguardaDadoComplementarPagto": "string",
                "situacao": 0,
                "ordem": 0
            }
        ],
        "formasPagtoOperadoras": [
            {
                "idRetaguarda": "string",
                "idRetaguardaFormaPagto": "string",
                "idRetaguardaOperadoraPagto": "string",
                "situacao": 0
            }
        ],
        "formaPagtoModeloFiscal": [
            {
                "idRetaguarda": "string",
                "idRetaguardaFormaPagto": "string",
                "modeloFiscal": "string",
                "codigoFiscal": "string",
                "descricaoFiscal": "string",
                "situacao": 0
            }
        ],
        "tipoTransacao": 0,
    "idInquilino": "string",
        "idRetaguarda": "string",
        "idProprietario": "string",
        "loteOrigem": "string"
    }
]

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

descricaostringStringDescrição da forma operadora de pagamento

Obrigatório

Tamanho Máximo: 50 caracteres

descricaoFiscalstringDescrição fiscal da forma de pagamento

Obrigatório

Tamanho Máximo: 50 caracteres

permiteTrocoIntIndica se a forma de pagamento permite troco (0 - Não; 1 - Sim)Obrigatório
idRetaguardaFormaPagTrocostringIdentificador da forma de pagamento troco na retaguarda

Obrigatório

Tamanho Máximo: 100 caracteres

valorMinimoAceitostringValor mínimo aceita para a forma de pagamentoOpcional
codigoSistemaExternostringCódigo Sistema Externo

Obrigatório

Tamanho Máximo: 50 máximo: 100 caracteres

situacaointegerIntSituação da forma de pagamento operadora (0 - Inativo, 1 - Ativo)

Opcional

Caso não enviado será cadastrado como 0

codigoModalidadePagamentocodigoTefintegerStringCódigo Tef da modalidade operadora de pagamentoOpcionaltipointegerTipo da forma de pagamento (Descrição abaixo)

Obrigatório

tipoClienteintegerTipo clienteOpcional
formasPagtoCondicoesLista de objetosLista de condições de forma de pagamentoOpcional
formasPagtoCondicoes.idRetaguardastringIdentificador da condição na retaguardaOpcional
formasPagtoCondicoes.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcional
formasPagtoCondicoes.idRetaguardaCondicaoPagtostringIdentificador da condição de pagamento na retaguardaOpcional
formasPagtoCondicoes.situacaointegerSituação da condição de pagamento (0 - Inativo, 1 - Ativo)Opcional
formasPagtoDadosComplementaresLista de objetosLista de Dados complementares da forma de pagamentoOpcional
formasPagtoDadosComplementares.idRetaguardastringIdentificador do dado complementar na reguardarOpcional
formasPagtoDadosComplementares.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcional
formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagtostringIdentificador do dado complementar pagamento na retaguardaOpcional
formasPagtoDadosComplementares.situacaointegerSituação do dado complementar (0 - Inativo, 1 - Ativo)Opcional
formasPagtoDadosComplementares.ordemintegerOrdem do dado complementarOpcional
formasPagtoOperadorasLista de objetosLista de operadoras da forma de pagamentoOpcional
formasPagtoOperadoras.idRetaguardastringIdentificador da operadora na retaguardaOpcional
formasPagtoOperadoras.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcional
formasPagtoOperadoras.idRetaguardaOperadoraPagtostringIdentificador da Operadora pagamento na retaguardaOpcional
formasPagtoOperadoras.situacaointegerSituação da operadora (0 - Inativo, 1 - Ativo)Opcional
formaPagtoModeloFiscalLista de objetosLista de modelos fiscaisOpcional
formaPagtoModeloFiscal.idRetaguardastringIdentificador do modelo na retaguardaOpcional
formaPagtoModeloFiscal.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcional
formaPagtoModeloFiscal.modeloFiscalstringModelo fiscalOpcional
formaPagtoModeloFiscal.codigoFiscalstringCódigo fiscalOpcional
formaPagtoModeloFiscal.descricaoFiscalstringDescrição fiscalOpcional

Tamanho máximo: 30 caracteres

administradoraStringAdministradora da operadora de pagamento

Obrigatório

Tamanho máximo: 100 caracteres

tipoTransacaoIntTipo de transação (Descrição abaixoformaPagtoModeloFiscal.situacaointegerSituação do modelo fiscal (0 - Inativo, 1 - Ativo)Opcional
idInquilinostringStringIdentificador do inquilinoinquilinObrigatório
idRetaguardastringStringIdentificador da forma de pagamento operadora na retaguardaObrigatório
idProprietariostringStringIdentificador do proprietárioObrigatório
loteOrigemstringStringIdentificador do lote em que serão enviados os dadosObrigatório para a integração
Expandir
titleTipoFormaPagtoTipoTransacao
CódigoTipo
0
Outros
Credito
1
Dinheiro
2Credito
3
Debito
4Cheque5POS6Troca8Gift10QRCode
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Expandir
title400 - Bad Request

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro