issuing.dispute
{
"type": "object",
"title": "IssuingDispute",
"required": [
"amount",
"created",
"currency",
"evidence",
"id",
"livemode",
"metadata",
"object",
"status",
"transaction"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation)."
},
"object": {
"enum": [
"issuing.dispute"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"expired",
"lost",
"submitted",
"unsubmitted",
"won"
],
"type": "string",
"description": "Current status of the dispute."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "The currency the `transaction` was made in."
},
"evidence": {
"$ref": "#/components/schemas/issuing_dispute_evidence"
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"treasury": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_dispute_treasury"
}
],
"nullable": true,
"description": "[Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts)"
},
"loss_reason": {
"enum": [
"cardholder_authentication_issuer_liability",
"eci5_token_transaction_with_tavv",
"excess_disputes_in_timeframe",
"has_not_met_the_minimum_dispute_amount_requirements",
"invalid_duplicate_dispute",
"invalid_incorrect_amount_dispute",
"invalid_no_authorization",
"invalid_use_of_disputes",
"merchandise_delivered_or_shipped",
"merchandise_or_service_as_described",
"not_cancelled",
"other",
"refund_issued",
"submitted_beyond_allowable_time_limit",
"transaction_3ds_required",
"transaction_approved_after_prior_fraud_dispute",
"transaction_authorized",
"transaction_electronically_read",
"transaction_qualifies_for_visa_easy_payment_service",
"transaction_unattended"
],
"type": "string",
"description": "The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values."
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.transaction"
}
],
"description": "The transaction being disputed.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.transaction"
}
]
}
},
"balance_transactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/balance_transaction"
},
"nullable": true,
"description": "List of balance transactions associated with the dispute."
}
},
"description": "As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes)",
"x-resourceId": "issuing.dispute",
"x-expandableFields": [
"balance_transactions",
"evidence",
"transaction",
"treasury"
]
}
issuing.personalization_design
{
"type": "object",
"title": "IssuingPersonalizationDesign",
"required": [
"created",
"id",
"livemode",
"metadata",
"object",
"physical_bundle",
"preferences",
"rejection_reasons",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Friendly display name."
},
"object": {
"enum": [
"issuing.personalization_design"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"inactive",
"rejected",
"review"
],
"type": "string",
"description": "Whether this personalization design can be used to create cards."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"card_logo": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. Image must be in PNG format with dimensions of 1000px by 200px. It must be a binary (black and white) image containing a black logo on a white background. We don't accept grayscale.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"lookup_key": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters."
},
"preferences": {
"$ref": "#/components/schemas/issuing_personalization_design_preferences"
},
"carrier_text": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_personalization_design_carrier_text"
}
],
"nullable": true,
"description": "Hash containing carrier text, for use with physical bundles that support carrier text."
},
"physical_bundle": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.physical_bundle"
}
],
"description": "The physical bundle object belonging to this personalization design.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.physical_bundle"
}
]
}
},
"rejection_reasons": {
"$ref": "#/components/schemas/issuing_personalization_design_rejection_reasons"
}
},
"description": "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.",
"x-resourceId": "issuing.personalization_design",
"x-expandableFields": [
"card_logo",
"carrier_text",
"physical_bundle",
"preferences",
"rejection_reasons"
]
}
issuing.physical_bundle
{
"type": "object",
"title": "IssuingPhysicalBundle",
"required": [
"features",
"id",
"livemode",
"name",
"object",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "Friendly display name."
},
"type": {
"enum": [
"custom",
"standard"
],
"type": "string",
"description": "Whether this physical bundle is a standard Stripe offering or custom-made for you."
},
"object": {
"enum": [
"issuing.physical_bundle"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"inactive",
"review"
],
"type": "string",
"description": "Whether this physical bundle can be used to create cards."
},
"features": {
"$ref": "#/components/schemas/issuing_physical_bundle_features"
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
}
},
"description": "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.",
"x-resourceId": "issuing.physical_bundle",
"x-expandableFields": [
"features"
]
}
issuing.settlement
{
"type": "object",
"title": "IssuingSettlement",
"required": [
"bin",
"clearing_date",
"created",
"currency",
"id",
"interchange_fees_amount",
"livemode",
"metadata",
"net_total_amount",
"network",
"network_fees_amount",
"network_settlement_identifier",
"object",
"settlement_service",
"status",
"transaction_amount",
"transaction_count"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"bin": {
"type": "string",
"maxLength": 5000,
"description": "The Bank Identification Number reflecting this settlement record."
},
"object": {
"enum": [
"issuing.settlement"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"complete",
"pending"
],
"type": "string",
"description": "The current processing status of this settlement."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"network": {
"enum": [
"maestro",
"mastercard",
"visa"
],
"type": "string",
"description": "The card network for this settlement report. One of [\"visa\", \"maestro\", \"mastercard\"]"
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"clearing_date": {
"type": "integer",
"format": "unix-time",
"description": "The date that the transactions are cleared and posted to user's accounts."
},
"net_total_amount": {
"type": "integer",
"description": "The total net amount required to settle with the network."
},
"transaction_count": {
"type": "integer",
"description": "The total number of transactions reflected in this settlement."
},
"settlement_service": {
"type": "string",
"maxLength": 5000,
"description": "One of `international` or `uk_national_net`."
},
"transaction_amount": {
"type": "integer",
"description": "The total transaction amount reflected in this settlement."
},
"network_fees_amount": {
"type": "integer",
"description": "The total amount of fees owed to the network."
},
"interchange_fees_amount": {
"type": "integer",
"description": "The total interchange received as reimbursement for the transactions."
},
"network_settlement_identifier": {
"type": "string",
"maxLength": 5000,
"description": "The Settlement Identification Number assigned by the network."
}
},
"description": "When a non-stripe BIN is used, any use of an [issued card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.",
"x-resourceId": "issuing.settlement",
"x-expandableFields": []
}
issuing.token
{
"type": "object",
"title": "IssuingNetworkToken",
"required": [
"card",
"created",
"id",
"livemode",
"network",
"network_updated_at",
"object",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"card": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.card"
}
],
"description": "Card associated with this token.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.card"
}
]
}
},
"last4": {
"type": "string",
"maxLength": 5000,
"description": "The last four digits of the token."
},
"object": {
"enum": [
"issuing.token"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"deleted",
"requested",
"suspended"
],
"type": "string",
"description": "The usage state of the token."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"network": {
"enum": [
"mastercard",
"visa"
],
"type": "string",
"description": "The token service provider / card network associated with the token."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"network_data": {
"$ref": "#/components/schemas/issuing_network_token_network_data"
},
"wallet_provider": {
"enum": [
"apple_pay",
"google_pay",
"samsung_pay"
],
"type": "string",
"description": "The digital wallet for this token, if one was used."
},
"device_fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The hashed ID derived from the device ID from the card network associated with the token."
},
"network_updated_at": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch."
}
},
"description": "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe.",
"x-resourceId": "issuing.token",
"x-expandableFields": [
"card",
"network_data"
]
}
issuing.transaction
{
"type": "object",
"title": "IssuingTransaction",
"required": [
"amount",
"card",
"created",
"currency",
"id",
"livemode",
"merchant_amount",
"merchant_currency",
"merchant_data",
"metadata",
"object",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"card": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.card"
}
],
"description": "The card used to make this transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.card"
}
]
}
},
"type": {
"enum": [
"capture",
"refund"
],
"type": "string",
"description": "The nature of the transaction.",
"x-stripeBypassValidation": true
},
"token": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.token"
}
],
"nullable": true,
"description": "[Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.token"
}
]
}
},
"amount": {
"type": "integer",
"description": "The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"object": {
"enum": [
"issuing.transaction"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"wallet": {
"enum": [
"apple_pay",
"google_pay",
"samsung_pay"
],
"type": "string",
"nullable": true,
"description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"dispute": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.dispute"
}
],
"nullable": true,
"description": "If you've disputed the transaction, the ID of the dispute.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.dispute"
}
]
}
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"treasury": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_treasury"
}
],
"nullable": true,
"description": "[Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts"
},
"cardholder": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.cardholder"
}
],
"nullable": true,
"description": "The cardholder to whom this transaction belongs.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.cardholder"
}
]
}
},
"network_data": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_network_data"
}
],
"nullable": true,
"description": "Details about the transaction, such as processing dates, set by the card network."
},
"authorization": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/issuing.authorization"
}
],
"nullable": true,
"description": "The `Authorization` object that led to this transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/issuing.authorization"
}
]
}
},
"merchant_data": {
"$ref": "#/components/schemas/issuing_authorization_merchant_data"
},
"amount_details": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_amount_details"
}
],
"nullable": true,
"description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"merchant_amount": {
"type": "integer",
"description": "The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency."
},
"purchase_details": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_transaction_purchase_details"
}
],
"nullable": true,
"description": "Additional purchase information that is optionally provided by the merchant."
},
"merchant_currency": {
"type": "string",
"format": "currency",
"description": "The currency with which the merchant is taking payment."
},
"balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"nullable": true,
"description": "ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
}
},
"description": "Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions)",
"x-resourceId": "issuing.transaction",
"x-expandableFields": [
"amount_details",
"authorization",
"balance_transaction",
"card",
"cardholder",
"dispute",
"merchant_data",
"network_data",
"purchase_details",
"token",
"treasury"
]
}
issuing_authorization_amount_details
{
"type": "object",
"title": "IssuingAuthorizationAmountDetails",
"properties": {
"atm_fee": {
"type": "integer",
"nullable": true,
"description": "The fee charged by the ATM for the cash withdrawal."
},
"cashback_amount": {
"type": "integer",
"nullable": true,
"description": "The amount of cash requested by the cardholder."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_authentication_exemption
{
"type": "object",
"title": "IssuingAuthorizationAuthenticationExemption",
"required": [
"claimed_by",
"type"
],
"properties": {
"type": {
"enum": [
"low_value_transaction",
"transaction_risk_analysis",
"unknown"
],
"type": "string",
"description": "The specific exemption claimed for this authorization.",
"x-stripeBypassValidation": true
},
"claimed_by": {
"enum": [
"acquirer",
"issuer"
],
"type": "string",
"description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_fleet_cardholder_prompt_data
{
"type": "object",
"title": "IssuingAuthorizationFleetCardholderPromptData",
"properties": {
"user_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "User ID."
},
"odometer": {
"type": "integer",
"nullable": true,
"description": "Odometer reading."
},
"driver_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Driver ID."
},
"unspecified_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."
},
"vehicle_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Vehicle number."
},
"alphanumeric_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_fleet_data
{
"type": "object",
"title": "IssuingAuthorizationFleetData",
"properties": {
"service_type": {
"enum": [
"full_service",
"non_fuel_transaction",
"self_service"
],
"type": "string",
"nullable": true,
"description": "The type of fuel service."
},
"purchase_type": {
"enum": [
"fuel_and_non_fuel_purchase",
"fuel_purchase",
"non_fuel_purchase"
],
"type": "string",
"nullable": true,
"description": "The type of purchase."
},
"reported_breakdown": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown"
}
],
"nullable": true,
"description": "More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data."
},
"cardholder_prompt_data": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data"
}
],
"nullable": true,
"description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry."
}
},
"description": "",
"x-expandableFields": [
"cardholder_prompt_data",
"reported_breakdown"
]
}
issuing_authorization_fleet_fuel_price_data
{
"type": "object",
"title": "IssuingAuthorizationFleetFuelPriceData",
"properties": {
"gross_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_fleet_non_fuel_price_data
{
"type": "object",
"title": "IssuingAuthorizationFleetNonFuelPriceData",
"properties": {
"gross_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_fleet_reported_breakdown
{
"type": "object",
"title": "IssuingAuthorizationFleetReportedBreakdown",
"properties": {
"tax": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fleet_tax_data"
}
],
"nullable": true,
"description": "Information about tax included in this transaction."
},
"fuel": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data"
}
],
"nullable": true,
"description": "Breakdown of fuel portion of the purchase."
},
"non_fuel": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data"
}
],
"nullable": true,
"description": "Breakdown of non-fuel portion of the purchase."
}
},
"description": "",
"x-expandableFields": [
"fuel",
"non_fuel",
"tax"
]
}
issuing_authorization_fleet_tax_data
{
"type": "object",
"title": "IssuingAuthorizationFleetTaxData",
"properties": {
"local_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax."
},
"national_amount_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_fraud_challenge
{
"type": "object",
"title": "IssuingAuthorizationFraudChallenge",
"required": [
"channel",
"status"
],
"properties": {
"status": {
"enum": [
"expired",
"pending",
"rejected",
"undeliverable",
"verified"
],
"type": "string",
"description": "The status of the fraud challenge."
},
"channel": {
"enum": [
"sms"
],
"type": "string",
"description": "The method by which the fraud challenge was delivered to the cardholder."
},
"undeliverable_reason": {
"enum": [
"no_phone_number",
"unsupported_phone_number"
],
"type": "string",
"nullable": true,
"description": "If the challenge is not deliverable, the reason why."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_fuel_data
{
"type": "object",
"title": "IssuingAuthorizationFuelData",
"properties": {
"type": {
"enum": [
"diesel",
"other",
"unleaded_plus",
"unleaded_regular",
"unleaded_super"
],
"type": "string",
"nullable": true,
"description": "The type of fuel that was purchased."
},
"unit": {
"enum": [
"charging_minute",
"imperial_gallon",
"kilogram",
"kilowatt_hour",
"liter",
"other",
"pound",
"us_gallon"
],
"type": "string",
"nullable": true,
"description": "The units for `quantity_decimal`."
},
"quantity_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places."
},
"unit_cost_decimal": {
"type": "string",
"format": "decimal",
"nullable": true,
"description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places."
},
"industry_product_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_merchant_data
{
"type": "object",
"title": "IssuingAuthorizationMerchantData",
"required": [
"category",
"category_code",
"network_id"
],
"properties": {
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "URL provided by the merchant on a 3DS request"
},
"city": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "City where the seller is located"
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the seller"
},
"state": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "State where the seller is located"
},
"tax_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The seller's tax identification number. Currently populated for French merchants only."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Country where the seller is located"
},
"category": {
"type": "string",
"maxLength": 5000,
"description": "A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values."
},
"network_id": {
"type": "string",
"maxLength": 5000,
"description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant."
},
"postal_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Postal code where the seller is located"
},
"terminal_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An ID assigned by the seller to the location of the sale."
},
"category_code": {
"type": "string",
"maxLength": 5000,
"description": "The merchant category code for the seller’s business"
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_network_data
{
"type": "object",
"title": "IssuingAuthorizationNetworkData",
"properties": {
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions."
},
"acquiring_institution_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`."
},
"system_trace_audit_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements."
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_pending_request
{
"type": "object",
"title": "IssuingAuthorizationPendingRequest",
"required": [
"amount",
"currency",
"is_amount_controllable",
"merchant_amount",
"merchant_currency"
],
"properties": {
"amount": {
"type": "integer",
"description": "The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"amount_details": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_amount_details"
}
],
"nullable": true,
"description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"merchant_amount": {
"type": "integer",
"description": "The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"merchant_currency": {
"type": "string",
"format": "currency",
"description": "The local currency the merchant is requesting to authorize."
},
"network_risk_score": {
"type": "integer",
"nullable": true,
"description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99."
},
"is_amount_controllable": {
"type": "boolean",
"description": "If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization."
}
},
"description": "",
"x-expandableFields": [
"amount_details"
]
}
issuing_authorization_request
{
"type": "object",
"title": "IssuingAuthorizationRequest",
"required": [
"amount",
"approved",
"created",
"currency",
"merchant_amount",
"merchant_currency",
"reason"
],
"properties": {
"amount": {
"type": "integer",
"description": "The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved."
},
"reason": {
"enum": [
"account_disabled",
"card_active",
"card_canceled",
"card_expired",
"card_inactive",
"cardholder_blocked",
"cardholder_inactive",
"cardholder_verification_required",
"insecure_authorization_method",
"insufficient_funds",
"network_fallback",
"not_allowed",
"pin_blocked",
"spending_controls",
"suspected_fraud",
"verification_failed",
"webhook_approved",
"webhook_declined",
"webhook_error",
"webhook_timeout"
],
"type": "string",
"description": "When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.",
"x-stripeBypassValidation": true
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"approved": {
"type": "boolean",
"description": "Whether this request was approved."
},
"currency": {
"type": "string",
"maxLength": 5000,
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"requested_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time."
},
"amount_details": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_amount_details"
}
],
"nullable": true,
"description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"reason_message": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field."
},
"merchant_amount": {
"type": "integer",
"description": "The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"merchant_currency": {
"type": "string",
"maxLength": 5000,
"description": "The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"authorization_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations."
},
"network_risk_score": {
"type": "integer",
"nullable": true,
"description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99."
}
},
"description": "",
"x-expandableFields": [
"amount_details"
]
}
issuing_authorization_three_d_secure
{
"type": "object",
"title": "IssuingAuthorizationThreeDSecure",
"required": [
"result"
],
"properties": {
"result": {
"enum": [
"attempt_acknowledged",
"authenticated",
"failed",
"required"
],
"type": "string",
"description": "The outcome of the 3D Secure authentication request.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_treasury
{
"type": "object",
"title": "IssuingAuthorizationTreasury",
"required": [
"received_credits",
"received_debits"
],
"properties": {
"transaction": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Treasury [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization"
},
"received_debits": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "The array of [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization"
},
"received_credits": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization"
}
},
"description": "",
"x-expandableFields": []
}
issuing_authorization_verification_data
{
"type": "object",
"title": "IssuingAuthorizationVerificationData",
"required": [
"address_line1_check",
"address_postal_code_check",
"cvc_check",
"expiry_check"
],
"properties": {
"cvc_check": {
"enum": [
"match",
"mismatch",
"not_provided"
],
"type": "string",
"description": "Whether the cardholder provided a CVC and if it matched Stripe’s record."
},
"postal_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The postal code submitted as part of the authorization used for postal code verification."
},
"expiry_check": {
"enum": [
"match",
"mismatch",
"not_provided"
],
"type": "string",
"description": "Whether the cardholder provided an expiry date and if it matched Stripe’s record."
},
"three_d_secure": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_three_d_secure"
}
],
"nullable": true,
"description": "3D Secure details."
},
"address_line1_check": {
"enum": [
"match",
"mismatch",
"not_provided"
],
"type": "string",
"description": "Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`."
},
"authentication_exemption": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_authorization_authentication_exemption"
}
],
"nullable": true,
"description": "The exemption applied to this authorization."
},
"address_postal_code_check": {
"enum": [
"match",
"mismatch",
"not_provided"
],
"type": "string",
"description": "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`."
}
},
"description": "",
"x-expandableFields": [
"authentication_exemption",
"three_d_secure"
]
}
issuing_card_apple_pay
{
"type": "object",
"title": "IssuingCardApplePay",
"required": [
"eligible"
],
"properties": {
"eligible": {
"type": "boolean",
"description": "Apple Pay Eligibility"
},
"ineligible_reason": {
"enum": [
"missing_agreement",
"missing_cardholder_contact",
"unsupported_region"
],
"type": "string",
"nullable": true,
"description": "Reason the card is ineligible for Apple Pay"
}
},
"description": "",
"x-expandableFields": []
}
issuing_card_authorization_controls
{
"type": "object",
"title": "IssuingCardAuthorizationControls",
"properties": {
"spending_limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/issuing_card_spending_limit"
},
"nullable": true,
"description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain)."
},
"allowed_categories": {
"type": "array",
"items": {
"enum": [
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards"
],
"type": "string"
},
"nullable": true,
"description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`."
},
"blocked_categories": {
"type": "array",
"items": {
"enum": [
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards"
],
"type": "string"
},
"nullable": true,
"description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`."
},
"allowed_card_presences": {
"type": "array",
"items": {
"enum": [
"not_present",
"present"
],
"type": "string"
},
"nullable": true,
"description": "Array of card presence statuses from which authorizations will be allowed. Possible options are `present`, `not_present`. All other statuses will be blocked. Cannot be set with `blocked_card_presences`. Provide an empty value to unset this control."
},
"blocked_card_presences": {
"type": "array",
"items": {
"enum": [
"not_present",
"present"
],
"type": "string"
},
"nullable": true,
"description": "Array of card presence statuses from which authorizations will be declined. Possible options are `present`, `not_present`. Cannot be set with `allowed_card_presences`. Provide an empty value to unset this control."
},
"spending_limits_currency": {
"type": "string",
"format": "currency",
"nullable": true,
"description": "Currency of the amounts within `spending_limits`. Always the same as the currency of the card."
},
"allowed_merchant_countries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "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."
},
"blocked_merchant_countries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"spending_limits"
]
}
issuing_card_fraud_warning
{
"type": "object",
"title": "IssuingCardFraudWarning",
"properties": {
"type": {
"enum": [
"card_testing_exposure",
"fraud_dispute_filed",
"third_party_reported",
"user_indicated_fraud"
],
"type": "string",
"nullable": true,
"description": "The type of fraud warning that most recently took place on this card. This field updates with every new fraud warning, so the value changes over time. If populated, cancel and reissue the card."
},
"started_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Timestamp of the most recent fraud warning."
}
},
"description": "",
"x-expandableFields": []
}
issuing_card_google_pay
{
"type": "object",
"title": "IssuingCardGooglePay",
"required": [
"eligible"
],
"properties": {
"eligible": {
"type": "boolean",
"description": "Google Pay Eligibility"
},
"ineligible_reason": {
"enum": [
"missing_agreement",
"missing_cardholder_contact",
"unsupported_region"
],
"type": "string",
"nullable": true,
"description": "Reason the card is ineligible for Google Pay"
}
},
"description": "",
"x-expandableFields": []
}
issuing_card_lifecycle_conditions
{
"type": "object",
"title": "IssuingCardLifecycleConditions",
"required": [
"payment_count"
],
"properties": {
"payment_count": {
"type": "integer",
"description": "The card is automatically cancelled when it makes this number of non-zero payment authorizations and transactions. The count includes penny authorizations, but doesn't include non-payment actions, such as authorization advice."
}
},
"description": "",
"x-expandableFields": []
}
issuing_card_lifecycle_controls
{
"type": "object",
"title": "IssuingCardLifecycleControls",
"required": [
"cancel_after"
],
"properties": {
"cancel_after": {
"$ref": "#/components/schemas/issuing_card_lifecycle_conditions"
}
},
"description": "",
"x-expandableFields": [
"cancel_after"
]
}
issuing_card_shipping
{
"type": "object",
"title": "IssuingCardShipping",
"required": [
"address",
"name",
"service",
"type"
],
"properties": {
"eta": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "A unix timestamp representing a best estimate of when the card will be delivered."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "Recipient name."
},
"type": {
"enum": [
"bulk",
"individual"
],
"type": "string",
"description": "Packaging options."
},
"status": {
"enum": [
"canceled",
"delivered",
"failure",
"pending",
"returned",
"shipped",
"submitted"
],
"type": "string",
"nullable": true,
"description": "The delivery status of the card."
},
"address": {
"$ref": "#/components/schemas/address"
},
"carrier": {
"enum": [
"dhl",
"fedex",
"royal_mail",
"usps"
],
"type": "string",
"nullable": true,
"description": "The delivery company that shipped a card."
},
"customs": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_card_shipping_customs"
}
],
"nullable": true,
"description": "Additional information that may be required for clearing customs."
},
"service": {
"enum": [
"express",
"priority",
"standard"
],
"type": "string",
"description": "Shipment service, such as `standard` or `express`.",
"x-stripeBypassValidation": true
},
"phone_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created."
},
"tracking_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A link to the shipping carrier's site where you can view detailed information about a card shipment."
},
"tracking_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A tracking number for a card shipment."
},
"require_signature": {
"type": "boolean",
"nullable": true,
"description": "Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true."
},
"address_validation": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_card_shipping_address_validation"
}
],
"nullable": true,
"description": "Address validation details for the shipment."
}
},
"description": "",
"x-expandableFields": [
"address",
"address_validation",
"customs"
]
}
issuing_card_shipping_address_validation
{
"type": "object",
"title": "IssuingCardShippingAddressValidation",
"required": [
"mode"
],
"properties": {
"mode": {
"enum": [
"disabled",
"normalization_only",
"validation_and_normalization"
],
"type": "string",
"description": "The address validation capabilities to use."
},
"result": {
"enum": [
"indeterminate",
"likely_deliverable",
"likely_undeliverable"
],
"type": "string",
"nullable": true,
"description": "The validation result for the shipping address."
},
"normalized_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "The normalized shipping address."
}
},
"description": "",
"x-expandableFields": [
"normalized_address"
]
}
issuing_card_shipping_customs
{
"type": "object",
"title": "IssuingCardShippingCustoms",
"properties": {
"eori_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU."
}
},
"description": "",
"x-expandableFields": []
}
issuing_card_spending_limit
{
"type": "object",
"title": "IssuingCardSpendingLimit",
"required": [
"amount",
"interval"
],
"properties": {
"amount": {
"type": "integer",
"description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"interval": {
"enum": [
"all_time",
"daily",
"monthly",
"per_authorization",
"weekly",
"yearly"
],
"type": "string",
"description": "Interval (or event) to which the amount applies."
},
"categories": {
"type": "array",
"items": {
"enum": [
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards"
],
"type": "string"
},
"nullable": true,
"description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories."
}
},
"description": "",
"x-expandableFields": []
}
issuing_card_wallets
{
"type": "object",
"title": "IssuingCardWallets",
"required": [
"apple_pay",
"google_pay"
],
"properties": {
"apple_pay": {
"$ref": "#/components/schemas/issuing_card_apple_pay"
},
"google_pay": {
"$ref": "#/components/schemas/issuing_card_google_pay"
},
"primary_account_identifier": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique identifier for a card used with digital wallets"
}
},
"description": "",
"x-expandableFields": [
"apple_pay",
"google_pay"
]
}
issuing_cardholder_address
{
"type": "object",
"title": "IssuingCardholderAddress",
"required": [
"address"
],
"properties": {
"address": {
"$ref": "#/components/schemas/address"
}
},
"description": "",
"x-expandableFields": [
"address"
]
}
issuing_cardholder_authorization_controls
{
"type": "object",
"title": "IssuingCardholderAuthorizationControls",
"properties": {
"spending_limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/issuing_cardholder_spending_limit"
},
"nullable": true,
"description": "Limit spending with amount-based rules that apply across this cardholder's cards."
},
"allowed_categories": {
"type": "array",
"items": {
"enum": [
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards"
],
"type": "string"
},
"nullable": true,
"description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`."
},
"blocked_categories": {
"type": "array",
"items": {
"enum": [
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards"
],
"type": "string"
},
"nullable": true,
"description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`."
},
"allowed_card_presences": {
"type": "array",
"items": {
"enum": [
"not_present",
"present"
],
"type": "string"
},
"nullable": true,
"description": "Array of card presence statuses from which authorizations will be allowed. Possible options are `present`, `not_present`. All other statuses will be blocked. Cannot be set with `blocked_card_presences`. Provide an empty value to unset this control."
},
"blocked_card_presences": {
"type": "array",
"items": {
"enum": [
"not_present",
"present"
],
"type": "string"
},
"nullable": true,
"description": "Array of card presence statuses from which authorizations will be declined. Possible options are `present`, `not_present`. Cannot be set with `allowed_card_presences`. Provide an empty value to unset this control."
},
"spending_limits_currency": {
"type": "string",
"format": "currency",
"nullable": true,
"description": "Currency of the amounts within `spending_limits`."
},
"allowed_merchant_countries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "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."
},
"blocked_merchant_countries": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"spending_limits"
]
}
issuing_cardholder_card_issuing
{
"type": "object",
"title": "IssuingCardholderCardIssuing",
"properties": {
"user_terms_acceptance": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_cardholder_user_terms_acceptance"
}
],
"nullable": true,
"description": "Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program."
}
},
"description": "",
"x-expandableFields": [
"user_terms_acceptance"
]
}
issuing_cardholder_company
{
"type": "object",
"title": "IssuingCardholderCompany",
"required": [
"tax_id_provided"
],
"properties": {
"tax_id_provided": {
"type": "boolean",
"description": "Whether the company's business ID number was provided."
}
},
"description": "",
"x-expandableFields": []
}
issuing_cardholder_id_document
{
"type": "object",
"title": "IssuingCardholderIdDocument",
"properties": {
"back": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"front": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"back",
"front"
]
}
issuing_cardholder_individual
{
"type": "object",
"title": "IssuingCardholderIndividual",
"properties": {
"dob": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_cardholder_individual_dob"
}
],
"nullable": true,
"description": "The date of birth of this cardholder."
},
"last_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"first_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"card_issuing": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_cardholder_card_issuing"
}
],
"nullable": true,
"description": "Information related to the card_issuing program for this cardholder."
},
"verification": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_cardholder_verification"
}
],
"nullable": true,
"description": "Government-issued ID document for this cardholder."
}
},
"description": "",
"x-expandableFields": [
"card_issuing",
"dob",
"verification"
]
}
issuing_cardholder_individual_dob
{
"type": "object",
"title": "IssuingCardholderIndividualDOB",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "The day of birth, between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year of birth."
},
"month": {
"type": "integer",
"nullable": true,
"description": "The month of birth, between 1 and 12."
}
},
"description": "",
"x-expandableFields": []
}
issuing_cardholder_requirements
{
"type": "object",
"title": "IssuingCardholderRequirements",
"properties": {
"past_due": {
"type": "array",
"items": {
"enum": [
"company.tax_id",
"individual.card_issuing.user_terms_acceptance.date",
"individual.card_issuing.user_terms_acceptance.ip",
"individual.dob.day",
"individual.dob.month",
"individual.dob.year",
"individual.first_name",
"individual.last_name",
"individual.verification.document"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "Array of fields that need to be collected in order to verify and re-enable the cardholder."
},
"disabled_reason": {
"enum": [
"listed",
"rejected.listed",
"requirements.past_due",
"under_review"
],
"type": "string",
"nullable": true,
"description": "If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason."
}
},
"description": "",
"x-expandableFields": []
}
issuing_cardholder_spending_limit
{
"type": "object",
"title": "IssuingCardholderSpendingLimit",
"required": [
"amount",
"interval"
],
"properties": {
"amount": {
"type": "integer",
"description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
},
"interval": {
"enum": [
"all_time",
"daily",
"monthly",
"per_authorization",
"weekly",
"yearly"
],
"type": "string",
"description": "Interval (or event) to which the amount applies."
},
"categories": {
"type": "array",
"items": {
"enum": [
"ac_refrigeration_repair",
"accounting_bookkeeping_services",
"advertising_services",
"agricultural_cooperative",
"airlines_air_carriers",
"airports_flying_fields",
"ambulance_services",
"amusement_parks_carnivals",
"antique_reproductions",
"antique_shops",
"aquariums",
"architectural_surveying_services",
"art_dealers_and_galleries",
"artists_supply_and_craft_shops",
"auto_and_home_supply_stores",
"auto_body_repair_shops",
"auto_paint_shops",
"auto_service_shops",
"automated_cash_disburse",
"automated_fuel_dispensers",
"automobile_associations",
"automotive_parts_and_accessories_stores",
"automotive_tire_stores",
"bail_and_bond_payments",
"bakeries",
"bands_orchestras",
"barber_and_beauty_shops",
"betting_casino_gambling",
"bicycle_shops",
"billiard_pool_establishments",
"boat_dealers",
"boat_rentals_and_leases",
"book_stores",
"books_periodicals_and_newspapers",
"bowling_alleys",
"bus_lines",
"business_secretarial_schools",
"buying_shopping_services",
"cable_satellite_and_other_pay_television_and_radio",
"camera_and_photographic_supply_stores",
"candy_nut_and_confectionery_stores",
"car_and_truck_dealers_new_used",
"car_and_truck_dealers_used_only",
"car_rental_agencies",
"car_washes",
"carpentry_services",
"carpet_upholstery_cleaning",
"caterers",
"charitable_and_social_service_organizations_fundraising",
"chemicals_and_allied_products",
"child_care_services",
"childrens_and_infants_wear_stores",
"chiropodists_podiatrists",
"chiropractors",
"cigar_stores_and_stands",
"civic_social_fraternal_associations",
"cleaning_and_maintenance",
"clothing_rental",
"colleges_universities",
"commercial_equipment",
"commercial_footwear",
"commercial_photography_art_and_graphics",
"commuter_transport_and_ferries",
"computer_network_services",
"computer_programming",
"computer_repair",
"computer_software_stores",
"computers_peripherals_and_software",
"concrete_work_services",
"construction_materials",
"consulting_public_relations",
"correspondence_schools",
"cosmetic_stores",
"counseling_services",
"country_clubs",
"courier_services",
"court_costs",
"credit_reporting_agencies",
"cruise_lines",
"dairy_products_stores",
"dance_hall_studios_schools",
"dating_escort_services",
"dentists_orthodontists",
"department_stores",
"detective_agencies",
"digital_goods_applications",
"digital_goods_games",
"digital_goods_large_volume",
"digital_goods_media",
"direct_marketing_catalog_merchant",
"direct_marketing_combination_catalog_and_retail_merchant",
"direct_marketing_inbound_telemarketing",
"direct_marketing_insurance_services",
"direct_marketing_other",
"direct_marketing_outbound_telemarketing",
"direct_marketing_subscription",
"direct_marketing_travel",
"discount_stores",
"doctors",
"door_to_door_sales",
"drapery_window_covering_and_upholstery_stores",
"drinking_places",
"drug_stores_and_pharmacies",
"drugs_drug_proprietaries_and_druggist_sundries",
"dry_cleaners",
"durable_goods",
"duty_free_stores",
"eating_places_restaurants",
"educational_services",
"electric_razor_stores",
"electric_vehicle_charging",
"electrical_parts_and_equipment",
"electrical_services",
"electronics_repair_shops",
"electronics_stores",
"elementary_secondary_schools",
"emergency_services_gcas_visa_use_only",
"employment_temp_agencies",
"equipment_rental",
"exterminating_services",
"family_clothing_stores",
"fast_food_restaurants",
"financial_institutions",
"fines_government_administrative_entities",
"fireplace_fireplace_screens_and_accessories_stores",
"floor_covering_stores",
"florists",
"florists_supplies_nursery_stock_and_flowers",
"freezer_and_locker_meat_provisioners",
"fuel_dealers_non_automotive",
"funeral_services_crematories",
"furniture_home_furnishings_and_equipment_stores_except_appliances",
"furniture_repair_refinishing",
"furriers_and_fur_shops",
"general_services",
"gift_card_novelty_and_souvenir_shops",
"glass_paint_and_wallpaper_stores",
"glassware_crystal_stores",
"golf_courses_public",
"government_licensed_horse_dog_racing_us_region_only",
"government_licensed_online_casions_online_gambling_us_region_only",
"government_owned_lotteries_non_us_region",
"government_owned_lotteries_us_region_only",
"government_services",
"grocery_stores_supermarkets",
"hardware_equipment_and_supplies",
"hardware_stores",
"health_and_beauty_spas",
"hearing_aids_sales_and_supplies",
"heating_plumbing_a_c",
"hobby_toy_and_game_shops",
"home_supply_warehouse_stores",
"hospitals",
"hotels_motels_and_resorts",
"household_appliance_stores",
"industrial_supplies",
"information_retrieval_services",
"insurance_default",
"insurance_underwriting_premiums",
"intra_company_purchases",
"jewelry_stores_watches_clocks_and_silverware_stores",
"landscaping_services",
"laundries",
"laundry_cleaning_services",
"legal_services_attorneys",
"luggage_and_leather_goods_stores",
"lumber_building_materials_stores",
"manual_cash_disburse",
"marinas_service_and_supplies",
"marketplaces",
"masonry_stonework_and_plaster",
"massage_parlors",
"medical_and_dental_labs",
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
"medical_services",
"membership_organizations",
"mens_and_boys_clothing_and_accessories_stores",
"mens_womens_clothing_stores",
"metal_service_centers",
"miscellaneous",
"miscellaneous_apparel_and_accessory_shops",
"miscellaneous_auto_dealers",
"miscellaneous_business_services",
"miscellaneous_food_stores",
"miscellaneous_general_merchandise",
"miscellaneous_general_services",
"miscellaneous_home_furnishing_specialty_stores",
"miscellaneous_publishing_and_printing",
"miscellaneous_recreation_services",
"miscellaneous_repair_shops",
"miscellaneous_specialty_retail",
"mobile_home_dealers",
"motion_picture_theaters",
"motor_freight_carriers_and_trucking",
"motor_homes_dealers",
"motor_vehicle_supplies_and_new_parts",
"motorcycle_shops_and_dealers",
"motorcycle_shops_dealers",
"music_stores_musical_instruments_pianos_and_sheet_music",
"news_dealers_and_newsstands",
"non_fi_money_orders",
"non_fi_stored_value_card_purchase_load",
"nondurable_goods",
"nurseries_lawn_and_garden_supply_stores",
"nursing_personal_care",
"office_and_commercial_furniture",
"opticians_eyeglasses",
"optometrists_ophthalmologist",
"orthopedic_goods_prosthetic_devices",
"osteopaths",
"package_stores_beer_wine_and_liquor",
"paints_varnishes_and_supplies",
"parking_lots_garages",
"passenger_railways",
"pawn_shops",
"pet_shops_pet_food_and_supplies",
"petroleum_and_petroleum_products",
"photo_developing",
"photographic_photocopy_microfilm_equipment_and_supplies",
"photographic_studios",
"picture_video_production",
"piece_goods_notions_and_other_dry_goods",
"plumbing_heating_equipment_and_supplies",
"political_organizations",
"postal_services_government_only",
"precious_stones_and_metals_watches_and_jewelry",
"professional_services",
"public_warehousing_and_storage",
"quick_copy_repro_and_blueprint",
"railroads",
"real_estate_agents_and_managers_rentals",
"record_stores",
"recreational_vehicle_rentals",
"religious_goods_stores",
"religious_organizations",
"roofing_siding_sheet_metal",
"secretarial_support_services",
"security_brokers_dealers",
"service_stations",
"sewing_needlework_fabric_and_piece_goods_stores",
"shoe_repair_hat_cleaning",
"shoe_stores",
"small_appliance_repair",
"snowmobile_dealers",
"special_trade_services",
"specialty_cleaning",
"sporting_goods_stores",
"sporting_recreation_camps",
"sports_and_riding_apparel_stores",
"sports_clubs_fields",
"stamp_and_coin_stores",
"stationary_office_supplies_printing_and_writing_paper",
"stationery_stores_office_and_school_supply_stores",
"swimming_pools_sales",
"t_ui_travel_germany",
"tailors_alterations",
"tax_payments_government_agencies",
"tax_preparation_services",
"taxicabs_limousines",
"telecommunication_equipment_and_telephone_sales",
"telecommunication_services",
"telegraph_services",
"tent_and_awning_shops",
"testing_laboratories",
"theatrical_ticket_agencies",
"timeshares",
"tire_retreading_and_repair",
"tolls_bridge_fees",
"tourist_attractions_and_exhibits",
"towing_services",
"trailer_parks_campgrounds",
"transportation_services",
"travel_agencies_tour_operators",
"truck_stop_iteration",
"truck_utility_trailer_rentals",
"typesetting_plate_making_and_related_services",
"typewriter_stores",
"u_s_federal_government_agencies_or_departments",
"uniforms_commercial_clothing",
"used_merchandise_and_secondhand_stores",
"utilities",
"variety_stores",
"veterinary_services",
"video_amusement_game_supplies",
"video_game_arcades",
"video_tape_rental_stores",
"vocational_trade_schools",
"watch_jewelry_repair",
"welding_repair",
"wholesale_clubs",
"wig_and_toupee_stores",
"wires_money_orders",
"womens_accessory_and_specialty_shops",
"womens_ready_to_wear_stores",
"wrecking_and_salvage_yards"
],
"type": "string"
},
"nullable": true,
"description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories."
}
},
"description": "",
"x-expandableFields": []
}
issuing_cardholder_user_terms_acceptance
{
"type": "object",
"title": "IssuingCardholderUserTermsAcceptance",
"properties": {
"ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address from which the cardholder accepted the Authorized User Terms."
},
"date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms."
},
"user_agent": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms."
}
},
"description": "",
"x-expandableFields": []
}
issuing_cardholder_verification
{
"type": "object",
"title": "IssuingCardholderVerification",
"properties": {
"document": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_cardholder_id_document"
}
],
"nullable": true,
"description": "An identifying document, either a passport or local ID card."
}
},
"description": "",
"x-expandableFields": [
"document"
]
}
issuing_dispute_canceled_evidence
{
"type": "object",
"title": "IssuingDisputeCanceledEvidence",
"properties": {
"canceled_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Date when order was canceled."
},
"expected_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Date when the cardholder expected to receive the product."
},
"explanation": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Explanation of why the cardholder is disputing this transaction."
},
"returned_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Date when the product was returned or attempted to be returned."
},
"product_type": {
"enum": [
"merchandise",
"service"
],
"type": "string",
"nullable": true,
"description": "Whether the product was a merchandise or service."
},
"return_status": {
"enum": [
"merchant_rejected",
"successful"
],
"type": "string",
"nullable": true,
"description": "Result of cardholder's attempt to return the product."
},
"cancellation_reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Reason for canceling the order."
},
"product_description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Description of the merchandise or service that was purchased."
},
"additional_documentation": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"cancellation_policy_provided": {
"type": "boolean",
"nullable": true,
"description": "Whether the cardholder was provided with a cancellation policy."
}
},
"description": "",
"x-expandableFields": [
"additional_documentation"
]
}
issuing_dispute_duplicate_evidence
{
"type": "object",
"title": "IssuingDisputeDuplicateEvidence",
"properties": {
"check_image": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"explanation": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Explanation of why the cardholder is disputing this transaction."
},
"cash_receipt": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"card_statement": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"original_transaction": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one."
},
"additional_documentation": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"additional_documentation",
"card_statement",
"cash_receipt",
"check_image"
]
}
issuing_dispute_evidence
{
"type": "object",
"title": "IssuingDisputeEvidence",
"required": [
"reason"
],
"properties": {
"other": {
"$ref": "#/components/schemas/issuing_dispute_other_evidence"
},
"reason": {
"enum": [
"canceled",
"duplicate",
"fraudulent",
"merchandise_not_as_described",
"no_valid_authorization",
"not_received",
"other",
"service_not_as_described"
],
"type": "string",
"description": "The reason for filing the dispute. Its value will match the field containing the evidence.",
"x-stripeBypassValidation": true
},
"canceled": {
"$ref": "#/components/schemas/issuing_dispute_canceled_evidence"
},
"duplicate": {
"$ref": "#/components/schemas/issuing_dispute_duplicate_evidence"
},
"fraudulent": {
"$ref": "#/components/schemas/issuing_dispute_fraudulent_evidence"
},
"not_received": {
"$ref": "#/components/schemas/issuing_dispute_not_received_evidence"
},
"no_valid_authorization": {
"$ref": "#/components/schemas/issuing_dispute_no_valid_authorization_evidence"
},
"service_not_as_described": {
"$ref": "#/components/schemas/issuing_dispute_service_not_as_described_evidence"
},
"merchandise_not_as_described": {
"$ref": "#/components/schemas/issuing_dispute_merchandise_not_as_described_evidence"
}
},
"description": "",
"x-expandableFields": [
"canceled",
"duplicate",
"fraudulent",
"merchandise_not_as_described",
"no_valid_authorization",
"not_received",
"other",
"service_not_as_described"
]
}
issuing_dispute_fraudulent_evidence
{
"type": "object",
"title": "IssuingDisputeFraudulentEvidence",
"properties": {
"explanation": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Explanation of why the cardholder is disputing this transaction."
},
"additional_documentation": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"additional_documentation"
]
}
issuing_dispute_merchandise_not_as_described_evidence
{
"type": "object",
"title": "IssuingDisputeMerchandiseNotAsDescribedEvidence",
"properties": {
"explanation": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Explanation of why the cardholder is disputing this transaction."
},
"received_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Date when the product was received."
},
"returned_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Date when the product was returned or attempted to be returned."
},
"return_status": {
"enum": [
"merchant_rejected",
"successful"
],
"type": "string",
"nullable": true,
"description": "Result of cardholder's attempt to return the product."
},
"return_description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Description of the cardholder's attempt to return the product."
},
"additional_documentation": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"additional_documentation"
]
}