DocumentaçãoReferência APIFórumGrafeno API Collection - Postman
Cadastro Conta StagingLogin Conta Staging

Webhooks Grafeno Titularidades

Eventos de notificações da API para gestão de Titularidades.

Os webhooks são notificações enviadas pela Grafeno para seu sistema sempre que algum recurso tenha o seu status alterado.

Body Params

ParâmetroDescriçãoFormato
signatureAssinatura criptografada para garantir a origem da informação.string
changeReferência da alteração de status.string
data.createdAtData de aprovação ou rejeição da cessão.Date
data.updatedAtData da última alteração na solicitação de captura.Date
data.statusStatus da captura de título.string
data.typeTipo de recurso, neste caso "catching".string
data.fromAccount.data.idId da conta de origem do título.string
data.fromAccount.data.typeTipo da conta de origem do título.string
data.fromAccount.data.attributes.bankCodeCódigo do banco da conta de origem do título.string
data.fromAccount.data.attributes.agencyAgência da conta de origem do título.string
data.fromAccount.data.attributes.accountNumberNúmero da conta de origem do título.string
data.fromAccount.data.attributes.documentNumberDocumento do titular da conta de origem do título.string
data.toAccount.data.idId da conta destino.string
data.toAccount.data.typeTipo da conta destino.string
data.toAccount.data.attributes.bankCodeCódigo do banco da conta destino.string
data.toAccount.data.attributes.agencyAgência da conta destino.string
data.toAccount.data.attributes.accountNumberNúmero da conta destino.string
data.toAccount.data.attributes.documentNumberDocumento do titular da conta destino.string
data.access.data.idId do acesso a base de cobranças do cedente.string
data.access.data.typeTipo de recurso, neste caso "access".string
data.access.data.attributes.createdAtData de solicitação do acesso a base de cobranças do cedente.Date
data.access.data.attributes.updatedAtData de atualização do acesso a base de cobranças do cedente.Date
data.access.data.attributes.expiresAtData de expiração do acesso a base de cobranças do cedente.Date
data.access.data.attributes.statusStatus da permissão de acesso a base de cobranças do cedente.string
data.access.data.attributes.agreeTypeTipo de aprovação de captura de cobranças. manual ou automatic.string
data.charges.data.idId da cobrança que está em processo de captura ou cessão.string
data.charges.data.typeTipo de recurso, neste caso "charges".string
data.charges.data.attributes.clientControlNumberNúmero de controle da cobrança gerado pelo cedente.string
data.charges.data.attributes.receiptNumberNúmero da chave da nota fiscal que serve como lastro da operação.string
data.charges.data.attributes.statusStatus da cobrança.string
data.charges.data.attributes.valueValor da cobrança.string
data.charges.data.attributes.dueDateData de vencimento da cobrança.Date
data.charges.data.attributes.transferStateEstado da cessão, determina se a cobrança foi ou não capturada.string
data.charges.data.attributes.payer.data.typeTipo de recurso, neste caso "payer".string
data.charges.data.attributes.payer.data.attributes.nameNome do pagador da cobrança.string
data.charges.data.attributes.payer.data.attributes.documentNumberDocumento do pagador da cobrança.string
data.charges.data.attributes.payer.data.attributes.emailE-mail do pagador da cobrança.string

Eventos de notificação para o Titularidades

EventoDescrição
pendingA solicitação de acesso a base de cobranças do cedente está pendente de autorização.
activeA solicitação de acesso a base de cobranças do cedente está autorizada e ativa.
approvedA solicitação de captura de títulos foi processada e aprovada com êxito.
rejectedA solicitação de captura de títulos foi rejeitada pelo cedente.

Eventos

{
  "signature": "mbYGEPYOOIxcqdpBygG11gfLvpUThQ3bwspfb8+Wv0AoflM4eaFwSiYaE0Y7\nmCdJ9Dfk3ureAHLSDPSsu1xMen2xiyr2ezHAf3R4zXuSjiL2xpUG1z/QCGkV\ng4hYLAKE+AGfRZgE4SUqu5NpzVAjQjSDPmyOKqL9gB0baUAs6svbgOdxArjm\n9mj04xmuUkb4w76SktSbEI8a0+ovI+KK+k01WEUparCNlZ2zCyQj+O9LdWw3\nAOBEm9CxFmi9QzLt36aUzqZMGt5LC6NhzsadibV9BlakxAK+3MEfmyrBIwUN\nnoJ1QRgNFPMHl4rZm4RNRJ2SQAsg6M9hSNb6BEesAVG6oXAkL9qieTz+ELww\ncGSiz+FEWiPRWZ3mn0dmA8ns3sxcmtRZPOjmMN77MkDm3lAbBZhRcA2CM4kf\n6/55F8TB+WdI1DGim43IqnyD+FjRz/dPJ5I7nRGzUHByMssG9dwOJyg3USLc\nYoiR1dDDYSSBpZCZlTTD28lF7z9ByJ4yGrpGvvS1A5SiZAq5wfLWMona58+7\nMyrKK84lvQngLQQwZCcHpaWbFh7NOQo8eMD7w2pQP8C/+sRx5ujvb3de8Fvc\n635O2/wsi+3caqSi4DGE5B/LGajxThrWbrVli0LzHLfqFpmyDXKaKjU+H+Py\nERRKFI8nbF8qzT0Kz5AxFDY=\n",
  "change": "status-alterado",
  "data": {
    "createdAt": "2023-07-19T20:45:18.986-03:00",
    "updatedAt": "2024-02-07T13:16:44.130-03:00",
    "expiresAt": "2024-02-23",
    "status": "pending",
    "agreeType": "manual"
  }
}

{
  "signature": "N6yim9dlZ1Hqk0Zad6PrTV80EOsTHTTTG5tSjNQC84iYRUWx/jPSm4mRIP3y\nsTV8TIUUSoIm94+l3CtGR7L7dOuZWHAjiM9p+bxVIVIp8hD5eDyB4Tk+74lK\nJ1QUFMbz4b+5cSYfCuNNoJtNGpodEBZFSuKY5BIXMbWAj8U3WWYm86jd+k7T\nmcBJlo18xMCTlOBdxlcHwoLyU3BVRSA1VXQeIkjtnmL1QfcSp/9XAFD+xv0j\nP9F9bs39kLNrHV2GhiUZXdRVEo1Sjf2BOiEHwrCJsHOnLJaXLZ+8iCdVjCZV\nB+Fd72zfaY4yKwHVpHdQFmDe96AVlYxu9t/v0YDwfkLjhHhMST4HLQDVH9rs\nDic9DUmVYnByGrUL+ZGDcTqdk628lqrd7SQYv7/DoESk2sokPTEDVRMkLx7d\n9HEpEtBgPsQx4l8vqhLZkoxY95Y1ikMf81HhfsB0paxsbYjksRntp3yo7fI1\nQVs8mV1uDUz7Gi2Q4OnfMo88GlZxBesYDtKHVLIizFm+bOYG0hCJrNH/vsaH\ni9wJGkB4hdp5h3IkBDDH02OCDI/Qm/fD50Exu/67loaKzNgxQsKhHcKGZfYO\nF0Ly5/O2KPQiVYfN/tXcquW4gm8jWyHUBeapJxxQXrLjIuiEWgoNN11UFlaX\n6aLiVTWroS6FCcecCGx4Bqw=\n",
  "change": "status-alterado",
  "data": {
    "createdAt": "2023-07-19T20:45:18.986-03:00",
    "updatedAt": "2024-02-07T13:19:26.403-03:00",
    "expiresAt": "2024-02-29",
    "status": "active",
    "agreeType": "automatic"
  }
}


{
  "signature": "cG0el+icN8meKNvfALOu7AoNlknxpI95rTZH3UuC5iel7i7QsNfo7NicwFSg\nsnFtjPqzUPSZ0iY9be80Ez1LhxugkrMoOjtoWvDpXaTfhEW2Aafbnu0srQUx\n8U3lgMZ/h40TAA/6b/g1g0NMRy43s4G5/TwO819+AetaUEzBUpQd4AB/YIF5\nXgkQ+Nl5xfXIqOK7/m2rREPO6qlnp0ynNZezdAoSnImkvMwapb5BEO9idL/q\nQHXlyMEoAapGmcP53KHnMdX8feBVrOGGlmgyy0zrz63wz6lyfJNgA0TTbv0c\n2F+XdzoMJEBSV1sh6QAofNGRGUlspWvuFRRvW4wUflNBO7elK80rMppF21ol\n9yggLm+/HCwNidN5hJq/Mf+7zMT1XfEAnia3oqpJNvUznKxbBxWVIrRbuNuJ\nRH2BHCaAUwV2JjFNaVAQQ0iNMjk7xGo8RoKNptuCfZWPW3kzwDZCHvobYhYN\n5zx8+Zg9PVPKnzLChnVK235aM1FwSRQEXbMmXYdieM8rYDgyWjNPy8I0Obhz\n3HMXSUvxPNo4CZ565mmywCpboprd9LL7jmD+ojT9pcBj1pOMPriiHF2I8gVW\njhLHzY2PyBmblMWrBJhuuyzi7CsOCKX3NaHbTjeMMvOOhDr6Qz/EMeXpZoRF\nLCRTQEZnYupxo7ChfjshtFA=\n",
  "change": "status-alterado",
  "data": {
    "createdAt": "2024-02-07T13:22:18.189-03:00",
    "updatedAt": "2024-02-07T13:22:18.727-03:00",
    "status": "approved",
    "type": "catching",
    "fromAccount": {
      "data": {
        "id": "8146972",
        "type": "account",
        "attributes": {
          "bankCode": "274",
          "agency": "0001",
          "accountNumber": "08146972-8",
          "documentNumber": "08470974000140"
        }
      }
    },
    "toAccount": {
      "data": {
        "id": "8124695",
        "type": "account",
        "attributes": {
          "bankCode": "274",
          "agency": "0001",
          "accountNumber": "08124695-1",
          "documentNumber": "26095465000167"
        }
      }
    },
    "access": {
      "data": {
        "id": "2d771286-272d-4abf-861d-30c3d3fe9281",
        "type": "access",
        "attributes": {
          "createdAt": "2023-07-19T20:45:18.986-03:00",
          "updatedAt": "2024-02-07T13:22:18.293-03:00",
          "expiresAt": "2024-02-29",
          "status": "active",
          "agreeType": "automatic"
        }
      }
    },
    "charges": {
      "data": [
        {
          "id": "d96643c5-6929-4044-83a5-9dcfd699c3d2",
          "type": "charge",
          "attributes": {
            "clientControlNumber": "CHARGE-123ABC",
            "receiptNumber": "51080701212344000127550010000000981364117781",
            "status": "pending",
            "value": "200000.0",
            "dueDate": "2024-02-27",
            "transferState": "transferred",
            "payer": {
              "data": {
                "type": "payer",
                "attributes": {
                  "name": "Michael Gary Scott",
                  "documentNumber": "70775088000107",
                  "email": "[email protected]"
                }
              }
            }
          }
        }
      ]
    }
  }
}

{
  "signature": "rhiynNu3AKHU7ssMJdDwrdZIZMn3/XlLT+OSL8xfXwCqmIWjpUcjX3ws9Gzw\nfSK+x8gNDX8QtW5NHNNbNy/zLzQndrL28TxyGJVS+HqgHLALYlcw3pT8nnyQ\nn7NirrCGiWt5fSRXkEq5KV2DEYb+rZ1vpX5Trto7jz32obxFCUJ+iabCoTKQ\nEJcfzpOcEOk7M7JXHBNE5UCdNR7j2lgDnrTZgIvPyXtWpzTGaBCUzOKG+q0v\nWatdEAm2dbMNRed8/KL4N49zaQwmt13Qa89a5tPadkQpaU0FC+JxvE7+tlyE\nA4tk0+gR7vIOOmDAA8S8HNdZl8hAvmgauK4WQmaDJ4MixlJhSpLqrEPeiwM3\nVP7gZ6XeNG7P0gETTL3EJFp58C0Z1RttVGd1aq2p95Rt8rsseVEdCRQexyKH\nUNXHD6IAh5ISNkkNTzSUpM6sDwmhUq1cmY8nS/5NjIgVoOCxAJfID5/3Ljst\nOVpUjOR+JCxw+1O2mKXLOmBb/aHnbuw2a3yg5sxK9/eSig2oUCmtxoJ23FSU\n+jqYl5l3SOI5nH6grX1MLpTRTW4BaphKZ5vPC7lvHq5bhB3jK4dPEAAvoj3j\nQ4nFlnGcK4t6k4t3xtqCDISYB9kPQL+0ceNYqRGPy2NuXeMXY135POUlFb+F\nM/44Np5NHkC3j1GFjIRYnHM=\n",
  "change": "status-alterado",
  "data": {
    "createdAt": "2024-02-07T13:29:16.027-03:00",
    "updatedAt": "2024-02-07T13:30:28.508-03:00",
    "status": "rejected",
    "type": "catching",
    "fromAccount": {
      "data": {
        "id": "8146972",
        "type": "account",
        "attributes": {
          "bankCode": "274",
          "agency": "0001",
          "accountNumber": "08146972-8",
          "documentNumber": "08470974000140"
        }
      }
    },
    "toAccount": {
      "data": {
        "id": "8124695",
        "type": "account",
        "attributes": {
          "bankCode": "274",
          "agency": "0001",
          "accountNumber": "08124695-1",
          "documentNumber": "26095465000167"
        }
      }
    },
    "access": {
      "data": {
        "id": "2d771286-272d-4abf-861d-30c3d3fe9281",
        "type": "access",
        "attributes": {
          "createdAt": "2023-07-19T20:45:18.986-03:00",
          "updatedAt": "2024-02-07T13:29:16.071-03:00",
          "expiresAt": "2024-03-08",
          "status": "active",
          "agreeType": "manual"
        }
      }
    },
    "charges": {
      "data": [
        {
          "id": "d96643c5-6929-4044-83a5-9dcfd699c3d2",
          "type": "charge",
          "attributes": {
            "clientControlNumber": "CHARGE-123ABC",
            "receiptNumber": "51080701212344000127550010000000981364117781",
            "status": "pending",
            "value": "200000.0",
            "dueDate": "2024-02-27",
            "transferState": "rejected",
            "payer": {
              "data": {
                "type": "payer",
                "attributes": {
                  "name": "Michael Gary Scott",
                  "documentNumber": "70775088000107",
                  "email": "[email protected]"
                }
              }
            }
          }
        }
      ]
    }
  }
}