Stripe: Issuing schemas (part 2)
32 Stripe schemas with complete fields and constraints.
← Issuing operations · All schemas
Update a transaction — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing `Transaction` object. Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions) |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | 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). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_details | JSON | Optional | |
amount_details (anyOf 1) | JSON | Alternative | Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). |
amount_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — amount details value atm fee, cashback amount |
amount_details (anyOf 2) | null | Alternative | |
authorization | JSON | Optional | |
authorization (anyOf 1) | JSON | Alternative | The `Authorization` object that led to this transaction. |
authorization (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
authorization (anyOf 1) (anyOf 2) | Model | Alternative | Expand Update an authorization — response body |
authorization (anyOf 2) | null | Alternative | |
balance_transaction | JSON | Optional | |
balance_transaction (anyOf 1) | JSON | Alternative | ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction. |
balance_transaction (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
balance_transaction (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a balance transaction — balance get Balance History Id — response body |
balance_transaction (anyOf 2) | null | Alternative | |
card | JSON | Required within parent | The card used to make this transaction. |
card (anyOf 1) | string | Alternative | Maximum length: 5000 |
card (anyOf 2) | Model | Alternative | Expand Fail a testmode card — response body |
cardholder | JSON | Optional | |
cardholder (anyOf 1) | JSON | Alternative | The cardholder to whom this transaction belongs. |
cardholder (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
cardholder (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a cardholder — response body |
cardholder (anyOf 2) | null | Alternative | |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | 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). Format: currency |
dispute | JSON | Optional | |
dispute (anyOf 1) | JSON | Alternative | If you've disputed the transaction, the ID of the dispute. |
dispute (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
dispute (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a dispute — response body |
dispute (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
merchant_amount | JSON | Required within parent | |
merchant_amount (anyOf 1) | integer | Alternative | 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. |
merchant_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
merchant_currency | string | Required within parent | The currency with which the merchant is taking payment. Format: currency |
merchant_data | Model | Required within parent | Expand Update a transaction — response body — merchant data |
metadata | object | Required within parent | 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. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
network_data | JSON | Optional | |
network_data (anyOf 1) | JSON | Alternative | Details about the transaction, such as processing dates, set by the card network. |
network_data (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — network data value authorization code, processing date, transaction id |
network_data (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: issuing.transaction |
purchase_details | JSON | Optional | |
purchase_details (anyOf 1) | JSON | Alternative | Additional purchase information that is optionally provided by the merchant. |
purchase_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference |
purchase_details (anyOf 2) | null | Alternative | |
token | JSON | Optional | |
token (anyOf 1) | JSON | Alternative | [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. |
token (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
token (anyOf 1) (anyOf 2) | Model | Alternative | Expand Update a token status — response body |
token (anyOf 2) | null | Alternative | |
treasury | JSON | Optional | |
treasury (anyOf 1) | JSON | Alternative | [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts |
treasury (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — treasury value received credit, received debit |
treasury (anyOf 2) | null | Alternative | |
type | string | Required within parent | The nature of the transaction. Known values: capture, refund |
wallet | JSON | Optional | |
wallet (anyOf 1) | string | Alternative | The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Known values: apple_pay, google_pay, samsung_pay |
wallet (anyOf 2) | null | Alternative |
Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Update an authorization — response body, Fail a testmode card — response body, Create a cardholder — response body, Create a dispute — response body, Update a token status — response body, Update a transaction — response body — amount details value atm fee, cashback amount, Update a transaction — response body — merchant data, Update a transaction — response body — network data value authorization code, processing date, transaction id, Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference, Update a transaction — response body — treasury value received credit, received debit
Update a transaction — response body — amount details value atm fee, cashback amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
atm_fee | JSON | Optional | |
atm_fee (anyOf 1) | JSON | Alternative | |
atm_fee (anyOf 1) (anyOf 1) | integer | Alternative | The fee charged by the ATM for the cash withdrawal. |
atm_fee (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
atm_fee (anyOf 2) | null | Alternative | |
cashback_amount | JSON | Optional | |
cashback_amount (anyOf 1) | JSON | Alternative | |
cashback_amount (anyOf 1) (anyOf 1) | integer | Alternative | The amount of cash requested by the cardholder. |
cashback_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cashback_amount (anyOf 2) | null | Alternative |
Update a transaction — response body — merchant data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Required within parent | 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. Maximum length: 5000 |
category_code | string | Required within parent | The merchant category code for the seller’s business Maximum length: 5000 |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City where the seller is located Maximum length: 5000 |
city (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country where the seller is located Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the seller Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
network_id | string | Required within parent | Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. Maximum length: 5000 |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | Postal code where the seller is located Maximum length: 5000 |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State where the seller is located Maximum length: 5000 |
state (anyOf 2) | null | Alternative | |
tax_id | JSON | Optional | |
tax_id (anyOf 1) | string | Alternative | The seller's tax identification number. Currently populated for French merchants only. Maximum length: 5000 |
tax_id (anyOf 2) | null | Alternative | |
terminal_id | JSON | Optional | |
terminal_id (anyOf 1) | string | Alternative | An ID assigned by the seller to the location of the sale. Maximum length: 5000 |
terminal_id (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | URL provided by the merchant on a 3DS request Maximum length: 5000 |
url (anyOf 2) | null | Alternative |
Update a transaction — response body — network data value authorization code, processing date, transaction id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authorization_code | JSON | Optional | |
authorization_code (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
authorization_code (anyOf 2) | null | Alternative | |
processing_date | JSON | Optional | |
processing_date (anyOf 1) | string | Alternative | The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network. Maximum length: 5000 |
processing_date (anyOf 2) | null | Alternative | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fleet | JSON | Optional | |
fleet (anyOf 1) | JSON | Alternative | Fleet-specific information for transactions using Fleet cards. |
fleet (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type |
fleet (anyOf 2) | null | Alternative | |
flight | JSON | Optional | |
flight (anyOf 1) | JSON | Alternative | Information about the flight that was purchased with this transaction. |
flight (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference flight value departure at, passenger name, refundable, segments, travel agency |
flight (anyOf 2) | null | Alternative | |
fuel | JSON | Optional | |
fuel (anyOf 1) | JSON | Alternative | Information about fuel that was purchased with this transaction. |
fuel (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fuel value industry product code, quantity decimal, type, unit, unit cost decimal |
fuel (anyOf 2) | null | Alternative | |
lodging | JSON | Optional | |
lodging (anyOf 1) | JSON | Alternative | Information about lodging that was purchased with this transaction. |
lodging (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference lodging value check in at, nights |
lodging (anyOf 2) | null | Alternative | |
receipt | JSON | Optional | |
receipt (anyOf 1) | array | Alternative | The line items in the purchase. |
receipt (anyOf 1)[] | Model | Each item | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference receipt The line items in the purchase item |
receipt (anyOf 2) | null | Alternative | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | A merchant-specific order number. Maximum length: 5000 |
reference (anyOf 2) | null | Alternative |
Referenced models: Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type, Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference flight value departure at, passenger name, refundable, segments, travel agency, Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fuel value industry product code, quantity decimal, type, unit, unit cost decimal, Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference lodging value check in at, nights, Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference receipt The line items in the purchase item
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardholder_prompt_data | JSON | Optional | |
cardholder_prompt_data (anyOf 1) | JSON | Alternative | Answers to prompts presented to cardholder at point of sale. |
cardholder_prompt_data (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type cardholder prompt data value driver id, odometer, unspecified id, user id, vehicle number |
cardholder_prompt_data (anyOf 2) | null | Alternative | |
purchase_type | JSON | Optional | |
purchase_type (anyOf 1) | string | Alternative | The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. Maximum length: 5000 |
purchase_type (anyOf 2) | null | Alternative | |
reported_breakdown | JSON | Optional | |
reported_breakdown (anyOf 1) | JSON | Alternative | More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data. |
reported_breakdown (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax |
reported_breakdown (anyOf 2) | null | Alternative | |
service_type | JSON | Optional | |
service_type (anyOf 1) | string | Alternative | The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`. Maximum length: 5000 |
service_type (anyOf 2) | null | Alternative |
Referenced models: Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type cardholder prompt data value driver id, odometer, unspecified id, user id, vehicle number, Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type cardholder prompt data value driver id, odometer, unspecified id, user id, vehicle number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
driver_id | JSON | Optional | |
driver_id (anyOf 1) | string | Alternative | Driver ID. Maximum length: 5000 |
driver_id (anyOf 2) | null | Alternative | |
odometer | JSON | Optional | |
odometer (anyOf 1) | JSON | Alternative | |
odometer (anyOf 1) (anyOf 1) | integer | Alternative | Odometer reading. |
odometer (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
odometer (anyOf 2) | null | Alternative | |
unspecified_id | JSON | Optional | |
unspecified_id (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
unspecified_id (anyOf 2) | null | Alternative | |
user_id | JSON | Optional | |
user_id (anyOf 1) | string | Alternative | User ID. Maximum length: 5000 |
user_id (anyOf 2) | null | Alternative | |
vehicle_number | JSON | Optional | |
vehicle_number (anyOf 1) | string | Alternative | Vehicle number. Maximum length: 5000 |
vehicle_number (anyOf 2) | null | Alternative |
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax
Referenced models: Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax non fuel Breakdown of non-fuel portion of the purchase gross amount decimal, Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax fuel Breakdown of fuel portion of the purchase gross amount decimal, Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax tax Information about tax included in this transaction local amount decimal, national amount decimal
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax fuel Breakdown of fuel portion of the purchase gross amount decimal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
gross_amount_decimal | JSON | Optional | |
gross_amount_decimal (anyOf 1) | string | Alternative | Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes. Format: decimal |
gross_amount_decimal (anyOf 2) | null | Alternative |
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax tax Information about tax included in this transaction local amount decimal, national amount decimal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
local_amount_decimal | JSON | Optional | |
local_amount_decimal (anyOf 1) | string | Alternative | Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax. Format: decimal |
local_amount_decimal (anyOf 2) | null | Alternative | |
national_amount_decimal | JSON | Optional | |
national_amount_decimal (anyOf 1) | string | Alternative | Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax. Format: decimal |
national_amount_decimal (anyOf 2) | null | Alternative |
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference flight value departure at, passenger name, refundable, segments, travel agency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
departure_at | JSON | Optional | |
departure_at (anyOf 1) | JSON | Alternative | |
departure_at (anyOf 1) (anyOf 1) | integer | Alternative | The time that the flight departed. |
departure_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
departure_at (anyOf 2) | null | Alternative | |
passenger_name | JSON | Optional | |
passenger_name (anyOf 1) | string | Alternative | The name of the passenger. Maximum length: 5000 |
passenger_name (anyOf 2) | null | Alternative | |
refundable | JSON | Optional | |
refundable (anyOf 1) | boolean | Alternative | Whether the ticket is refundable. |
refundable (anyOf 2) | null | Alternative | |
segments | JSON | Optional | |
segments (anyOf 1) | array | Alternative | The legs of the trip. |
segments (anyOf 1)[] | Model | Each item | Expand Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference flight value departure at, passenger name, refundable, segments, travel agency segments The legs of the trip item |
segments (anyOf 2) | null | Alternative | |
travel_agency | JSON | Optional | |
travel_agency (anyOf 1) | string | Alternative | The travel agency that issued the ticket. Maximum length: 5000 |
travel_agency (anyOf 2) | null | Alternative |
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference flight value departure at, passenger name, refundable, segments, travel agency segments The legs of the trip item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
arrival_airport_code | JSON | Optional | |
arrival_airport_code (anyOf 1) | string | Alternative | The three-letter IATA airport code of the flight's destination. Maximum length: 5000 |
arrival_airport_code (anyOf 2) | null | Alternative | |
carrier | JSON | Optional | |
carrier (anyOf 1) | string | Alternative | The airline carrier code. Maximum length: 5000 |
carrier (anyOf 2) | null | Alternative | |
departure_airport_code | JSON | Optional | |
departure_airport_code (anyOf 1) | string | Alternative | The three-letter IATA airport code that the flight departed from. Maximum length: 5000 |
departure_airport_code (anyOf 2) | null | Alternative | |
flight_number | JSON | Optional | |
flight_number (anyOf 1) | string | Alternative | The flight number. Maximum length: 5000 |
flight_number (anyOf 2) | null | Alternative | |
service_class | JSON | Optional | |
service_class (anyOf 1) | string | Alternative | The flight's service class. Maximum length: 5000 |
service_class (anyOf 2) | null | Alternative | |
stopover_allowed | JSON | Optional | |
stopover_allowed (anyOf 1) | boolean | Alternative | Whether a stopover is allowed on this flight. |
stopover_allowed (anyOf 2) | null | Alternative |
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference fuel value industry product code, quantity decimal, type, unit, unit cost decimal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
industry_product_code | JSON | Optional | |
industry_product_code (anyOf 1) | string | Alternative | [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. Maximum length: 5000 |
industry_product_code (anyOf 2) | null | Alternative | |
quantity_decimal | JSON | Optional | |
quantity_decimal (anyOf 1) | string | Alternative | The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. Format: decimal |
quantity_decimal (anyOf 2) | null | Alternative | |
type | string | Required within parent | The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. Maximum length: 5000 |
unit | string | Required within parent | The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`. Maximum length: 5000 |
unit_cost_decimal | string | Required within parent | The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. Format: decimal |
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference lodging value check in at, nights
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
check_in_at | JSON | Optional | |
check_in_at (anyOf 1) | JSON | Alternative | |
check_in_at (anyOf 1) (anyOf 1) | integer | Alternative | The time of checking into the lodging. |
check_in_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
check_in_at (anyOf 2) | null | Alternative | |
nights | JSON | Optional | |
nights (anyOf 1) | JSON | Alternative | |
nights (anyOf 1) (anyOf 1) | integer | Alternative | The number of nights stayed at the lodging. |
nights (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
nights (anyOf 2) | null | Alternative |
Update a transaction — response body — purchase details value fleet, flight, fuel, lodging, receipt, reference receipt The line items in the purchase item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the item. The maximum length of this field is 26 characters. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
quantity | JSON | Optional | |
quantity (anyOf 1) | JSON | Alternative | |
quantity (anyOf 1) (anyOf 1) | number | Alternative | The quantity of the item. |
quantity (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quantity (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The total for this line item in cents. |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
unit_cost | JSON | Optional | |
unit_cost (anyOf 1) | JSON | Alternative | |
unit_cost (anyOf 1) (anyOf 1) | integer | Alternative | The unit cost of the item in cents. |
unit_cost (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_cost (anyOf 2) | null | Alternative |
Update a transaction — response body — treasury value received credit, received debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
received_credit | JSON | Optional | |
received_credit (anyOf 1) | string | Alternative | The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund Maximum length: 5000 |
received_credit (anyOf 2) | null | Alternative | |
received_debit | JSON | Optional | |
received_debit (anyOf 1) | string | Alternative | The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture Maximum length: 5000 |
received_debit (anyOf 2) | null | Alternative |
Update an authorization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_details | JSON | Optional | |
amount_details (anyOf 1) | JSON | Alternative | Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). |
amount_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — amount details value atm fee, cashback amount |
amount_details (anyOf 2) | null | Alternative | |
approved | boolean | Required within parent | Whether the authorization has been approved. |
authorization_method | string | Required within parent | How the card details were provided. Known values: chip, contactless, keyed_in, online, swipe |
balance_transactions | array | Required within parent | List of balance transactions associated with this authorization. |
balance_transactions[] | Model | Each item | Expand Retrieve a balance transaction — balance get Balance History Id — response body |
card | Model | Required within parent | Expand Fail a testmode card — response body |
card_presence | JSON | Optional | |
card_presence (anyOf 1) | string | Alternative | Whether the card was present at the point of sale for the authorization. Known values: not_present, present |
card_presence (anyOf 2) | null | Alternative | |
cardholder | JSON | Optional | |
cardholder (anyOf 1) | JSON | Alternative | The cardholder to whom this authorization belongs. |
cardholder (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
cardholder (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a cardholder — response body |
cardholder (anyOf 2) | null | Alternative | |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this 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). Format: currency |
fleet | JSON | Optional | |
fleet (anyOf 1) | JSON | Alternative | Fleet-specific information for authorizations using Fleet cards. |
fleet (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type |
fleet (anyOf 2) | null | Alternative | |
fraud_challenges | JSON | Optional | |
fraud_challenges (anyOf 1) | array | Alternative | Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. |
fraud_challenges (anyOf 1)[] | Model | Each item | Expand Update an authorization — response body — fraud challenges array item |
fraud_challenges (anyOf 2) | null | Alternative | |
fuel | JSON | Optional | |
fuel (anyOf 1) | JSON | Alternative | Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. |
fuel (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — fuel value industry product code, quantity decimal, type, unit, unit cost decimal |
fuel (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
merchant_amount | JSON | Required within parent | |
merchant_amount (anyOf 1) | integer | Alternative | The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. |
merchant_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
merchant_currency | string | Required within parent | The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this 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). Format: currency |
merchant_data | Model | Required within parent | Expand Update a transaction — response body — merchant data |
metadata | object | Required within parent | 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. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
network_data | JSON | Optional | |
network_data (anyOf 1) | JSON | Alternative | Details about the authorization, such as identifiers, set by the card network. |
network_data (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — network data value acquiring institution id, system trace audit number, transaction id |
network_data (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: issuing.authorization |
pending_request | JSON | Optional | |
pending_request (anyOf 1) | JSON | Alternative | The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. |
pending_request (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — pending request value amount, amount details, currency, is amount controllable, merchant amount, merchant currency, network risk score |
pending_request (anyOf 2) | null | Alternative | |
request_history | array | Required within parent | History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. |
request_history[] | Model | Each item | Expand Update an authorization — response body — request history item |
status | string | Required within parent | The current status of the authorization in its lifecycle. Known values: closed, expired, pending, reversed |
token | JSON | Optional | |
token (anyOf 1) | JSON | Alternative | [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. |
token (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
token (anyOf 1) (anyOf 2) | Model | Alternative | Expand Update a token status — response body |
token (anyOf 2) | null | Alternative | |
transactions | array | Required within parent | List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization. |
transactions[] | Model | Each item | Expand Update a transaction — response body |
treasury | JSON | Optional | |
treasury (anyOf 1) | JSON | Alternative | [Treasury](https://docs.stripe.com/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts). |
treasury (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — treasury value received credits, received debits, transaction |
treasury (anyOf 2) | null | Alternative | |
verification_data | Model | Required within parent | Expand Update an authorization — response body — verification data |
verified_by_fraud_challenge | JSON | Optional | |
verified_by_fraud_challenge (anyOf 1) | boolean | Alternative | Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. |
verified_by_fraud_challenge (anyOf 2) | null | Alternative | |
wallet | JSON | Optional | |
wallet (anyOf 1) | string | Alternative | The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. Maximum length: 5000 |
wallet (anyOf 2) | null | Alternative |
Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Fail a testmode card — response body, Create a cardholder — response body, Update a token status — response body, Update a transaction — response body, Update a transaction — response body — amount details value atm fee, cashback amount, Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type, Update an authorization — response body — fraud challenges array item, Update an authorization — response body — fuel value industry product code, quantity decimal, type, unit, unit cost decimal, Update a transaction — response body — merchant data, Update an authorization — response body — network data value acquiring institution id, system trace audit number, transaction id, Update an authorization — response body — pending request value amount, amount details, currency, is amount controllable, merchant amount, merchant currency, network risk score, Update an authorization — response body — request history item, Update an authorization — response body — treasury value received credits, received debits, transaction, Update an authorization — response body — verification data
Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardholder_prompt_data | JSON | Optional | |
cardholder_prompt_data (anyOf 1) | JSON | Alternative | 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. |
cardholder_prompt_data (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type cardholder prompt data value alphanumeric id, driver id, odometer, unspecified id, user id, vehicle number |
cardholder_prompt_data (anyOf 2) | null | Alternative | |
purchase_type | JSON | Optional | |
purchase_type (anyOf 1) | string | Alternative | The type of purchase. Known values: fuel_and_non_fuel_purchase, fuel_purchase, non_fuel_purchase |
purchase_type (anyOf 2) | null | Alternative | |
reported_breakdown | JSON | Optional | |
reported_breakdown (anyOf 1) | JSON | Alternative | 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. |
reported_breakdown (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax |
reported_breakdown (anyOf 2) | null | Alternative | |
service_type | JSON | Optional | |
service_type (anyOf 1) | string | Alternative | The type of fuel service. Known values: full_service, non_fuel_transaction, self_service |
service_type (anyOf 2) | null | Alternative |
Referenced models: Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type cardholder prompt data value alphanumeric id, driver id, odometer, unspecified id, user id, vehicle number, Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax
Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type cardholder prompt data value alphanumeric id, driver id, odometer, unspecified id, user id, vehicle number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
alphanumeric_id | JSON | Optional | |
alphanumeric_id (anyOf 1) | string | Alternative | [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. Maximum length: 5000 |
alphanumeric_id (anyOf 2) | null | Alternative | |
driver_id | JSON | Optional | |
driver_id (anyOf 1) | string | Alternative | Driver ID. Maximum length: 5000 |
driver_id (anyOf 2) | null | Alternative | |
odometer | JSON | Optional | |
odometer (anyOf 1) | JSON | Alternative | |
odometer (anyOf 1) (anyOf 1) | integer | Alternative | Odometer reading. |
odometer (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
odometer (anyOf 2) | null | Alternative | |
unspecified_id | JSON | Optional | |
unspecified_id (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
unspecified_id (anyOf 2) | null | Alternative | |
user_id | JSON | Optional | |
user_id (anyOf 1) | string | Alternative | User ID. Maximum length: 5000 |
user_id (anyOf 2) | null | Alternative | |
vehicle_number | JSON | Optional | |
vehicle_number (anyOf 1) | string | Alternative | Vehicle number. Maximum length: 5000 |
vehicle_number (anyOf 2) | null | Alternative |
Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax
Referenced models: Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax fuel Breakdown of fuel portion of the purchase gross amount decimal, Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax non fuel Breakdown of non-fuel portion of the purchase gross amount decimal, Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax tax Information about tax included in this transaction local amount decimal, national amount decimal
Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax fuel Breakdown of fuel portion of the purchase gross amount decimal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
gross_amount_decimal | JSON | Optional | |
gross_amount_decimal (anyOf 1) | string | Alternative | Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes. Format: decimal |
gross_amount_decimal (anyOf 2) | null | Alternative |
Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax non fuel Breakdown of non-fuel portion of the purchase gross amount decimal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
gross_amount_decimal | JSON | Optional | |
gross_amount_decimal (anyOf 1) | string | Alternative | Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. Format: decimal |
gross_amount_decimal (anyOf 2) | null | Alternative |
Update an authorization — response body — fleet value cardholder prompt data, purchase type, reported breakdown, service type reported breakdown value fuel, non fuel, tax tax Information about tax included in this transaction local amount decimal, national amount decimal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
local_amount_decimal | JSON | Optional | |
local_amount_decimal (anyOf 1) | string | Alternative | Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax. Format: decimal |
local_amount_decimal (anyOf 2) | null | Alternative | |
national_amount_decimal | JSON | Optional | |
national_amount_decimal (anyOf 1) | string | Alternative | Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax. Format: decimal |
national_amount_decimal (anyOf 2) | null | Alternative |
Update an authorization — response body — fraud challenges array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
channel | string | Required within parent | The method by which the fraud challenge was delivered to the cardholder. Known values: sms |
status | string | Required within parent | The status of the fraud challenge. Known values: expired, pending, rejected, undeliverable, verified |
undeliverable_reason | JSON | Optional | |
undeliverable_reason (anyOf 1) | string | Alternative | If the challenge is not deliverable, the reason why. Known values: no_phone_number, unsupported_phone_number |
undeliverable_reason (anyOf 2) | null | Alternative |
Update an authorization — response body — fuel value industry product code, quantity decimal, type, unit, unit cost decimal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
industry_product_code | JSON | Optional | |
industry_product_code (anyOf 1) | string | Alternative | [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. Maximum length: 5000 |
industry_product_code (anyOf 2) | null | Alternative | |
quantity_decimal | JSON | Optional | |
quantity_decimal (anyOf 1) | string | Alternative | The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. Format: decimal |
quantity_decimal (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of fuel that was purchased. Known values: diesel, other, unleaded_plus, unleaded_regular, unleaded_super |
type (anyOf 2) | null | Alternative | |
unit | JSON | Optional | |
unit (anyOf 1) | string | Alternative | The units for `quantity_decimal`. Known values: charging_minute, imperial_gallon, kilogram, kilowatt_hour, liter, other, pound, us_gallon |
unit (anyOf 2) | null | Alternative | |
unit_cost_decimal | JSON | Optional | |
unit_cost_decimal (anyOf 1) | string | Alternative | The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. Format: decimal |
unit_cost_decimal (anyOf 2) | null | Alternative |
Update an authorization — response body — network data value acquiring institution id, system trace audit number, transaction id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
acquiring_institution_id | JSON | Optional | |
acquiring_institution_id (anyOf 1) | string | Alternative | 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`. Maximum length: 5000 |
acquiring_institution_id (anyOf 2) | null | Alternative | |
system_trace_audit_number | JSON | Optional | |
system_trace_audit_number (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
system_trace_audit_number (anyOf 2) | null | Alternative | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
Update an authorization — response body — pending request value amount, amount details, currency, is amount controllable, merchant amount, merchant currency, network risk score
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | 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). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_details | JSON | Optional | |
amount_details (anyOf 1) | JSON | Alternative | Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). |
amount_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — amount details value atm fee, cashback amount |
amount_details (anyOf 2) | null | Alternative | |
currency | string | Required within parent | 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). Format: currency |
is_amount_controllable | boolean | Required within parent | 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. |
merchant_amount | JSON | Required within parent | |
merchant_amount (anyOf 1) | integer | Alternative | 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_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
merchant_currency | string | Required within parent | The local currency the merchant is requesting to authorize. Format: currency |
network_risk_score | JSON | Optional | |
network_risk_score (anyOf 1) | JSON | Alternative | |
network_risk_score (anyOf 1) (anyOf 1) | integer | Alternative | The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. |
network_risk_score (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
network_risk_score (anyOf 2) | null | Alternative |
Referenced models: Update a transaction — response body — amount details value atm fee, cashback amount
Update an authorization — response body — request history item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | 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. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_details | JSON | Optional | |
amount_details (anyOf 1) | JSON | Alternative | Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). |
amount_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update a transaction — response body — amount details value atm fee, cashback amount |
amount_details (anyOf 2) | null | Alternative | |
approved | boolean | Required within parent | Whether this request was approved. |
authorization_code | JSON | Optional | |
authorization_code (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
authorization_code (anyOf 2) | null | Alternative | |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | 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). Maximum length: 5000 |
merchant_amount | JSON | Required within parent | |
merchant_amount (anyOf 1) | integer | Alternative | 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_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
merchant_currency | string | Required within parent | 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). Maximum length: 5000 |
network_risk_score | JSON | Optional | |
network_risk_score (anyOf 1) | JSON | Alternative | |
network_risk_score (anyOf 1) (anyOf 1) | integer | Alternative | The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. |
network_risk_score (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
network_risk_score (anyOf 2) | null | Alternative | |
reason | string | Required within parent | When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome. Known values: 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, stripe_internal_error, suspected_fraud, verification_failed, webhook_approved, webhook_declined, webhook_error, webhook_timeout |
reason_message | JSON | Optional | |
reason_message (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
reason_message (anyOf 2) | null | Alternative | |
requested_at | JSON | Optional | |
requested_at (anyOf 1) | JSON | Alternative | |
requested_at (anyOf 1) (anyOf 1) | integer | Alternative | Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time. Format: unix-time |
requested_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requested_at (anyOf 2) | null | Alternative |
Referenced models: Update a transaction — response body — amount details value atm fee, cashback amount
Update an authorization — response body — treasury value received credits, received debits, transaction
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
received_credits | array | Required within parent | The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization |
received_credits[] | string | Each item | Maximum length: 5000 |
received_debits | array | Required within parent | The array of [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization |
received_debits[] | string | Each item | Maximum length: 5000 |
transaction | JSON | Optional | |
transaction (anyOf 1) | string | Alternative | The Treasury [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization Maximum length: 5000 |
transaction (anyOf 2) | null | Alternative |
Update an authorization — response body — verification data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line1_check | string | Required within parent | Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. Known values: match, mismatch, not_provided |
address_postal_code_check | string | Required within parent | Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. Known values: match, mismatch, not_provided |
authentication_exemption | JSON | Optional | |
authentication_exemption (anyOf 1) | JSON | Alternative | The exemption applied to this authorization. |
authentication_exemption (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — verification_data / authentication_exemption / The exemption applied to this authorization / claimed_by: acquirer, issuer, type: low value transaction, transaction risk analysis, unknown |
authentication_exemption (anyOf 2) | null | Alternative | |
cvc_check | string | Required within parent | Whether the cardholder provided a CVC and if it matched Stripe’s record. Known values: match, mismatch, not_provided |
expiry_check | string | Required within parent | Whether the cardholder provided an expiry date and if it matched Stripe’s record. Known values: match, mismatch, not_provided |
postal_code | JSON | Optional | |
postal_code (anyOf 1) | string | Alternative | The postal code submitted as part of the authorization used for postal code verification. Maximum length: 5000 |
postal_code (anyOf 2) | null | Alternative | |
three_d_secure | JSON | Optional | |
three_d_secure (anyOf 1) | JSON | Alternative | 3D Secure details. |
three_d_secure (anyOf 1) (anyOf 1) | Model | Alternative | Expand Update an authorization — response body — verification_data / three_d_secure / 3D Secure details / result: attempt acknowledged, authenticated, failed, required |
three_d_secure (anyOf 2) | null | Alternative |
Referenced models: Update an authorization — response body — verification_data / authentication_exemption / The exemption applied to this authorization / claimed_by: acquirer, issuer, type: low value transaction, transaction risk analysis, unknown, Update an authorization — response body — verification_data / three_d_secure / 3D Secure details / result: attempt acknowledged, authenticated, failed, required
Update an authorization — response body — verification_data / authentication_exemption / The exemption applied to this authorization / claimed_by: acquirer, issuer, type: low value transaction, transaction risk analysis, unknown
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
claimed_by | string | Required within parent | The entity that requested the exemption, either the acquiring merchant or the Issuing user. Known values: acquirer, issuer |
type | string | Required within parent | The specific exemption claimed for this authorization. Known values: low_value_transaction, transaction_risk_analysis, unknown |
Update an authorization — response body — verification_data / three_d_secure / 3D Secure details / result: attempt acknowledged, authenticated, failed, required
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
result | string | Required within parent | The outcome of the 3D Secure authentication request. Known values: attempt_acknowledged, authenticated, failed, required |