Arquivo de Taxas Processado

Quando o processamento de um arquivo de taxas é finalizado, nós disparamos um evento para indicar a conclusão dessa operação.

Caso o arquivo de taxas contenha algum erro retornamos o campo success como false e informamos o motivo no campo detail.

Path: /tax-file

Webhook payload object

ChaveTipoDescrição

taxFileId


string

Identificador do arquivo de taxas.

buyerId


integer

Identificador do investidor

success


boolean

Resultado do processamento.
Em caso de sucesso: true e em caso de falhas false


detail


string

Caso ocorram falhas no processamento do arquivo este campo será preenchido com o detalhamento do erro.


_links


object

Recursos disponíveis através de HATEOAS.
Para saber mais clique aqui.

Recursos disponíveis são:
buyer - Listar dados do investidor.
taxFile - Listar dados da planilha de taxas processada.

Webhook payload example

{
   "taxFileId":"hBslrLUoL1",
   "buyerId":123,
   "success":false,
   "detail":"Detalhe do erro de processamento",
   "_links":{
      "buyer":{
         "href":"https://zuul.monkeyecx.com/v2/buyers/123",
         "type":"GET"
      },
      "taxFile":{
         "href":"https://zuul.monkeyecx.com/v2/buyers/123/buyer-tax-file/hBslrLUoL1",
         "type":"GET"
      }
   }
}