Payment session refund pending - Coinbase Developer Documentation

{ "eventType": "acceptance.payment_session.refund_pending", "eventId": "901m2345-m67j-90l1-i234-204492952888", "timestamp": "2025-06-15T12:40: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_pending", "balances": { "capturable": "0", "captured": "1.00", "refundable": "1.00", "refunded": "0" }, "externalReferenceId": "merchant-order-abc123", "metadata": { "customer_id": "cust_12345", "order_reference": "order-67890" }, "createdAt": "2025-06-15T12:00:00.000Z", "updatedAt": "2025-06-15T12:40:00.000Z" }, "refund": { "refundId": "refund_82c879c1-84e1-44ed-a8c2-1ac239cf09ad", "status": "pending", "amount": "0.50", "reason": "Customer returned the item.", "createdAt": "2025-06-15T12:40:00.000Z", "updatedAt": "2025-06-15T12:40:00.000Z" } } }

Authorizations

X-Webhook-Signature

string

header

required

HMAC-SHA256 signature supplied on every webhook delivery. The signature is computed from the raw request body using the webhook secret supplied during creation of the webhook subscription.

Webhook receivers can cryptographically verify this header before processing the event to ensure the authenticity of the webhook delivery.

Refer to the verify signatures documentation to learn details about the full payload and the exact verification algorithm.

X-Hook0-Signature is deprecated and will eventually be removed. Use X-Webhook-Signature going forward. Both headers are sent with identical values and use the same verification algorithm and webhook secret.

This scheme applies to webhook delivery (outbound POSTs from CDP to your endpoint), not to inbound CDP API requests.

Headers

X-Webhook-Signature

string

required

HMAC-SHA256 signature supplied on every webhook delivery. The signature is computed from the raw request body using the webhook secret supplied during creation of the webhook subscription.

Webhook receivers can cryptographically verify this header before processing the event to ensure the authenticity of the webhook delivery.

Refer to the verify signatures documentation to learn details about the full payload and the exact verification algorithm.

This scheme applies to webhook delivery (outbound POSTs from CDP to your endpoint), not to inbound CDP API requests.

X-Hook0-Signature

string

required

HMAC-SHA256 signature supplied on every webhook delivery. The signature is computed from the raw request body using the webhook secret supplied during creation of the webhook subscription.

Webhook receivers can cryptographically verify this header before processing the event to ensure the authenticity of the webhook delivery.

Refer to the verify signatures documentation to learn details about the full payload and the exact verification algorithm.

This scheme applies to webhook delivery (outbound POSTs from CDP to your endpoint), not to inbound CDP API requests.

Body

application/json

The acceptance.payment_session.refund_pending webhook event payload.

Common fields included in every PaymentSessionEvent payload.

eventId

string<uuid>

required

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

Example:

"123e4567-e89b-12d3-a456-426614174000"

timestamp

string<date-time>

required

When this event occurred (ISO 8601 format).

Example:

"2025-06-01T12:00:00Z"

data

object

required

The data payload for a payment session webhook event. Always contains the paymentSession summary reflecting the session's current state. When the event was triggered by an action (authorization, capture, void, or refund), the corresponding optional field is present with the action details. For session-level events (created, canceled) no action field is included — the paymentSession.status value is sufficient.

Show child attributes

Example:

{
  "paymentSession": {
    "paymentSessionId": "paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
    "entityId": "entity_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    "amount": "1.00",
    "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": "created",
    "balances": {
      "capturable": "0",
      "captured": "0",
      "refundable": "0",
      "refunded": "0"
    },
    "externalReferenceId": "merchant-order-abc123",
    "metadata": {
      "customer_id": "cust_12345",
      "order_reference": "order-67890"
    },
    "createdAt": "2025-06-15T12:00:00.000Z",
    "updatedAt": "2025-06-15T12:00:00.000Z"
  }
}

eventType

enum<string>

required

The type of webhook event.

Available options:

acceptance.payment_session.refund_pending

Example:

"acceptance.payment_session.refund_pending"

Response

Webhook received and processed successfully.