Nesta seção, são documentados os eventos disponíveis na plataforma, juntamente com exemplos de chamadas para os endpoints inscritos

Lista de Eventos Pagamentos Programados (Bills)

EventoDescrição
bill_createdPagamento programado
bill_approvedPagamento aprovado
bill_approval_undoneAprovação de pagamento desfeita
bill_conciliatedPagamento conciliado com o contexto bancário
bill_unconciliatedConciliação de pagamento desfeita de forma manual
bill_deletedPagamento deletado
bill_payment_receipt_addedAnexo adicionado

Lista de Eventos Recebimentos Programados (Receivables)

EventoDescrição
receivable_createdRecebimento programado
receivable_conciliatedRecebimento conciliado com o contexto bancário
receivable_unconciliatedConciliação de recebimento desfeita de forma manual
receivable_deletedRecebimento deletadoo

Exemplo de Retorno

Importante: o formato de cada payload pode variar dependendo do contexto do evento e entidade.

Evento - Pagamento Programado (Bill)

{
  "id": "outgoing_event_adt3o5d4p5cjzo",
  "object": "outgoing_event",
  "event": "bill_conciliated",
  "payload": {
    "account_id": "account_rbd3ig4qkbwzoxd4q",
    "amount": 1000,
    "approval_type": "any",
    "assignees": [
      {
        "email": "[email protected]",
        "id": "user_ff3mwexhuvhiuuqhm",
        "name": "User name",
        "object": "user",
        "status": "active"
      }
    ],
    "attachments": [
      {
        	"id": "attachment_2uirlgz6orclbpwckxlv3f3gcm",
        	"name": "relatorio.pdf",
        	"object": "attachment",
        	"type": "application/pdf"
      	}
    ],
    "category_id": "category_vbemmoyfu6mozbr6fu",
    "classifications": [
      {
        "classification_id": "classification_4b76woy74nihoi",
        "labels_ids": ["label_6zgsv6yud6a6vb6laea"],
        "object": "classification"
      },
      {
        "classification_id": "classification_wfxfkbvb",
        "labels_ids": ["label_pzevwnger"],
        "object": "classification"
      }
    ],
    "contact_id": "contact_itg2divyauvx3sqy5u",
    "date": "2023-11-29",
    "description": "Descrição",
    "external_id": null,
    "id": "bill_g6tmyaq3gqbd6av31qle",
    "object": "bill",
    "observations": null,
    "payment_method": {
      "detail": {"pix_key": "00000000000", "pix_type": "cpf"},
      "type": "pix"
    },
    "relevant_date": "2024-06-01"
  },
  "happened_at": "2024-06-12T19:35:54.883381Z"
}

Evento: Recebimento Programado (Receivable)

{
  "id": "outgoing_event_2jwilphhi5ayhenoy",
  "object": "outgoing_event",
  "event": "receivable_created",
  "payload": {
    "account_id": "account_wverbcbks33krvtywljw",
    "amount": 10000,
    "attachments": [
      {
        	"id": "attachment_2uirlgz6orclbpwckxlv3f3gcm",
        	"name": "relatorio.pdf",
        	"object": "attachment",
        	"type": "application/pdf"
      	}
    ],
    "category_id": "category_t7eezch5hpsdukcgejjre",
    "classifications": [
      {
        "classification_id": "classification_4a76why7mndcxmihoi",
        "labels_ids": ["label_tpgvs3ns2ffsci4lm"],
        "object": "classification"
      },
      {
        "classification_id": "classification_4wfxzrfxbvb3jxwj5jq",
        "labels_ids": ["label_gbrxwfvjguehabjgyemre"],
        "object": "classification"
      }
    ],
    "contact_id": "contact_4wem7myjlvbw3f21gqm",
    "date": "2024-04-11",
    "description": "Descrição",
    "external_id": null,
    "id": "receivable_hwhbtmzr2cjtn",
    "object": "receivable",
    "observations": null,
    "relevant_date": "2024-03-01"
  },
  "happened_at": "2024-06-12T19:35:54.883381Z"
}

Legenda dos campos enviados no payload

CampoTipoDescrição
eventStringEvento que acionou o envio do webhook
account_idStringIdentificador único da conta
account_numberStringNúmero da conta
branch_numberStringNúmero da agência
routing_numberStringCódigo identificador do banco (COMPE)
amountIntegerValor de entrada ou saída
category_idStringIdentificador único da categoria
classificationsArrayObjectsInformações sobre classificações e etiquetas
contact_idStringIdentificador único do contato
dateDateData de pagamento ou de recebimento
descriptionStringDescrição
external_idStringIdentificador opicional de correlação
idStringIdentificador único do pagamento ou recebimento
observationsStringObservações
payment_methodObjectInformações sobre o método de pamento (pix, boleto)
relevant_dateDateData relacionada ao mês de competência
happened_atDateData que ocorreu o evento