Skip to main content
DELETE
Stop an agent using a stored card

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Path Parameters

customerId
string
required

System-generated unique customer identifier

storedCardId
string
required

System-generated unique stored card identifier

agentId
string
required

System-generated unique agent identifier

Response

Access removed

A card the customer already owns, stored so their agents can use it. Grid holds the card number only as Evervault ciphertext: no Grid system stores, logs or returns the number itself.

lastFour
string
required

Last four digits of the card number.

Required string length: 4
Pattern: ^[0-9]{4}$
Example:

"0005"

brand
string
required

The card network, from the issuer's BIN data. Known values: VISA, MASTERCARD, AMERICAN_EXPRESS, DISCOVER, DINERS_CLUB, JCB, UNIONPAY, UNKNOWN. Treat an unrecognized value as UNKNOWN rather than an error.

Maximum string length: 32
Example:

"VISA"

funding
string
required

How the card is funded, from the issuer's BIN data. Known values: CREDIT, DEBIT, PREPAID, CHARGE, DEFERRED_DEBIT, UNKNOWN. Treat an unrecognized value as UNKNOWN rather than an error.

Maximum string length: 32
Example:

"CREDIT"

expiryMonth
integer
required

Expiry month, 1 to 12.

Required range: 1 <= x <= 12
Example:

8

expiryYear
integer
required

Four-digit expiry year.

Required range: 2000 <= x <= 2199
Example:

2029

id
string
required

System-generated unique identifier of the stored card.

Maximum string length: 64
Example:

"StoredCard:019542f5-b3e7-1d02-0000-000000000077"

customerId
string
required

The customer who owns the card.

Maximum string length: 64
Example:

"Customer:019542f5-b3e7-1d02-0000-000000000010"

status
enum<string>
required
Available options:
ACTIVE,
REMOVED
holderName
string
required

The cardholder name, as the customer entered it. Empty once the card is REMOVED.

Maximum string length: 255
Example:

"Jane Doe"

agentIds
string[]
required

The agents the customer allowed to use this card. An agent also needs the USE_STORED_CARDS permission. Empty once the card is REMOVED.

Maximum array length: 100
Maximum string length: 64
createdAt
string<date-time>
required

When the card was stored.

Example:

"2026-11-06T15:00:00Z"

updatedAt
string<date-time>
required

When the card was last changed.

Example:

"2026-11-06T15:00:00Z"

issuerCountry
string

ISO 3166-1 alpha-2 country of the card's issuer, when the BIN data names one.

Required string length: 2
Example:

"US"

nickname
string

The customer's own label for the card.

Maximum string length: 64
Example:

"Personal Visa"

billingAddress
object

The card's billing address. Absent once the card is REMOVED.

autoApprovals
object[]

Merchants where the customer chose to let an agent use the card without asking again, each up to an amount. Cleared for an agent when its access is removed. Empty once the card is REMOVED.

Maximum array length: 100
removedAt
string<date-time>

When the customer removed the card. Present only once it is REMOVED.

Example:

"2026-11-07T09:30:00Z"