Skip to main content
POST
Save a patient's card (no charge)

Authorizations

Authorization
string
header
required

API key issued by VitaRelay. Send as Authorization: Bearer vr_live_… (production) or Authorization: Bearer vr_test_… (sandbox).

Path Parameters

id
string
required

The VitaRelay patient id (UUID), or your own external_patient_id from when you created the patient — you never have to store our id.

Body

application/json
opaque_data
object
required
billing
object

Cardholder billing details. Anything omitted falls back to the patient record.

nickname
string

Display-only label (max 40 characters).

make_default
boolean

Make this the patient's default card. It already is when they have none.

Response

Card saved.

data
object
Example: