Create a cardholder
POST / v1 / issuing / cardholders
Creates a new Issuing Cardholder object that can be issued cards.
Parameters
- billing object Required The cardholder’s billing address.
- name string Required 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.
- email string The cardholder’s email address. The maximum length is 800 characters.
- metadata map 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 _ number string 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
- company object
- individual object
- preferred _ locales array of enums
- spending _ controls object
- status enum
- type enum
Returns
Returns an Issuing Cardholder object if creation succeeds.
Response
{ "id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK", "object": "issuing.cardholder", "billing": { "address": { "line1": "1234 Main Street", "city": "San Francisco", "state": "CA", "country": "US", "postal_code": "94111" } }, "company": null, "created": 1680415995, "email": "jenny.rosen@example.com", "individual": null, "livemode": false, "metadata": {}, "name": "Jenny Rosen", "phone_number": "+18888675309", "redaction": null, "requirements": { "disabled_reason": "requirements.past_due", "past_due": [ "individual.card_issuing.user_terms_acceptance.ip", "individual.card_issuing.user_terms_acceptance.date", "individual.first_name", "individual.last_name" ] }, "spending_controls": { "allowed_categories": [], "blocked_categories": [], "spending_limits": [], "spending_limits_currency": null }, "status": "active", "type": "individual"}
Update a cardholder
POST / v1 / issuing / cardholders /:id
Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- billing object The cardholder’s billing address.
- email string The cardholder’s email address. The maximum length is 800 characters.
- metadata map 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 _ number 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 parameters
- company object
- individual object
- preferred _ locales array of enums
- spending _ controls object
- status enum
Returns
Returns an updated Issuing Cardholder object if a valid identifier was provided.
Response
{ "id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK", "object": "issuing.cardholder", "billing": { "address": { "line1": "1234 Main Street", "city": "San Francisco", "state": "CA", "country": "US", "postal_code": "94111" } }, "company": null, "created": 1680415995, "email": "jenny.rosen@example.com", "individual": null, "livemode": false, "metadata": { "order_id": "6735" }, "name": "Jenny Rosen", "phone_number": "+18888675309", "redaction": null, "requirements": { "disabled_reason": "requirements.past_due", "past_due": [ "individual.card_issuing.user_terms_acceptance.ip", "individual.card_issuing.user_terms_acceptance.date", "individual.first_name", "individual.last_name" ] }, "spending_controls": { "allowed_categories": [], "blocked_categories": [], "spending_limits": [], "spending_limits_currency": null }, "status": "active", "type": "individual"}
Retrieve a cardholder
GET / v1 / issuing / cardholders /:id
Retrieves an Issuing Cardholder object.
Parameters
No parameters.
Returns
Returns an Issuing Cardholder object if a valid identifier was provided.
Response
{ "id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK", "object": "issuing.cardholder", "billing": { "address": { "line1": "1234 Main Street", "city": "San Francisco", "state": "CA", "country": "US", "postal_code": "94111" } }, "company": null, "created": 1680415995, "email": "jenny.rosen@example.com", "individual": null, "livemode": false, "metadata": {}, "name": "Jenny Rosen", "phone_number": "+18888675309", "redaction": null, "requirements": { "disabled_reason": "requirements.past_due", "past_due": [ "individual.card_issuing.user_terms_acceptance.ip", "individual.card_issuing.user_terms_acceptance.date", "individual.first_name", "individual.last_name" ] }, "spending_controls": { "allowed_categories": [], "blocked_categories": [], "spending_limits": [], "spending_limits_currency": null }, "status": "active", "type": "individual"}