v1.0 stable
Menu

Tipos de Eventos

Os eventos das notificações são as alterações de status de compras. Abaixo estão as listas de todos os eventos possíveis.

É com base nessa listagem que você deve escolher o evento que tem interesse em receber a notificação. Por exemplo, se você configurar sua conta para receber todos os eventos de pagamentos, então você receberá todos os 5 tipos de eventos de PAYMENT. Se desejar, você pode escolher um ou outro tipo de evento.

Transação

Tipo de EventoDescrição
PAYMENT.*
Todos os eventos do tipo PAYMENT
PAYMENT.WAITING
Status Aguardando, indica que a plataforma está aguardando o pagamento.
PAYMENT.IN_ANALYSIS
Status Em Análise, indica que o pagamento está passando por uma análise de risco, podendo ser automática ou manual.
PAYMENT.AUTHORIZED
Atualização de status para Autorizado, significa que o pagamento foi capturado e debitado no cartão do cliente ou reconhecido junto a instituição bancária, esse status é o indicador de que o pagamento foi efetivado e você deve proceder com a entrega da compra.
PAYMENT.CANCELLED
Pagamento Cancelado (Pagamentos com cartão podem ser cancelados pela Plataforma ou pelo emissor do cartão).
PAYMENT.REFUNDED
Pagamento Reembolsado
PAYMENT.CHARGEBACK_REQUESTED
Pagamento com Chargeback em aberto.
PAYMENT.SETTLED
Atualização de status de pagamento para Concluído, valor disponível para transferência em conta bancária (saque).


Transferência

Tipo de EventoDescrição
TRANSFER.*
Todos os eventos do tipo TRANSFER.
TRANSFER.REQUESTED
Criação de uma nova transferência
TRANSFER.COMPLETED
Atualização de status da transferência para Concluído.
TRANSFER.FAILED
Atualização de status da transferência para Falha.


Exemplo de evento de uma Transação


{
   "event_id":52585,
   "event_type":"PAYMENT.AUTHORIZED",
   "resource":{
      "transaction":{
         "amount":"300.00",
         "barcode":null,
         "canceled_at":null,
         "card_brand":"VISA",
         "created_at":"2023-10-25T14:53:39.843445",
         "days_to_receive":32,
         "digitable_line":null,
         "expected_on":"2023-11-27T14:53:41.958184",
         "fee":"13.06",
         "first4_digits":null,
         "holder_name":"Joao da silva",
         "id":801696,
         "invoice":{
            "customer":{
               "cpf_cnpj":"999.999.999-99",
               "email":"emailcomprador@gmail.com",
               "phone_number":"31-99999-8888",
               "full_name":"Nome do comprador",
               "id":71079
            },
            "id":467226,
            "product_offer":{
               "code":"8OP5GTT",
               "id":21618,
               "product_id":17960
            },
            "status":"paid",
            "subscription":{
               "frequency":"1",
               "id":21904,
               "next_due_date":"2023-11-25"
            }
         },
         "last4_digits":"7927",
         "number_installments":1,
         "original_amount":"300.00",
         "paid_at":"2023-10-25T14:53:41.958165",
         "payment_method":"credit",
         "pix_copy_paste":null,
         "resource_uri":"/api/v1/transactions/801696/",
         "status":"succeeded",
         "transaction_number":null,
         "updated_at":"2023-10-25T14:53:39.843452"
      }
   }
}


Exemplo de evento de uma Transferência


{
   "event_id":52585,
   "event_type":"TRANSFER.REQUESTED",
   "resource":{
      "transfer":{
         "amount":"9.90",
         "canceled_at":null,
         "created_at":"2019-09-03T19:15:33.420703",
         "description":"Transferência para conta bancária: 001 - Banco do Brasil S.A. - Ag: 5252 - Conta: 09719-5 - Conta corrente - Joao da Silva",
         "fee":"3.50",
         "id":154,
         "net_amount":"6.40",
         "resource_uri":"/api/v1/transfers/154/",
         "status":"pending",
         "status_detail":null,
         "transfer_at":null,
         "type":"external"
      }
   }
}