POST /v1/issuing/cardholders

Creates a new Issuing Cardholder object that can be issued cards.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
spending_controls Object No

Rules that control spending across this cardholder's cards. Refer to our documentation for more details.

spending_controls.blocked_merchant_countries[] Array No
spending_controls.spending_limits[] Array No
spending_controls.spending_limits[].interval String Yes

Possible values:

  • "monthly"
  • "per_authorization"
  • "weekly"
  • "yearly"
  • "all_time"
  • "daily"
spending_controls.spending_limits[].categories[] Array No
spending_controls.spending_limits[].amount Integer Yes
spending_controls.spending_limits_currency String No
spending_controls.allowed_merchant_countries[] Array No
spending_controls.allowed_categories[] Array No
spending_controls.blocked_categories[] Array No
email String No

The cardholder's email address.

individual Object No

Additional information about an individual cardholder.

individual.last_name String No
individual.verification Object No
individual.verification.document Object No
individual.verification.document.back String No
individual.verification.document.front String No
individual.first_name String No
individual.card_issuing Object No
individual.card_issuing.user_terms_acceptance Object No
individual.card_issuing.user_terms_acceptance.user_agent No
individual.card_issuing.user_terms_acceptance.ip String No
individual.card_issuing.user_terms_acceptance.date Integer No
individual.dob Object No
individual.dob.day Integer Yes
individual.dob.month Integer Yes
individual.dob.year Integer Yes
name String Yes

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.

billing Object Yes

The cardholder's billing address.

billing.address Object Yes
billing.address.line2 String No
billing.address.line1 String Yes
billing.address.postal_code String Yes
billing.address.country String Yes
billing.address.state String No
billing.address.city String Yes
company Object No

Additional information about a company cardholder.

company.tax_id String No
expand[] Array No

Specifies which fields in the response should be expanded.

metadata Object No

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.

type String No

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

Possible values:

  • "company"
  • "individual"
preferred_locales[] Array No

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 String No

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

Possible values:

  • "inactive"
  • "active"
phone_number String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.