Á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,
        "codigoModalidadePagamentocodigoTef": 0,
        "tipo ": 0,
        "tipoCliente": 0,
        "formasPagtoCondicoes": [
            {
                "idRetaguarda": "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

descricaostringDescrição da forma de pagamento

Obrigatório

Tamanho Máximo: 50 caracteres

descricaoString
descricaoFiscalstring
Descrição
fiscal
da
forma
operadora de pagamento

Obrigatório

Tamanho

Máximo

máximo:

50

100 caracteres

permiteTrocoInt

Indica se a forma de pagamento permite troco (0 - Não; 1 -

Sim

)ObrigatórioidRetaguardaFormaPagTrocostringIdentificador da forma de pagamento troco na retaguarda

Obrigatório

Tamanho Máximo: 100 caracteres

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

Obrigatório

Tamanho Máximo: 50 caracteres

situacao
integer
IntSituação da
forma de pagamento
operadora (0 - Inativo, 1 - Ativo)
Caso não enviado será cadastrado como

0

codigoModalidadePagamentointegerCódigo da modalidade de pagamentoOpcionaltipointegerTipo da forma de pagamento (Descrição abaixo)ObrigatóriotipoClienteintegerTipo clienteOpcionalformasPagtoCondicoesLista de objetosLista de condições de forma de pagamentoOpcionalformasPagtoCondicoes.idRetaguardastringIdentificador da condição na retaguardaOpcionalformasPagtoCondicoes.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcionalformasPagtoCondicoes.idRetaguardaCondicaoPagtostringIdentificador da condição de pagamento na retaguardaOpcionalformasPagtoCondicoes.situacaointegerSituação da condição de pagamento (0

- Inativo, 1 - Ativo

)

Opcional

Sim

formasPagtoDadosComplementares
codigoTef
Lista de objetosLista de Dados complementares da forma
StringCódigo Tef da operadora de pagamento
OpcionalformasPagtoDadosComplementares.idRetaguardastringIdentificador do dado complementar na reguardarOpcionalformasPagtoDadosComplementares.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcionalformasPagtoDadosComplementares.idRetaguardaDadoComplementarPagtostringIdentificador do dado complementar pagamento na retaguardaOpcionalformasPagtoDadosComplementares.situacaointegerSituação do dado complementar (0 - Inativo, 1 - Ativo)OpcionalformasPagtoDadosComplementares.ordemintegerOrdem do dado complementarOpcionalformasPagtoOperadorasLista de objetosLista de operadoras da forma de pagamentoOpcionalformasPagtoOperadoras.idRetaguardastringIdentificador da operadora na retaguardaOpcionalformasPagtoOperadoras.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcionalformasPagtoOperadoras.idRetaguardaOperadoraPagtostringIdentificador da Operadora pagamento na retaguardaOpcionalformasPagtoOperadoras.situacaointegerSituação da operadora (0 - Inativo, 1 - Ativo)OpcionalformaPagtoModeloFiscalLista de objetosLista de modelos fiscaisOpcionalformaPagtoModeloFiscal.idRetaguardastringIdentificador do modelo na retaguardaOpcionalformaPagtoModeloFiscal.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcionalformaPagtoModeloFiscal.modeloFiscalstringModelo fiscalOpcionalformaPagtoModeloFiscal.codigoFiscalstringCódigo fiscalOpcionalformaPagtoModeloFiscal.descricaoFiscalstringDescrição fiscalOpcionalformaPagtoModeloFiscal.situacaointegerSituação do modelo fiscal (0 - Inativo, 1 - Ativo)OpcionalidInquilinostringIdentificador do inquilinoObrigatórioidRetaguardastringIdentificador da forma de pagamento na retaguardaObrigatórioidProprietariostringIdentificador do proprietárioObrigatórioloteOrigemstring

Identificador do lote

Obrigatório para a integração
Expandir
titleTipoFormaPagto

Tamanho máximo: 30 caracteres

Não

administradoraStringAdministradora da operadora de pagamento

Tamanho máximo: 100 caracteres

Não

tipoTransacaoIntTipo de transação 


CódigoTipo
0Credito
1Debito
CódigoTipo
0Credito
1Debito
Sim
idInquilinoStringIdentificador do inquilin
Sim
idRetaguardaStringIdentificador da operadora na retaguarda
Sim
idProprietarioStringIdentificador do proprietário
Sim
loteOrigemStringIdentificador do lote em que serão enviados os dados
Sim
CódigoTipo0Outros1Dinheiro2Credito3Debito4Cheque5POS6Troca8Gift10QRCode



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