Retrieve a cardholder

Retrieves an Issuing Cardholder object.

get/v1/issuing/cardholders/{cardholder}

Path parameters

cardholderstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

emailstring nullable

The cardholder's email address.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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 required

The cardholder's name. This will be printed on cards issued to them.

object'issuing.cardholder' required

String representing the object's type. Objects of the same type share the same value.

phone_numberstring nullable

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.

preferred_localesstring[] nullable

The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.

status'active' | 'blocked' | 'inactive' required

Specifies whether to permit authorizations on this cardholder's cards.

type'company' | 'individual' required

One of individual or company. See Choose a cardholder type for more details.

Changes

Changed in 12 of the 51 revisions of this API.194924

    • removed the required property //////////// from the response with the status

      response-required-property-removed

    • removed the required property ////////// from the response with the status

      response-required-property-removed

    • removed the required property ////////// from the response with the status

      response-required-property-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added the optional property ////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property //// from the response with the status

      response-optional-property-removed

    • added the new prevented enum value to the ////////// response property for the response status

      response-property-enum-value-added

    • added the new prevented enum value to the //////// response property for the response status

      response-property-enum-value-added

    • added the new prevented enum value to the //////// response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added the optional property /////// to the response with the status

      response-optional-property-added

    • added the optional property /////// to the response with the status

      response-optional-property-added

    • added the optional property /////// to the response with the status

      response-optional-property-added

  • 1199cc3c557429See the full diff
    • the response property /////////////// became optional for the status

      response-property-became-optional

    • the response property //////////// became optional for the status

      response-property-became-optional

    • added the optional property /////////////// to the response with the status

      response-optional-property-added

    • added the optional property ///////////// to the response with the status

      response-optional-property-added

    • added the optional property //////////// to the response with the status

      response-optional-property-added

    • added the optional property ////////// to the response with the status

      response-optional-property-added

    • added the optional property ////// to the response with the status

      response-optional-property-added

    • added the optional property ////// to the response with the status

      response-optional-property-added

    • added the optional property ////// to the response with the status

      response-optional-property-added

    • added the optional property ////// to the response with the status

      response-optional-property-added

    • added the optional property ////// to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property //////// to the response with the status

      response-optional-property-added

    • added the optional property //////// to the response with the status

      response-optional-property-added

    • added the optional property ///////// to the response with the status

      response-optional-property-added

    • added the optional property ////// to the response with the status

      response-optional-property-added

    • added the optional property ////// to the response with the status

      response-optional-property-added

    • added the optional property /////// to the response with the status

      response-optional-property-added

    • added the optional property //// to the response with the status

      response-optional-property-added

    • added the new al_tin enum value to the /////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the /////////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the ////////////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the //////////////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the ///////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the //////////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the ////////////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the //////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the /////////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the ///////////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the ///////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the /////////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the ////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the ///////////// response property for the response status

      response-property-enum-value-added

    • added the new al_tin enum value to the /////////////// response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • removed the optional property ////////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ///////// from the response with the status

      response-optional-property-removed

    • removed the optional property ///////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property ///////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property //////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property ////////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////// from the response with the status

      response-optional-property-removed

    • removed the optional property /////// from the response with the status

      response-optional-property-removed

    • removed the optional property /// from the response with the status

      response-optional-property-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.