Skip to main content
POST
Save a card

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Body

application/json
token
string
required

The card token passed to the existing payment service.

Minimum string length: 1
exp_month
string
required
Minimum string length: 1
exp_year
string
required
Minimum string length: 1
billing_address_id
string<uuid>
required

One of the member's saved addresses (/addresses).

default
boolean | null

Make the card the member's default once saved.

token_provider
string
Minimum string length: 1
cvv_token
string

The CVC token passed to the existing payment service.

Minimum string length: 1
card_holder
string

The cardholder name passed to the existing payment service.

Minimum string length: 1
bin
string | null

Optional issuer prefix reported by the vault form.

last_four
string | null
card_network
string | null

Optional card-brand hint reported by the vault form.

browser_info
object | null

Browser fingerprint fields forwarded unchanged to the existing 3-D Secure flow.

Response

The saved payment method.

status
integer
required
data
object
required

A saved payment method with masked card details and the existing payment API identity fields.

meta
object
required

Envelope metadata present on every response.