Skip to main content
POST
Provision VGS vault credentials

Headers

X-Checkout-Journey-Id
string

Optional non-authorizing checkout journey UUID. Use with X-Checkout-Attempt-Id. Capture is disabled by default; malformed or incomplete pairs are ignored without changing checkout behavior. Cart scope comes from the authenticated cart token, never these headers.

X-Checkout-Attempt-Id
string

Optional customer-submission UUID paired with X-Checkout-Journey-Id. Retain it for transport retries and originating continuations; use a new UUID for a new customer submission. It does not replace payment or order idempotency keys. Invalid pairs are ignored rather than rejecting payment.

Path Parameters

cart_token
string
required

Opaque cart token returned by the create-cart response. It scopes the request to a single cart and is the credential for these endpoints — cart-token authentication carried in the path, with no bearer token or API key.

Response

Vault credentials

Success body for VGS vault provisioning.

vault
object
required

VGS Collect vault credentials used to tokenize card data client-side.

requires_3ds
boolean
required

true when 3D Secure is required for this card; mirrors vault.requires_3ds. When true, call verify before authorizing.

payment_account_id
integer
required

Id of the CreditCard payment account resolved and pinned to the cart for this tokenization. Routing normally stays fixed to this account for the rest of the flow, but a stale pin is invalidated and re-resolved when the account set that produced it changes (for example after a gateway configuration change), so a later call can return a different account.

meta
object
required

Standard response metadata included on every response.