The Cardholder object
Attributes
- idstring
Unique identifier for the object.
- billingdictionary
The cardholder’s billing information.
- emailnullable string
The cardholder’s email address.
- 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.
- namestring
The cardholder’s name. This will be printed on cards issued to them.
- phone_
numbernullable string The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
More attributes
- objectstring
- companynullable dictionary
- createdtimestamp
- individualnullable dictionary
- livemodeboolean
- preferred_
localesnullable array of enums - requirementsdictionary
- spending_
controlsnullable dictionary - statusenum
- typeenum
Create a cardholder
Creates a new Issuing Cardholder object that can be issued cards.
Parameters
- billingdictionaryRequired
The cardholder’s billing address.
- namestringRequired
The cardholder’s name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.
- emailstring
The cardholder’s email address.
- 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. - phone_
numberstring The cardholder’s phone number. This will be transformed to E.164 if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
More parameters
- companydictionary
- individualdictionary
- preferred_
localesarray of enums - spending_
controlsdictionary - statusenum
- typeenum
Returns
Returns an Issuing Cardholder object if creation succeeds.
Update a cardholder
Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- billingdictionary
The cardholder’s billing address.
- emailstring
The cardholder’s email address.
- 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. - phone_
numberstring The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
More parameters
- companydictionary
- individualdictionary
- preferred_
localesarray of enums - spending_
controlsdictionary - statusenum
Returns
Returns an updated Issuing Cardholder object if a valid identifier was provided.
Retrieve a cardholder
Retrieves an Issuing Cardholder object.
Parameters
No parameters.
Returns
Returns an Issuing Cardholder object if a valid identifier was provided.
List all cardholders
Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
No parameters.
More parameters
- createddictionary
- emailstring
- ending_
beforestring - limitinteger
- phone_
numberstring - starting_
afterstring - statusenum
- typeenum
Returns
A dictionary with a data property that contains an array of up to limit cardholders, starting after cardholder starting_after. Each entry in the array is a separate Issuing Cardholder object. If no more cardholders are available, the resulting array will be empty.