Kooin API
  1. Webhook
Kooin API
  • 📄 API Reference
  • API Endpoints
    • Generate Payment
      POST
    • List Payments
      GET
  • Webhook
    • Webhook Example
  • Support
    • 💬 Telegram
  1. Webhook

Webhook Example

To seamlessly integrate payment confirmations into your system, our service will send a POST request to your configured webhook URL. This request contains a JSON payload with the transaction details, allowing you to update your records and confirm receipt of funds automatically.
The webhook follows this standardized format:
Field Descriptions:
transactionId: Our platform's unique identifier for the transaction.
externalId: Your unique reference ID (provided during the order creation) to match the payment.
status: The current status of the transaction (e.g., COMPLETED).
amount: The settled amount of the transaction in BRL.
timestamp: The exact date and time (in ISO 8601 format) when the payment was finalized.
type: The transaction type (e.g., PIX_IN for incoming PIX payments).
Your system should listen for this payload and use the externalId to reconcile incoming payments, marking the corresponding order as paid upon receiving a "status": "COMPLETED".
Previous
List Payments
Next
💬 Telegram
Built with