Payment Sessions

Payment session refund succeeded

Triggered when the acceptance.payment_session.refund_succeeded webhook event is emitted. Your API will receive a POST request at the webhook URL you configured.

postWebhookacceptancePaymentSessionRefundSucceeded

Payload

eventIdstring uuid required

Unique identifier for this webhook event. Use this for idempotency.

timestampstring date-time required

When this event occurred (ISO 8601 format).

eventType'acceptance.payment_session.refund_succeeded' required

The type of webhook event.

Example payload

{
  "eventType": "acceptance.payment_session.refund_succeeded",
  "eventId": "012n3456-n78k-01m2-j345-315503063999",
  "timestamp": "2025-06-15T12:41:00Z",
  "data": {
    "paymentSession": {
      "paymentSessionId": "paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
      "entityId": "entity_af2937b0-9846-4fe7-bfe9-ccc22d935114",
      "amount": "1.00",
      "asset": "usdc",
      "source": {
        "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
        "network": "base",
        "asset": "usdc"
      },
      "target": {
        "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
        "network": "base"
      },
      "autoCapture": false,
      "expiries": {
        "authorizationExpiresAt": "2025-12-31T23:59:59.000Z",
        "captureExpiresAt": "2026-01-15T23:59:59.000Z",
        "refundExpiresAt": "2026-02-15T23:59:59.000Z"
      },
      "status": "refund_succeeded",
      "balances": {
        "capturable": "0",
        "captured": "1.00",
        "refundable": "0.50",
        "refunded": "0.50"
      },
      "externalReferenceId": "merchant-order-abc123",
      "metadata": {
        "customer_id": "cust_12345",
        "order_reference": "order-67890"
      },
      "createdAt": "2025-06-15T12:00:00.000Z",
      "updatedAt": "2025-06-15T12:41:00.000Z"
    },
    "refund": {
      "refundId": "refund_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
      "status": "succeeded",
      "amount": "0.50",
      "reason": "Customer returned the item.",
      "onchainTransactions": [
        {
          "transactionHash": "0x012345678901234567890abcdef1234567890abcdef1234567890abcdef1234",
          "network": "base"
        }
      ],
      "createdAt": "2025-06-15T12:40:00.000Z",
      "updatedAt": "2025-06-15T12:41:00.000Z"
    }
  }
}

Response

Webhook received and processed 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.