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

• billingobject

  The cardholder’s billing address.

  Hide child parameters

  • billing.addressobjectRequired

    The cardholder’s billing address.

    Hide child parameters

    • billing.address.citystringRequired

      City, district, suburb, town, or village.

    • billing.address.countrystringRequired

      Two-letter country code (ISO 3166-1 alpha-2).

    • billing.address.line1stringRequired

      Address line 1, such as the street, PO Box, or company name.

    • billing.address.postal_codestringRequired

      ZIP or postal code.

    • billing.address.line2string

      Address line 2, such as the apartment, suite, unit, or building.

    • billing.address.statestring

      State, county, province, or region.

• emailstring

  The cardholder’s email address.

• 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.

• 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

Collapse all

• companyobject

  Additional information about a company cardholder.

  Hide child parameters

  • company.tax_idstring

    The entity’s business ID number.

• individualobject

  Additional information about an individual cardholder.

  Hide child parameters

  • individual.card_issuingobject

    Information related to the card_issuing program for this cardholder.

    Hide child parameters

    • individual.card_issuing.user_terms_acceptanceobject

      Information about cardholder acceptance of Celtic Authorized User Terms. Required for cards backed by a Celtic program.

      Hide child parameters

      • individual.card_issuing.user_terms_acceptance.datetimestampRequired if ip or user_agent is provided

        The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.

      • individual.card_issuing.user_terms_acceptance.ipstringRequired if date or user_agent is provided

        The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users.

      • individual.card_issuing.user_terms_acceptance.user_agentstring

        The user agent of the browser from which the cardholder accepted the Authorized User Terms.

  • individual.dobobject

    The date of birth of this cardholder. Cardholders must be older than 13 years old.

    Hide child parameters

    • individual.dob.dayintegerRequired

      The day of birth, between 1 and 31.

    • individual.dob.monthintegerRequired

      The month of birth, between 1 and 12.

    • individual.dob.yearintegerRequired

      The four-digit year of birth.

  • individual.first_namestring

    The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.

  • individual.last_namestring

    The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.

  • individual.verificationobject

    Government-issued ID document for this cardholder.

    Hide child parameters

    • individual.verification.documentobject

      An identifying document, either a passport or local ID card.

      Hide child parameters

      • individual.verification.document.backstring

        The back of an ID returned by a file upload with a purpose value of identity_document.

      • individual.verification.document.frontstring

        The front of an ID returned by a file upload with a purpose value of identity_document.

• preferred_localesarray of enums

  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.

• spending_controlsobject

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

  Hide child parameters

  • spending_controls.allowed_categoriesarray of strings

    Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories.

  • spending_controls.allowed_merchant_countriesarray of strings

    Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.

  • spending_controls.blocked_categoriesarray of strings

    Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories.

  • spending_controls.blocked_merchant_countriesarray of strings

    Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.

  • spending_controls.spending_limitsarray of objects

    Limit spending with amount-based rules that apply across this cardholder’s cards.

    Hide child parameters

    • spending_controls.spending_limits.amountintegerRequired

      Maximum amount allowed to spend per interval.

    • spending_controls.spending_limits.intervalenumRequired

      Interval (or event) to which the amount applies.

      Possible enum values

      all_time Limit applies to all transactions.

      daily Limit applies to a day, starting at midnight UTC.

      monthly Limit applies to a month, starting on the 1st at midnight UTC.

      per_authorization Limit applies to each authorization.

      weekly Limit applies to a week, starting on Sunday at midnight UTC.

      yearly Limit applies to a year, starting on January 1st at midnight UTC.

    • spending_controls.spending_limits.categoriesarray of strings

      Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.

  • spending_controls.spending_limits_currencystring

    Currency of amounts within spending_limits. Defaults to your merchant country’s currency.

• statusenum

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

  Possible enum values

  active Cards attached to this cardholder can approve authorizations.

  inactive Cards attached to this cardholder will decline all authorizations with a cardholder_inactive reason.