Vault a card instrument (token handoff)

post

https://cloud.zenoz.ai/v1/tenant/payment-instruments/card

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Vault a card from an already-minted network token (the capture surface tokenizes the PAN upstream). Raw PAN/CVV/track fields are rejected — a card number never reaches this endpoint.

ownerType

string

enum

required

For card acceptance (charging a customer) use payer.

Allowed:

ownerId

uuid

required

The cardholder entity (payer or recipient) the card belongs to.

cardNetworkTokenRef

string

required

length ≤ 255

Opaque network token from the capture surface. Never a PAN.

cardNetwork

string | null

cardBrand

string | null

cardLast4

string | null

^[0-9]{4}$

cardExpMonth

integer | null

1 to 12

cardExpYear

integer | null

verificationMethod

string | null

enum

Card verification method (accepted; not yet performed).

Allowed:

Responses

200Idempotent: an equivalent active card instrument already exists.

201Card instrument created — data.id is the payment_method.instrument_id you charge against.

400A raw PAN/CVV/track field was sent (rejected — tokenize at the capture surface first).

401Missing or invalid authentication credentials.

403Caller lacks the required role/permission for the resource.

404Resource does not exist or is not visible to the caller.

409Request conflicts with current resource state (e.g. duplicate key, stale version).

500Unexpected server error.