Openi DeveloperDeveloper
WebhooksEvents

TRANSACTIONS_DELETED

Descrição

Disparado quando a instituição remove transações que já tinham sido entregues (ex.: um lançamento estornado ou que deixou de aparecer no extrato). As transações removidas deixam de ser retornadas pelos endpoints de transações.

Payload

{
  "event": "TRANSACTIONS_DELETED",
  "data": {
    "itemId": "string",
    "accountId": "string",
    "accountType": "BANK" | "CREDIT_CARD",
    "transactionIds": ["string"]
  }
}

Campos do payload

  • itemId: ID do item
  • accountId: ID da conta (bancária ou cartão de crédito)
  • accountType: BANK para conta bancária, CREDIT_CARD para cartão de crédito
  • transactionIds: IDs das transações removidas

Como tratar

  • Remova (ou marque como removidas) as transações com esses IDs na sua base. Não tente buscá-las: os endpoints de transações não as retornam mais.
  • Logo depois, pode chegar um TRANSACTIONS_UPDATED na mesma conta com as transações cujo saldo foi recalculado pela remoção.
  • O evento pode ser reentregue; remover um ID que já não existe deve ser uma operação sem efeito.

Exemplo

{
  "event": "TRANSACTIONS_DELETED",
  "data": {
    "itemId": "0198a1b2-1234-7890-abcd-ef1234567890",
    "accountId": "0198a1b3-1234-7890-abcd-ef1234567890",
    "accountType": "BANK",
    "transactionIds": ["0198a1b6-1234-7890-abcd-ef1234567890"]
  }
}

On this page