Diárias / Despesas de Viagem


Método responsável por realizar o estorno de uma carga avulsa vinculada ao cartão de um portador, desde que o saldo correspondente esteja disponível de forma integral no cartão.


Request


  • ENDPOINT: CargaAvulsa/Estornar
  • VERBO: POST


Índice Chave Descrição Elem. Tipo Ocor. Tamanho Versão
1 CNPJAplicacao CNPJ da Aplicação Para autenticação E Caractere 1-1 14 1.0
2 Token Gerado a partir do CNPJ de autenticação para validar permissões de acesso E Caractere 1-1 100 1.0
3 CNPJEmpresa CNPJ da Empresa para Autenticação ( mesmo CNPJAplicação ) E Caractere 1-1 14 1.0
4 NroControleIntegracao Código para identificação dos registros E Inteiro 1-0 100 1.0
5 IdCargaAvulsa Identificador da carga avulsa E Caractere 1-0 10 1.0


Deve ser informado o NroControleIntegracao ou IdCargaAvulsa, apesar de serem campos opcionais, deve ser informado ao menos um deles.


Modelo de Json - Request


{
  "CNPJAplicacao": "",
  "Token": "",
  "CNPJEmpresa": "",
  "NroControleIntegracao": "",
  "IdCargaAvulsa": 0
}


Response


Índice Chave Descrição Elem. Tipo Ocor. Tamanho Versão
1 Sucesso True: Caso não tenha acontecido nenhuma exceção ou validação no processo mesmo não trazendo dados no retorno
False: Quaisquer validações ou exceção não tratada pelo sistema que impediu o processo de ser concluído
E Booleano 1-1 True/False 1.0
2 Mensagem Mensagem com as validações e exceções E Caractere 0-1 100 1.0
3 Objeto Objeto pai contendo informações de retorno G 0-1 1.0
3.1 IdCargaAvulsa Código da carga avulsa E Inteiro 0-1 10 1.0
3.2 StatusPagamento Enum de status de pagamento, podendo ser:
1: Aberto;
2: Baixado;
3: Erro;
4: Pendente.
E Inteiro 1-1 1 1.0
3.3 ValorMovimentado Valor Estornado da Carga Avulsa E Decimal 0-1 18,2 1.0
3.4 CodigoRetorno Enum de retorno do status da carga avulsa, podendo ser:
0: Erro;
1: Sucesso;
2: CargaJaEstornada;
3: TransacaoPendente.
E Inteiro 1-1 1 1.0
4 Faults Objeto pai que contém uma lista de erro(s) ou aviso(s) caso aconteça A 0-1 1.0
4.1 Type Tipo de erro ou aviso, podendo ser eles:
1: Error;
2: Alert.
E Inteiro 0-1 1 1.0
4.2 Code Codigo do erro E Caractere 0-1 10 1.0
4.3 Message Mensagem do erro E Caracter 0-1 18,2 1.0


Modelo de Json - Response


{
  "Sucesso": true,
  "Mensagem": "",
  "Objeto": {
    "IdCargaAvulsa": 0,
    "StatusPagamento": 2,
    "ValorMovimentado": 0.0,
    "CodigoRetorno": 1
  },
   "Faults": [
    {
        "Type": 0,
        "Code": "",
        "Message": ""
    }    
  ]
}