Skip to main content
PATCH
TypeScript

인증

Authorization
string
header
필수

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payout:account:update

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

경로 매개변수

id
string
필수

Card ID to retrieve, prefixed icrd_.

본문

application/json
account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

예시:

"biz_xxxxxxxxxxxxxx"

billing
object

The billing address. On an issued card this replaces the card's billing address and region is also required. On an invited card, sending it as the invited user completes onboarding and starts card provisioning.

canceled
boolean

Pass true to permanently cancel the card. A canceled card cannot be uncanceled. Cannot be combined with other fields.

예시:

true

cardholder
object

Details for the invited cardholder, accepted only while completing onboarding on an invited card. The legal name comes from an approved identity verification when the invited user has one, and from these fields when they do not.

frozen
boolean

Pass true to freeze the card, false to unfreeze it. The assigned cardholder may freeze their own card without the payout:account:update scope.

예시:

true

name
string

A display name for the card.

예시:

"Detailing supplies"

pin
string

New 4-digit PIN. Can only be set on a card assigned to the acting user, who may set it without the payout:account:update scope.

예시:

"1234"

remove_limit
boolean

Pass true to remove the spending limit (make the card unlimited).

예시:

true

spend_limit
number

Spending limit amount, in dollars.

예시:

2500

spend_limit_frequency
enum<string>

The window the spend limit applies to.

사용 가능한 옵션:
daily,
weekly,
monthly,
one_time
예시:

"monthly"

transaction_limit
number

Per-transaction limit amount, in dollars.

예시:

500

user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

예시:

"user_xxxxxxxxxxxxxx"

응답

invited card onboarding completed: card provisioning started

billing
object | null
필수

The billing address.

canceled_at
string<date-time> | null
필수

When the card was canceled.

예시:

"2026-01-01T12:00:00.000Z"

created_at
string<date-time> | null
필수

When the card was created.

예시:

"2026-01-01T12:00:00.000Z"

digital_wallets
enum<string>[] | null
필수

The digital wallets the card has been added to. List Cards, Update Card, and webhook payloads return null, as does Retrieve Card when the wallets cannot be retrieved.

사용 가능한 옵션:
apple_pay,
google_pay
expiration_month
string | null
필수

Card expiration month.

예시:

"12"

expiration_year
string | null
필수

Card expiration year.

예시:

"2027"

id
string
필수

Card ID, prefixed icrd_.

예시:

"icrd_xxxxxxxxxxxxxx"

issued
boolean
필수

true once the issuer has issued the card. false for an invited card still waiting on its cardholder's onboarding or review, or one the issuer declined; it has no card number until it is issued.

예시:

true

last4
string | null
필수

Last four digits of the card number. null for pending invitation cards.

예시:

"4242"

limit
object | null
필수

The spending limit configuration.

name
string | null
필수

Card display name.

예시:

"Detailing supplies"

object
enum<string>
필수
사용 가능한 옵션:
card
예시:

"card"

spent_last_month
integer | null
필수

Total spend in the last 30 days, in cents.

예시:

1234

status
enum<string> | null
필수

The card status. denied means the issuer declined the cardholder, so the card will never be issued.

사용 가능한 옵션:
null,
active,
frozen,
canceled,
invited,
denied
예시:

"active"

type
enum<string> | null
필수

The card type.

사용 가능한 옵션:
null,
virtual,
physical
예시:

"virtual"

user_id
string | null
필수

Cardholder user ID, prefixed user_, when assigned.

예시:

"user_xxxxxxxxxxxxxx"

secrets
object | null

Sensitive card details. Present only on GET /cards/:id for active cards; null when the card is inactive or details cannot be retrieved.