API Reference

Webhooks

Webhooks de Transações de Cartão de Crédito

Em nosso sistema, existem três tipos de webhooks disponíveis para monitorar eventos relacionados a transações de cartão de crédito. Você pode cadastrá-los facilmente aqui .


1. Contestação de Transação (CREDIT_CARD_CONTESTATION)

Esse webhook é disparado sempre que ocorre uma contestação de uma transação de cartão de crédito. Ele contém as seguintes informações:

Formato do Webhook:

{
  "creditCardId": 12345,
  "amount": 100.50,
  "identificationTransaction": 12345,
  "cancelationDate": "2025-03-01T00:00:00",
  "transactionDate": "2025-02-01T00:00:00",
  "description": "Pagamento de compra",
  "numbersInstallments": 5,
  "recurrenceId": 34,
  "additionalData": {
    "cardholderName": "Guilherme Gomes da Silva",
		"cardholderCpf": "04578521211",
 		"cardholderEmail": "[email protected]",
    "cardholderPhone": "929826855330",
    "cardholderAddress": "Rua Jalapão 74",
    "cardholderCity": "Rio de Janeiro",
    "cardholderState": "RJ",
    "cardholderPostalCode": "79028122"
  }
}
  • creditCardId: Identificador da transação de cartão de crédito relacionado à contestação. Utilize a api de consulta para mais detalhes
  • amount: Valor da transação contestada.
  • identificationTransaction: NSU da transação de cartão de crédito.
  • cancelationDate: Data e hora da contestação.
  • transactionDate: Data e hora da transação
  • description: Campo de descrição da transação de cartão de crédito.
  • numbersInstallments: Número de parcelas do pagamento.
  • recurrenceId: Id da recorrência. Só vem preenchido quando o pagamento contestado fizer parte de um pagamento recorrente.
  • cardholderName: Nome do portador do cartão de crédito.
  • cardholderCpf: CPF do portador do cartão de crédito.
  • cardholderEmail: Email do portador do cartão de crédito.
  • cardholderPhone: Telefone do portador do cartão de crédito.
  • cardholderAddress: Endereço do portador do cartão de crédito.
  • cardholderCity: Cidade do portador do cartão de crédito.
  • cardholderState: Estado do portador do cartão de crédito.
  • cardholderPostalCode: CEP do portador do cartão de crédito.

2. Execução de Agendamento de Transação Recorrente (CREDIT_CARD_RECURRENCE)

Esse webhook é enviado para notificar a execução de uma transação recorrente de cartão de crédito. Ele pode ser disparado tanto em casos de sucesso quanto de erro.

Formato do Webhook:

{
  "recurrenceId": 23,
  "schedullingId": 67890,
  "amount": 150.75,
  "executionDate": "2025-02-01T00:00:00",
  "status": "SUCCESS",
  "statusReason": "Payment executed successfully",
  "userReference": "User123"
}
  • recurrenceId: Identificador da recorrência.
  • schedullingId: Identificador do agendamento.
  • amount: Valor da transação executada.
  • executionDate: Data e hora da execução.
  • status: Status da execução (SUCCESS ou ERROR).
  • statusReason: Detalhe do status, descrevendo o motivo em casos de erro ou confirmando o sucesso.
  • userReference: Identificador opcional fornecido pelo cliente

3. Pagamento de Link (PAYMENT_LINK)

Esse webhook é disparado quando ocorre o pagamento de um link de pagamento. Ele possui o seguinte formato:

Formato do Webhook:

{
  "paymentLindUuid": "31972176-15c1-40a5-b64b-2a6a4c5c79b3",
  "paymentDate": "2025-01-15T10:30:00",
  "paymentMethod": "CREDIT_CARD",  
  "paymentId": "355",
  "paymentReceipt": "115196453",
  "amount": 150.75
}
  • paymentLindUuid: Identificador único do link de pagamento.
  • paymentDate: Data e hora do pagamento.
  • paymentMethod: Método de pagamento (CREDIT_CARD ou PIX).
  • paymentId: Identificador da transação pagadora do link. Pode ser usado para consultar mais detalhes da transacão. Consultar Pagamento por Pix Consultar Pagamento com Cartão
  • paymentReceipt: Identificador do comprovante do pagamento. É um NSU no caso do cartão de crédito e um EndToEnd no caso do Pix.
  • amount: Valor pago.

Certifique-se de configurar corretamente os webhooks no sistema para garantir que receba todas as notificações relevantes.