Eventos

Inscreva-se neste evento através do endpoint de Criar URL.

Todos os eventos são enviados através de uma requisição HTTP/HTTPS POST com o formato JSON no payload.

Seu endpoint precisa retornar um status code de sucesso na resposta, sendo (2xx) um formato válido, assim consideraremos como entregue. Caso contrário, vamos retentar entregar a notificação mais 2 vezes, depois disso, não vamos mais tentar entregar a notificação deste evento.

O exemplo abaixo é um exemplo de um payload de evento que enviamos.

Account

{
  "id": "7d3aae40-6655-4d9a-801b-d0ab7ae906d7",             // Event ID
  "version": "v1",                                          // Event payload schema version
  "account_id": "d95e7630-1b3c-4ac5-991d-d599d75efdd0",     // Event digital account id
  "object": "Account",                                      // Event object type
  "date": "2019-10-01T17:54:39.000Z",                       // Event date and time
  "data": {                                                 // Event Payload
    "id": "1edde27b-b017-666c-9592-230f7c3bd74e",           // Account id
    "created_at": "2023-04-18T20:29:34.087947Z",            // Account creation date
    "updated_at": "2023-04-18T20:30:00.897026Z",            // Timestamp of when the account was last updated
    "status": "active",                                     // Account status
    "branch_number": "4099",                                // Account branch number
    "account_number": "27406",                              // Account number
    "name": "John Doe",                                     // Account holder name
    "tax_id": "55221579000104",                             // Account holder tax ID
    "activated_at": "2023-04-18T17:30:00.897026899-03:00",  // Account activation date
    "blocked_at": null,                                     // Account block date
    "closed_at": null,                                      // Account close date
    "address": {                                            // Account holder address
      "street_address": "Rua teste, 10. Apto 201",
      "postal_code": "81020000",
      "city": "Joinville",
      "state": "SC",
      "country": "BR"
    },
    "partners": [                                           // Account holder partners
      {
        "tax_id": "58555981107",                            // Account holder partner tax id
        "address": {                                        // Account holder partner address
          "street_address": "Rua teste, 123. Apto 201",
          "postal_code": "456def",
          "city": "Joinville",
          "state": "SC",
          "country": "BR"
        }
      }
    ]
  }
}