Skip to content
SarvexDocs
Esc
↑↓navigate↵open⌘Jpreview

UCP capability negotiation succeeded

RECEIVEucp.negotiation.succeeded
Message
requested_capabilitiesstring[]

The calling platform's full capability set.

declared_capabilitiesstring[]

The business (merchant)'s full declared capability set.

active_capabilitiesstring[] | null

The post-intersection capability set. Absent (null) on a failed negotiation — no intersection was ever reached.

requested_payment_handlersstring[]
declared_payment_handlersstring[]
active_payment_handlersstring[] | null

Absent (null) on a failed negotiation. Note that an empty (non-null) intersection here does NOT itself fail negotiation — see ucp.negotiation.failed's reason enum, which never includes a payment-handler cause.

instance_idstringrequired

The store id — named instance_id on this event specifically (not store_id, unlike negotiation_failed and every other channel in this spec).

platform_profile_uristring<uri>required
Try it
Server
Payload

Live sending isn't possible for pubsub from a browser tab — copy the sample above and run it against your broker.

Message
{
  "requested_capabilities": [
    "string"
  ],
  "declared_capabilities": [
    "string"
  ],
  "active_capabilities": [
    "string"
  ],
  "requested_payment_handlers": [
    "string"
  ],
  "declared_payment_handlers": [
    "string"
  ],
  "active_payment_handlers": [
    "string"
  ],
  "instance_id": "string",
  "platform_profile_uri": "http://example.com"
}