Skip to main content
POST
Create a Vault session
This is the same hosted card-binding ceremony as Bind a card, exposed under the vault_id contract so a platform settings page can keep one card-management flow: create the session, open the hosted page, then read the card list again. Each call creates a new independent session. No purchase authorization and no instruction is created. POST /agent/platform/vault-sessions and the existing Bind a card POST /agent/platform/bind-sessions create the same Vault bind session; the only difference is the response field name (vault_id here, session_id there). Use vault-sessions for new integrations; bind-sessions stays available for existing integrations and neither endpoint is deprecated. There are no body fields for choosing a customer. The session is always created for the token’s customer.
Treat vault_id and url as credentials. Do not forward them, screenshot them, or write them to logs; anyone who has either one can complete card binding for that customer while the session is valid. Deliver them only to the intended user.

Exchange vault_id for a page login state

To open the hosted page with a Vault page login state instead of the link, exchange vault_id at the existing exchange endpoint:
The exchange returns the Vault page session token and its expire_in; use that token only for the hosted page. The session lifetime follows Clink’s Vault session configuration; after it expires, create a new session. A Vault session is a card-binding session, not a purchase authorization, and it cannot be used to charge the customer.

Authorizations

Authorization
string
header
required

Portal user token from POST /agent/cwallet/platform/portal/tokens. Reads require portal:read; writes require portal:write.

Response

Success

code
integer<int32>

200 on success.

Example:

200

msg
string

Result message.

Example:

"Success"

data
object