BYbyaccrue
Webhook Topics

Transaction Cleared

Fired when a transaction is cleared. This event indicates that the transaction has been successfully processed and funds are available. The included payload contains event data with a fee object (fee type and amount in cents).

postWebhooktransactionCleared

Payload

idstring uuid required

Unique identifier for the object.

type'WebhookEvent' required

Example payload

{
  "attributes": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "walletId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "included": [
    {
      "attributes": {
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "walletId": "123e4567-e89b-12d3-a456-426614174000",
        "rewardIds": [],
        "fee": {
          "type": "JitFundingFee",
          "amount": 125
        }
      }
    }
  ]
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.