Cards
You can create physical or virtual cards that are issued to cardholders.
The Card object
Attributes
- idstring
Unique identifier for the object.
- cancellation_
reasonnullable enum The reason why the card was canceled.
- cardholderdictionary
The Cardholder object to which the card belongs.
- currencyenum
Three-letter ISO currency code, in lowercase. Supported currencies are
usd
in the US,eur
in the EU, andgbp
in the UK. - exp_
monthinteger The expiration month of the card.
- exp_
yearinteger The expiration year of the card.
- last4string
The last 4 digits of the card number.
- metadatadictionary
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- statusenum
Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to
inactive
. - typeenum
The type of the card.
More attributes
- objectstring
- brandstring
- createdtimestamp
- cvcnullable stringExpandable
- livemodeboolean
- numbernullable stringExpandable
- personalization_
designnullable stringPreview featureExpandable - replaced_
bynullable stringExpandable - replacement_
fornullable stringExpandable - replacement_
reasonnullable enum - shippingnullable dictionary
- spending_
controlsdictionary - walletsnullable dictionary
Create a card
Creates an Issuing Card
object.
Parameters
- currencystringRequired
The currency for the card.
- typeenumRequired
The type of card to issue. Possible values are
physical
orvirtual
. - cardholderstringRequired
The Cardholder object with which the card will be associated.
- metadatadictionary
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - statusenum
Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to
inactive
.
More parameters
- personalization_
designstringPreview feature - pindictionary
- replacement_
forstring - replacement_
reasonenum - second_
linestring - shippingdictionary
- spending_
controlsdictionary
Returns
Returns an Issuing Card
object if creation succeeds.
Update a card
Updates the specified Issuing Card
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- cancellation_
reasonenum Reason why the
status
of this card iscanceled
. - metadatadictionary
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - statusenum
Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to
inactive
. If this card is being canceled because it was lost or stolen, this information should be provided ascancellation_reason
.
More parameters
- pindictionary
- spending_
controlsdictionary
Returns
Returns an updated Issuing Card
object if a valid identifier was provided.
Retrieve a card
Retrieves an Issuing Card
object.
Parameters
No parameters.
Returns
Returns an Issuing Card
object if a valid identifier was provided. When requesting the ID of a card that has been deleted, a subset of the card’s information will be returned, including a deleted
property, which will be true.