Integration EssentialsWebhooksReference

payment.succeeded

The payment succeeded. Payload reference and example for the payment.succeeded webhook event.

success is populated, and processing carries the committed option. Settlement completion arrives later as payment.settled.

data.statusStage objects populatedStage objects always null
succeededprocessing, success (settled usually null)failed, cancelled, expired

Every field is documented in the event overview.

{
  "id": "evt_fixture_payment_succeeded",
  "type": "payment.succeeded",
  "api_version": "2026-05-18",
  "created_at": "2026-06-30T10:00:00.271Z",
  "data": {
    "payment_id": "pay_fixture_01HZX4V9K3T",
    "merchant_id": "merchant_fixture_01HZX4V9K3T",
    "live": true,
    "payment_state_version": 2,
    "reference_id": "order_fixture_1042",
    "status": "succeeded",
    "amount": {
      "unit": "iso4217/USD",
      "value": "1000"
    },
    "created_at": "2026-06-30T09:59:00.084Z",
    "expires_at": "2026-06-30T10:14:00.000Z",
    "processing": {
      "processing_at": "2026-06-30T09:59:10.512Z",
      "option_amount": {
        "unit": "caip19/eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
        "value": "10000000"
      },
      "fee": {
        "kind": "base_plus_percent",
        "base_amount": {
          "unit": "caip19/eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
          "value": "0"
        },
        "percent": {
          "numerator": "29",
          "denominator": "1000"
        },
        "percent_amount": {
          "unit": "caip19/eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
          "value": "290000"
        },
        "total_amount": {
          "unit": "caip19/eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
          "value": "290000"
        }
      },
      "settlement_amount": {
        "unit": "caip19/eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
        "value": "9710000"
      },
      "buyer_caip10": "eip155:8453:0x000000000000000000000000000000000000dEaD",
      "chain_caip2": "eip155:8453"
    },
    "success": {
      "succeeded_at": "2026-06-30T10:00:00.271Z",
      "tx_id": "0x8f1e5c1b9a4a1d2e3f405162738495a6b7c8d9e0f1a2b3c4d5e6f708192a3b4c"
    },
    "failed": null,
    "cancelled": null,
    "expired": null,
    "settled": null
  }
}