Credit Card Transaction Webhooks

In our system, there are three types of webhooks available to monitor events related to credit card transactions. You can easily register them here.

1. Payment Link (PAYMENT_LINK_INBOUND)

This webhook is triggered when a payment link payment occurs. It has the following format:

Webhook Format:

{
  "paymentLinkUuid": "31972176-15c1-40a5-b64b-2a6a4c5c79b3",
  "paymentDate": "2025-01-15T10:30:00",
  "paymentMethod": "CREDIT_CARD",  
  "paymentId": "355",
  "paymentReceipt": "115196453",
  "amount": 150.75
}

paymentLinkUuid: Unique identifier of the payment link.
paymentDate: Date and time of payment.
paymentMethod: Payment method (CREDIT_CARD or PIX).
paymentId: Identifier of the payment transaction for the link. Can be used to consult more transaction details. Consult PIX Payment Consult Card Payment
paymentReceipt: Payment receipt identifier. It's an NSU for credit card and an EndToEnd for PIX.
amount: Amount paid.

2. Transaction Contestation (CARD_CHARGEBACK)

This webhook is triggered whenever a credit card transaction contestation occurs. It contains the following information:

Webhook Format:

{
  "creditCardId": 12345,
  "amount": 100.50,
  "identificationTransaction": 12345,
  "cancelationDate": "2025-03-01T00:00:00",
  "transactionDate": "2025-02-01T00:00:00",
  "description": "Purchase payment",
  "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: Identifier of the credit card transaction related to the contestation. Use the consultation API for more details
amount: Value of the contested transaction.
identificationTransaction: NSU of the credit card transaction.
cancelationDate: Date and time of the contestation.
transactionDate: Date and time of the transaction
description: Description field of the credit card transaction.
numbersInstallments: Number of payment installments.
recurrenceId: Recurrence ID. Only filled when the contested payment is part of a recurring payment.
cardholderName: Name of the credit card holder.
cardholderCpf: CPF of the credit card holder.
cardholderEmail: Email of the credit card holder.
cardholderPhone: Phone of the credit card holder.
cardholderAddress: Address of the credit card holder.
cardholderCity: City of the credit card holder.
cardholderState: State of the credit card holder.
cardholderPostalCode: Postal code of the credit card holder.

3. Recurring Transaction Scheduling Execution (CARD_RECURRING_INBOUND)

This webhook is sent to notify the execution of a recurring credit card transaction. It can be triggered in both success and error cases.

Webhook Format:

{
  "recurrenceId": 23,
  "schedullingId": 67890,
  "amount": 150.75,
  "executionDate": "2025-02-01T00:00:00",
  "status": "SUCCESS",
  "statusReason": "Payment executed successfully",
  "userReference": "User123"
}

recurrenceId: Recurrence identifier.
schedullingId: Scheduling identifier.
amount: Value of the executed transaction.
executionDate: Date and time of execution.
status: Execution status (SUCCESS or ERROR).
statusReason: Status detail, describing the reason in error cases or confirming success.
userReference: Optional identifier provided by the client

Make sure to properly configure the webhooks in the system to ensure you receive all relevant notifications.