Webhooks
Collection Confirmed

COLLECTION_CONFIRMED

Delivered when the deposit reaches the confirmationThreshold you set when creating the collection.

Envelopebody wrapperKeyssnake_case

Delivered to the collection's merchantCallbackUrl, falling back to your business webhook URL.

Payload

COLLECTION_CONFIRMED
{
  "body": {
    "eventType": "COLLECTION_CONFIRMED",
    "collection": {
      "id": "4ebdfe45-a62b-47a9-ac31-7599305666b1",
      "business_id": "b7b93a40-4e18-4e97-9c5f-8a7a4fd0df92",
      "network": "MATIC_MAINNET",
      "token": "USDT",
      "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "token_amount": "25.000000000000000000",
      "token_amount_requested": "25.000000000000000000",
      "token_amount_received": "25.000000000000000000",
      "token_to_usd": "1.00000000",
      "status": "SUCCESSFUL",
      "transaction_hash": "0xb480ed44a275f042e482a78d9c5b54fcf612441c",
      "transaction_block_number": 61234567,
      "number_of_confirmations": 10,
      "confirmation_threshold": 10,
      "merchant_redirect_url": "https://example.com/thanks",
      "merchant_callback_url": "https://example.com/webhooks/knit",
      "expires_at": "2024-02-22T17:29:33.000000Z",
      "created_at": "2024-02-22T16:59:33.000000Z",
      "updated_at": "2024-02-22T17:00:30.000000Z"
    }
  }
}

Confirmation and crediting are separate steps. This event says the chain has confirmed the deposit to your satisfaction; COLLECTION_SUCCESSFUL says the funds have landed in your API account.

Handling

Compare token_amount_received against token_amount_requested before treating the payment as settled in full — an underpayment confirms just like a full payment does.

See also