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.
- metadataobject
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 - pinobject
- replacement_
forstring - replacement_
reasonenum - second_
linestring - shippingobject
- spending_
controlsobject
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
. - metadataobject
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
- pinobject
- spending_
controlsobject
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.
List all cards
Returns a list of Issuing Card
objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- cardholderstring
Only return cards belonging to the Cardholder with the provided ID.
- typeenum
Only return cards that have the given type. One of
virtual
orphysical
.
More parameters
- createdobject
- ending_
beforestring - exp_
monthinteger - exp_
yearinteger - last4string
- limitinteger
- starting_
afterstring - statusenum
Returns
A dictionary with a data
property that contains an array of up to limit
cards, starting after card starting_after
. Each entry in the array is a separate Issuing Card
object. If no more cards are available, the resulting array will be empty.
Deliver a testmode cardTest helper
Updates the shipping status of the specified Issuing Card
object to delivered
.
Parameters
No parameters.
Returns
Returns an updated Issuing Card
object.