Webhook

Sempre que ocorrer uma alteração de uma transação, o Webhook da Clearsale irá enviar uma notificação para uma URL que deverá ser implementada no lado do integrador. Veja a documentação que preparamos e saiba como realizar a implementação desse módulo.

Modelo de Chamada

Response:

POST {URL cadastrada} HTTP/1.1
Content-Type: application/json; charset=utf-8
{ 
  "type": 1, 
  "transactionId": "ab1234a1234567ab1a12a123a123456a", 
  "identifierId": "id-unico-controlado-pelo-cliente", 
  "processStatusCode": 2, 
  "processStatus": "Concluído", 
  "statusCode": 3, 
  "status": "Sem risco aparente", 
  "receivedDate": "2023-01-01T12:23:56.8604437", 
  "endDate": "2023-01-00T12:25:00.2732407", 
  "ocr": [ 
    { 
      "tag": "name", 
      "value": "NOME DO CLIENTE COMPLETO" 
    }, 
    { 
      "tag": "motherName", 
      "value": "NOME DA MÃE COMPLETO" 
    }, 
    { 
      "tag": "birthDay", 
      "value": "01/01/1980" 
    }, 
    { 
      "tag": "cpf", 
      "value": "12345678910" 
    }, 
    { 
      "tag": "releaseDate", 
      "value": "10/01/2000" 
    }, 
    { 
      "tag": "rg", 
      "value": "01.123.456-7" 
    }, 
    { 
      "tag": "issuerAgency", 
      "value": "SSP" 
    }, 
    { 
      "tag": "documentState", 
      "value": "UF" 
    }, 
    { 
      "tag": "origin", 
      "value": "CIDADE-UF CIDADE CN: LV. A01 /FLS.123 /N.012345" 
    }, 
    { 
      "tag": "birthPlace", 
      "value": "CIDADE-UF" 
    } 
  ],
  "isDigital": false  
}