Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", + "parameters": [ + { + "in": "path", + "name": "authorization", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "final_amount": { + "description": "The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "type": "integer" + }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "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", + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + } + }, + "required": [ + "final_amount" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.authorization" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { "post": { "description": "Increment a test-mode Authorization.
", @@ -196917,6 +197941,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "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", + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -196985,6 +198115,11 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -197506,6 +198641,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "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", + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -197574,6 +198815,11 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml index ee2ffe4f..e847784f 100644 --- a/openapi/spec3.beta.sdk.yaml +++ b/openapi/spec3.beta.sdk.yaml @@ -21967,6 +21967,19 @@ components: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string + fleet: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_data' + description: Fleet-specific information for authorizations using Fleet cards. + nullable: true + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fuel_data' + description: >- + 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. + nullable: true id: description: Unique identifier for the object. maxLength: 5000 @@ -22094,6 +22107,8 @@ components: - cardholder - created - currency + - fleet + - fuel - id - livemode - merchant_amount @@ -22115,6 +22130,8 @@ components: - balance_transactions - card - cardholder + - fleet + - fuel - merchant_data - network_data - pending_request @@ -22165,6 +22182,12 @@ components: method_type: custom operation: post path: '/v1/test_helpers/issuing/authorizations/{authorization}/expire' + - method_name: finalize_amount + method_on: service + method_type: custom + operation: post + path: >- + /v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount - method_name: increment method_on: service method_type: custom @@ -23576,6 +23599,241 @@ components: title: IssuingAuthorizationAuthenticationExemption type: object x-expandableFields: [] + issuing_authorization_fleet_cardholder_prompt_data: + description: '' + properties: + alphanumeric_id: + 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. + maxLength: 5000 + nullable: true + type: string + driver_id: + description: Driver ID. + maxLength: 5000 + nullable: true + type: string + odometer: + description: Odometer reading. + nullable: true + type: integer + unspecified_id: + 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. + maxLength: 5000 + nullable: true + type: string + user_id: + description: User ID. + maxLength: 5000 + nullable: true + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + nullable: true + type: string + required: + - alphanumeric_id + - driver_id + - odometer + - unspecified_id + - user_id + - vehicle_number + title: IssuingAuthorizationFleetCardholderPromptData + type: object + x-expandableFields: [] + issuing_authorization_fleet_data: + description: '' + properties: + cardholder_prompt_data: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_cardholder_prompt_data + 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. + nullable: true + purchase_type: + description: The type of purchase. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + nullable: true + type: string + reported_breakdown: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_reported_breakdown + 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. + nullable: true + service_type: + description: The type of fuel service. + enum: + - full_service + - non_fuel_transaction + - self_service + nullable: true + type: string + required: + - cardholder_prompt_data + - purchase_type + - reported_breakdown + - service_type + title: IssuingAuthorizationFleetData + type: object + x-expandableFields: + - cardholder_prompt_data + - reported_breakdown + issuing_authorization_fleet_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Quantity multiplied by Fuel + Unit Cost, inclusive of taxes. + format: decimal + nullable: true + type: string + required: + - gross_amount_decimal + title: IssuingAuthorizationFleetFuelPriceData + type: object + x-expandableFields: [] + issuing_authorization_fleet_non_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum of the line items, + inclusive of taxes. + format: decimal + nullable: true + type: string + required: + - gross_amount_decimal + title: IssuingAuthorizationFleetNonFuelPriceData + type: object + x-expandableFields: [] + issuing_authorization_fleet_reported_breakdown: + description: '' + properties: + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_fuel_price_data' + description: Breakdown of fuel portion of the purchase. + nullable: true + non_fuel: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_non_fuel_price_data + description: Breakdown of non-fuel portion of the purchase. + nullable: true + tax: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_tax_data' + description: Information about tax included in this transaction. + nullable: true + required: + - fuel + - non_fuel + - tax + title: IssuingAuthorizationFleetReportedBreakdown + type: object + x-expandableFields: + - fuel + - non_fuel + - tax + issuing_authorization_fleet_tax_data: + description: '' + properties: + local_amount_decimal: + description: >- + 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 + nullable: true + type: string + national_amount_decimal: + description: >- + 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 + nullable: true + type: string + required: + - local_amount_decimal + - national_amount_decimal + title: IssuingAuthorizationFleetTaxData + type: object + x-expandableFields: [] + issuing_authorization_fuel_data: + description: '' + properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + nullable: true + type: string + quantity_decimal: + description: >- + The quantity of `unit`s of fuel that was dispensed, represented as a + decimal string with at most 12 decimal places. + format: decimal + nullable: true + type: string + type: + description: The type of fuel that was purchased. + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + nullable: true + type: string + unit: + description: The units for `quantity_decimal`. + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + nullable: true + type: string + unit_cost_decimal: + description: >- + The cost in cents per each unit of fuel, represented as a decimal + string with at most 12 decimal places. + format: decimal + nullable: true + type: string + required: + - industry_product_code + - quantity_decimal + - type + - unit + - unit_cost_decimal + title: IssuingAuthorizationFuelData + type: object + x-expandableFields: [] issuing_authorization_merchant_data: description: '' properties: @@ -23814,11 +24072,16 @@ components: enum: - account_disabled - card_active + - card_canceled + - card_expired - card_inactive + - cardholder_blocked - cardholder_inactive - cardholder_verification_required + - insecure_authorization_method - insufficient_funds - not_allowed + - pin_blocked - spending_controls - suspected_fraud - verification_failed @@ -27964,6 +28227,169 @@ components: title: IssuingTransactionAmountDetails type: object x-expandableFields: [] + issuing_transaction_fleet_cardholder_prompt_data: + description: '' + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + nullable: true + type: string + odometer: + description: Odometer reading. + nullable: true + type: integer + unspecified_id: + 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. + maxLength: 5000 + nullable: true + type: string + user_id: + description: User ID. + maxLength: 5000 + nullable: true + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + nullable: true + type: string + required: + - driver_id + - odometer + - unspecified_id + - user_id + - vehicle_number + title: IssuingTransactionFleetCardholderPromptData + type: object + x-expandableFields: [] + issuing_transaction_fleet_data: + description: '' + properties: + cardholder_prompt_data: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_cardholder_prompt_data + description: Answers to prompts presented to cardholder at point of sale. + nullable: true + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, + or `fuel_and_non_fuel_purchase`. + maxLength: 5000 + nullable: true + type: string + reported_breakdown: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_reported_breakdown + description: >- + More information about the total amount. This information is not + guaranteed to be accurate as some merchants may provide unreliable + data. + nullable: true + service_type: + description: >- + The type of fuel service. One of `non_fuel_transaction`, + `full_service`, or `self_service`. + maxLength: 5000 + nullable: true + type: string + required: + - cardholder_prompt_data + - purchase_type + - reported_breakdown + - service_type + title: IssuingTransactionFleetData + type: object + x-expandableFields: + - cardholder_prompt_data + - reported_breakdown + issuing_transaction_fleet_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Volume multipled by Fuel + Unit Cost, inclusive of taxes. + format: decimal + nullable: true + type: string + required: + - gross_amount_decimal + title: IssuingTransactionFleetFuelPriceData + type: object + x-expandableFields: [] + issuing_transaction_fleet_non_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum of the line items, + inclusive of taxes. + format: decimal + nullable: true + type: string + required: + - gross_amount_decimal + title: IssuingTransactionFleetNonFuelPriceData + type: object + x-expandableFields: [] + issuing_transaction_fleet_reported_breakdown: + description: '' + properties: + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_fuel_price_data' + description: Breakdown of fuel portion of the purchase. + nullable: true + non_fuel: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_non_fuel_price_data + description: Breakdown of non-fuel portion of the purchase. + nullable: true + tax: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_tax_data' + description: Information about tax included in this transaction. + nullable: true + required: + - fuel + - non_fuel + - tax + title: IssuingTransactionFleetReportedBreakdown + type: object + x-expandableFields: + - fuel + - non_fuel + - tax + issuing_transaction_fleet_tax_data: + description: '' + properties: + local_amount_decimal: + description: >- + 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 + nullable: true + type: string + national_amount_decimal: + description: >- + 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 + nullable: true + type: string + required: + - local_amount_decimal + - national_amount_decimal + title: IssuingTransactionFleetTaxData + type: object + x-expandableFields: [] issuing_transaction_flight_data: description: '' properties: @@ -28046,6 +28472,14 @@ components: issuing_transaction_fuel_data: description: '' properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + nullable: true + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, represented as a @@ -28073,6 +28507,7 @@ components: format: decimal type: string required: + - industry_product_code - quantity_decimal - type - unit @@ -28137,6 +28572,11 @@ components: issuing_transaction_purchase_details: description: '' properties: + fleet: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_data' + description: Fleet-specific information for transactions using Fleet cards. + nullable: true flight: anyOf: - $ref: '#/components/schemas/issuing_transaction_flight_data' @@ -28166,6 +28606,7 @@ components: nullable: true type: string required: + - fleet - flight - fuel - lodging @@ -28174,6 +28615,7 @@ components: title: IssuingTransactionPurchaseDetails type: object x-expandableFields: + - fleet - flight - fuel - lodging @@ -184284,6 +184726,12 @@ paths: expand: explode: true style: deepObject + fleet: + explode: true + style: deepObject + fuel: + explode: true + style: deepObject merchant_data: explode: true style: deepObject @@ -184344,6 +184792,171 @@ paths: maxLength: 5000 type: string type: array + fleet: + description: >- + Fleet-specific information for authorizations using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Volume + multipled by Fuel Unit Cost, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum + of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: Information about tax included in this transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of `non_fuel_transaction`, + `full_service`, or `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object + fuel: + description: >- + Information about fuel that was purchased with this + transaction. + properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string + quantity_decimal: + description: >- + The quantity of `unit`s of fuel that was dispensed, + represented as a decimal string with at most 12 decimal + places. + format: decimal + type: string + type: + description: >- + The type of fuel that was purchased. One of `diesel`, + `unleaded_plus`, `unleaded_regular`, `unleaded_super`, + or `other`. + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + maxLength: 5000 + type: string + unit: + description: >- + The units for `quantity_decimal`. One of + `charging_minute`, `imperial_gallon`, `kilogram`, + `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or + `other`. + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + maxLength: 5000 + type: string + unit_cost_decimal: + description: >- + The cost in cents per each unit of fuel, represented as + a decimal string with at most 12 decimal places. + format: decimal + type: string + title: fuel_specs + type: object is_amount_controllable: description: >- If set `true`, you may provide @@ -184878,6 +185491,120 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + description: >- + Fleet-specific information for transactions using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or + `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel + Volume multipled by Fuel Unit Cost, + inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the + sum of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: >- + Information about tax included in this + transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of + `non_fuel_transaction`, `full_service`, or + `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: description: >- Information about the flight that was purchased with @@ -184939,6 +185666,13 @@ paths: Information about fuel that was purchased with this transaction. properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, @@ -185079,6 +185813,231 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount': + post: + description: >- +Finalize the amount on an Authorization prior to capture, when the + initial authorization was for an estimated amount.
+ operationId: PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount + parameters: + - in: path + name: authorization + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + fleet: + explode: true + style: deepObject + fuel: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + final_amount: + description: >- + The final authorization amount that will be captured by the + merchant. This amount is in the authorization currency and + in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + fleet: + description: >- + Fleet-specific information for authorizations using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Volume + multipled by Fuel Unit Cost, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum + of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: Information about tax included in this transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of `non_fuel_transaction`, + `full_service`, or `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object + fuel: + description: >- + Information about fuel that was purchased with this + transaction. + properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string + quantity_decimal: + description: >- + The quantity of `unit`s of fuel that was dispensed, + represented as a decimal string with at most 12 decimal + places. + format: decimal + type: string + type: + description: >- + The type of fuel that was purchased. One of `diesel`, + `unleaded_plus`, `unleaded_regular`, `unleaded_super`, + or `other`. + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + maxLength: 5000 + type: string + unit: + description: >- + The units for `quantity_decimal`. One of + `charging_minute`, `imperial_gallon`, `kilogram`, + `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or + `other`. + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + maxLength: 5000 + type: string + unit_cost_decimal: + description: >- + The cost in cents per each unit of fuel, represented as + a decimal string with at most 12 decimal places. + format: decimal + type: string + title: fuel_specs + type: object + required: + - final_amount + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.authorization' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/test_helpers/issuing/authorizations/{authorization}/increment': post: description:Increment a test-mode Authorization.
@@ -185947,6 +186906,120 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + description: >- + Fleet-specific information for transactions using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or + `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel + Volume multipled by Fuel Unit Cost, + inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the + sum of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: >- + Information about tax included in this + transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of + `non_fuel_transaction`, `full_service`, or + `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: description: >- Information about the flight that was purchased with @@ -186008,6 +187081,13 @@ paths: Information about fuel that was purchased with this transaction. properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, @@ -186515,6 +187595,120 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + description: >- + Fleet-specific information for transactions using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or + `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel + Volume multipled by Fuel Unit Cost, + inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the + sum of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: >- + Information about tax included in this + transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of + `non_fuel_transaction`, `full_service`, or + `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: description: >- Information about the flight that was purchased with @@ -186576,6 +187770,13 @@ paths: Information about fuel that was purchased with this transaction. properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, diff --git a/openapi/spec3.json b/openapi/spec3.json index 70da8a72..e904b206 100644 --- a/openapi/spec3.json +++ b/openapi/spec3.json @@ -16608,6 +16608,24 @@ "description": "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).", "type": "string" }, + "fleet": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_data" + } + ], + "description": "Fleet-specific information for authorizations using Fleet cards.", + "nullable": true + }, + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fuel_data" + } + ], + "description": "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.", + "nullable": true + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -16750,6 +16768,8 @@ "balance_transactions", "card", "cardholder", + "fleet", + "fuel", "merchant_data", "network_data", "pending_request", @@ -17975,6 +17995,238 @@ "type": "object", "x-expandableFields": [] }, + "issuing_authorization_fleet_cardholder_prompt_data": { + "description": "", + "properties": { + "alphanumeric_id": { + "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "nullable": true, + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "IssuingAuthorizationFleetCardholderPromptData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_data": { + "description": "", + "properties": { + "cardholder_prompt_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data" + } + ], + "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.", + "nullable": true + }, + "purchase_type": { + "description": "The type of purchase.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "nullable": true, + "type": "string" + }, + "reported_breakdown": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown" + } + ], + "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.", + "nullable": true + }, + "service_type": { + "description": "The type of fuel service.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "nullable": true, + "type": "string" + } + }, + "title": "IssuingAuthorizationFleetData", + "type": "object", + "x-expandableFields": [ + "cardholder_prompt_data", + "reported_breakdown" + ] + }, + "issuing_authorization_fleet_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "title": "IssuingAuthorizationFleetFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_non_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "title": "IssuingAuthorizationFleetNonFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_reported_breakdown": { + "description": "", + "properties": { + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data" + } + ], + "description": "Breakdown of fuel portion of the purchase.", + "nullable": true + }, + "non_fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data" + } + ], + "description": "Breakdown of non-fuel portion of the purchase.", + "nullable": true + }, + "tax": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_tax_data" + } + ], + "description": "Information about tax included in this transaction.", + "nullable": true + } + }, + "title": "IssuingAuthorizationFleetReportedBreakdown", + "type": "object", + "x-expandableFields": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "issuing_authorization_fleet_tax_data": { + "description": "", + "properties": { + "local_amount_decimal": { + "description": "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", + "nullable": true, + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "nullable": true, + "type": "string" + } + }, + "title": "IssuingAuthorizationFleetTaxData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fuel_data": { + "description": "", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "nullable": true, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "nullable": true, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "title": "IssuingAuthorizationFuelData", + "type": "object", + "x-expandableFields": [] + }, "issuing_authorization_merchant_data": { "description": "", "properties": { @@ -18177,11 +18429,16 @@ "enum": [ "account_disabled", "card_active", + "card_canceled", + "card_expired", "card_inactive", + "cardholder_blocked", "cardholder_inactive", "cardholder_verification_required", + "insecure_authorization_method", "insufficient_funds", "not_allowed", + "pin_blocked", "spending_controls", "suspected_fraud", "verification_failed", @@ -21764,6 +22021,171 @@ "type": "object", "x-expandableFields": [] }, + "issuing_transaction_fleet_cardholder_prompt_data": { + "description": "", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "nullable": true, + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "IssuingTransactionFleetCardholderPromptData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_data": { + "description": "", + "properties": { + "cardholder_prompt_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data" + } + ], + "description": "Answers to prompts presented to cardholder at point of sale.", + "nullable": true + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "reported_breakdown": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown" + } + ], + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "nullable": true + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "title": "IssuingTransactionFleetData", + "type": "object", + "x-expandableFields": [ + "cardholder_prompt_data", + "reported_breakdown" + ] + }, + "issuing_transaction_fleet_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "title": "IssuingTransactionFleetFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_non_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "title": "IssuingTransactionFleetNonFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_reported_breakdown": { + "description": "", + "properties": { + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data" + } + ], + "description": "Breakdown of fuel portion of the purchase.", + "nullable": true + }, + "non_fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data" + } + ], + "description": "Breakdown of non-fuel portion of the purchase.", + "nullable": true + }, + "tax": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_tax_data" + } + ], + "description": "Information about tax included in this transaction.", + "nullable": true + } + }, + "title": "IssuingTransactionFleetReportedBreakdown", + "type": "object", + "x-expandableFields": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "issuing_transaction_fleet_tax_data": { + "description": "", + "properties": { + "local_amount_decimal": { + "description": "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", + "nullable": true, + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "nullable": true, + "type": "string" + } + }, + "title": "IssuingTransactionFleetTaxData", + "type": "object", + "x-expandableFields": [] + }, "issuing_transaction_flight_data": { "description": "", "properties": { @@ -21850,6 +22272,12 @@ "issuing_transaction_fuel_data": { "description": "", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -21928,6 +22356,15 @@ "issuing_transaction_purchase_details": { "description": "", "properties": { + "fleet": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_data" + } + ], + "description": "Fleet-specific information for transactions using Fleet cards.", + "nullable": true + }, "flight": { "anyOf": [ { @@ -21973,6 +22410,7 @@ "title": "IssuingTransactionPurchaseDetails", "type": "object", "x-expandableFields": [ + "fleet", "flight", "fuel", "lodging", @@ -148601,6 +149039,14 @@ "explode": true, "style": "deepObject" }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + }, "merchant_data": { "explode": true, "style": "deepObject" @@ -148662,6 +149108,140 @@ }, "type": "array" }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "properties": { + "driver_id": { + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "type": "integer" + }, + "unspecified_id": { + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "properties": { + "fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "properties": { + "local_amount_decimal": { + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "format": "decimal", + "type": "string" + }, + "type": { + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" @@ -149195,6 +149775,95 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "properties": { + "cardholder_prompt_data": { + "properties": { + "driver_id": { + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "type": "integer" + }, + "unspecified_id": { + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "properties": { + "fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "properties": { + "local_amount_decimal": { + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "properties": { "departure_at": { @@ -149250,6 +149919,10 @@ }, "fuel": { "properties": { + "industry_product_code": { + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "format": "decimal", "type": "string" @@ -149429,6 +150102,222 @@ } } }, + "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": { + "post": { + "description": "Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", + "parameters": [ + { + "in": "path", + "name": "authorization", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "final_amount": { + "description": "The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "type": "integer" + }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "properties": { + "driver_id": { + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "type": "integer" + }, + "unspecified_id": { + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "properties": { + "fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "properties": { + "local_amount_decimal": { + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "format": "decimal", + "type": "string" + }, + "type": { + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + } + }, + "required": [ + "final_amount" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.authorization" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { "post": { "description": "Increment a test-mode Authorization.
", @@ -150479,6 +151368,95 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "properties": { + "cardholder_prompt_data": { + "properties": { + "driver_id": { + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "type": "integer" + }, + "unspecified_id": { + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "properties": { + "fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "properties": { + "local_amount_decimal": { + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "properties": { "departure_at": { @@ -150534,6 +151512,10 @@ }, "fuel": { "properties": { + "industry_product_code": { + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "format": "decimal", "type": "string" @@ -151037,6 +152019,95 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "properties": { + "cardholder_prompt_data": { + "properties": { + "driver_id": { + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "type": "integer" + }, + "unspecified_id": { + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "properties": { + "fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "properties": { + "gross_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "properties": { + "local_amount_decimal": { + "format": "decimal", + "type": "string" + }, + "national_amount_decimal": { + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "properties": { "departure_at": { @@ -151092,6 +152163,10 @@ }, "fuel": { "properties": { + "industry_product_code": { + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "format": "decimal", "type": "string" diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json index a20141fd..d511306b 100644 --- a/openapi/spec3.sdk.json +++ b/openapi/spec3.sdk.json @@ -21314,6 +21314,24 @@ "description": "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).", "type": "string" }, + "fleet": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_data" + } + ], + "description": "Fleet-specific information for authorizations using Fleet cards.", + "nullable": true + }, + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fuel_data" + } + ], + "description": "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.", + "nullable": true + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -21439,6 +21457,8 @@ "cardholder", "created", "currency", + "fleet", + "fuel", "id", "livemode", "merchant_amount", @@ -21461,6 +21481,8 @@ "balance_transactions", "card", "cardholder", + "fleet", + "fuel", "merchant_data", "network_data", "pending_request", @@ -21528,6 +21550,13 @@ "operation": "post", "path": "/v1/test_helpers/issuing/authorizations/{authorization}/expire" }, + { + "method_name": "finalize_amount", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount" + }, { "method_name": "increment", "method_on": "service", @@ -23037,6 +23066,274 @@ "type": "object", "x-expandableFields": [] }, + "issuing_authorization_fleet_cardholder_prompt_data": { + "description": "", + "properties": { + "alphanumeric_id": { + "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "nullable": true, + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "alphanumeric_id", + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ], + "title": "IssuingAuthorizationFleetCardholderPromptData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_data": { + "description": "", + "properties": { + "cardholder_prompt_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data" + } + ], + "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.", + "nullable": true + }, + "purchase_type": { + "description": "The type of purchase.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "nullable": true, + "type": "string" + }, + "reported_breakdown": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown" + } + ], + "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.", + "nullable": true + }, + "service_type": { + "description": "The type of fuel service.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "nullable": true, + "type": "string" + } + }, + "required": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ], + "title": "IssuingAuthorizationFleetData", + "type": "object", + "x-expandableFields": [ + "cardholder_prompt_data", + "reported_breakdown" + ] + }, + "issuing_authorization_fleet_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingAuthorizationFleetFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_non_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingAuthorizationFleetNonFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fleet_reported_breakdown": { + "description": "", + "properties": { + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data" + } + ], + "description": "Breakdown of fuel portion of the purchase.", + "nullable": true + }, + "non_fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data" + } + ], + "description": "Breakdown of non-fuel portion of the purchase.", + "nullable": true + }, + "tax": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_authorization_fleet_tax_data" + } + ], + "description": "Information about tax included in this transaction.", + "nullable": true + } + }, + "required": [ + "fuel", + "non_fuel", + "tax" + ], + "title": "IssuingAuthorizationFleetReportedBreakdown", + "type": "object", + "x-expandableFields": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "issuing_authorization_fleet_tax_data": { + "description": "", + "properties": { + "local_amount_decimal": { + "description": "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", + "nullable": true, + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "nullable": true, + "type": "string" + } + }, + "required": [ + "local_amount_decimal", + "national_amount_decimal" + ], + "title": "IssuingAuthorizationFleetTaxData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_authorization_fuel_data": { + "description": "", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "nullable": true, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "nullable": true, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "industry_product_code", + "quantity_decimal", + "type", + "unit", + "unit_cost_decimal" + ], + "title": "IssuingAuthorizationFuelData", + "type": "object", + "x-expandableFields": [] + }, "issuing_authorization_merchant_data": { "description": "", "properties": { @@ -23253,11 +23550,16 @@ "enum": [ "account_disabled", "card_active", + "card_canceled", + "card_expired", "card_inactive", + "cardholder_blocked", "cardholder_inactive", "cardholder_verification_required", + "insecure_authorization_method", "insufficient_funds", "not_allowed", + "pin_blocked", "spending_controls", "suspected_fraud", "verification_failed", @@ -27255,6 +27557,199 @@ "type": "object", "x-expandableFields": [] }, + "issuing_transaction_fleet_cardholder_prompt_data": { + "description": "", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "nullable": true, + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "driver_id", + "odometer", + "unspecified_id", + "user_id", + "vehicle_number" + ], + "title": "IssuingTransactionFleetCardholderPromptData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_data": { + "description": "", + "properties": { + "cardholder_prompt_data": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data" + } + ], + "description": "Answers to prompts presented to cardholder at point of sale.", + "nullable": true + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "reported_breakdown": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown" + } + ], + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "nullable": true + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "cardholder_prompt_data", + "purchase_type", + "reported_breakdown", + "service_type" + ], + "title": "IssuingTransactionFleetData", + "type": "object", + "x-expandableFields": [ + "cardholder_prompt_data", + "reported_breakdown" + ] + }, + "issuing_transaction_fleet_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingTransactionFleetFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_non_fuel_price_data": { + "description": "", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "nullable": true, + "type": "string" + } + }, + "required": [ + "gross_amount_decimal" + ], + "title": "IssuingTransactionFleetNonFuelPriceData", + "type": "object", + "x-expandableFields": [] + }, + "issuing_transaction_fleet_reported_breakdown": { + "description": "", + "properties": { + "fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data" + } + ], + "description": "Breakdown of fuel portion of the purchase.", + "nullable": true + }, + "non_fuel": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data" + } + ], + "description": "Breakdown of non-fuel portion of the purchase.", + "nullable": true + }, + "tax": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_tax_data" + } + ], + "description": "Information about tax included in this transaction.", + "nullable": true + } + }, + "required": [ + "fuel", + "non_fuel", + "tax" + ], + "title": "IssuingTransactionFleetReportedBreakdown", + "type": "object", + "x-expandableFields": [ + "fuel", + "non_fuel", + "tax" + ] + }, + "issuing_transaction_fleet_tax_data": { + "description": "", + "properties": { + "local_amount_decimal": { + "description": "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", + "nullable": true, + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "nullable": true, + "type": "string" + } + }, + "required": [ + "local_amount_decimal", + "national_amount_decimal" + ], + "title": "IssuingTransactionFleetTaxData", + "type": "object", + "x-expandableFields": [] + }, "issuing_transaction_flight_data": { "description": "", "properties": { @@ -27356,6 +27851,12 @@ "issuing_transaction_fuel_data": { "description": "", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -27379,6 +27880,7 @@ } }, "required": [ + "industry_product_code", "quantity_decimal", "type", "unit", @@ -27444,6 +27946,15 @@ "issuing_transaction_purchase_details": { "description": "", "properties": { + "fleet": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_transaction_fleet_data" + } + ], + "description": "Fleet-specific information for transactions using Fleet cards.", + "nullable": true + }, "flight": { "anyOf": [ { @@ -27487,6 +27998,7 @@ } }, "required": [ + "fleet", "flight", "fuel", "lodging", @@ -27496,6 +28008,7 @@ "title": "IssuingTransactionPurchaseDetails", "type": "object", "x-expandableFields": [ + "fleet", "flight", "fuel", "lodging", @@ -156840,6 +157353,14 @@ "explode": true, "style": "deepObject" }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + }, "merchant_data": { "explode": true, "style": "deepObject" @@ -156903,6 +157424,161 @@ }, "type": "array" }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "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", + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + }, "is_amount_controllable": { "description": "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.", "type": "boolean" @@ -157455,6 +158131,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "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", + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -157523,6 +158305,11 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -157711,6 +158498,243 @@ } } }, + "/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount": { + "post": { + "description": "Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
", + "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount", + "parameters": [ + { + "in": "path", + "name": "authorization", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "fleet": { + "explode": true, + "style": "deepObject" + }, + "fuel": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "final_amount": { + "description": "The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "type": "integer" + }, + "fleet": { + "description": "Fleet-specific information for authorizations using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "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", + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, + "fuel": { + "description": "Information about fuel that was purchased with this transaction.", + "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, + "quantity_decimal": { + "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + }, + "type": { + "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", + "enum": [ + "diesel", + "other", + "unleaded_plus", + "unleaded_regular", + "unleaded_super" + ], + "maxLength": 5000, + "type": "string" + }, + "unit": { + "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.", + "enum": [ + "charging_minute", + "imperial_gallon", + "kilogram", + "kilowatt_hour", + "liter", + "other", + "pound", + "us_gallon" + ], + "maxLength": 5000, + "type": "string" + }, + "unit_cost_decimal": { + "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.", + "format": "decimal", + "type": "string" + } + }, + "title": "fuel_specs", + "type": "object" + } + }, + "required": [ + "final_amount" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.authorization" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/test_helpers/issuing/authorizations/{authorization}/increment": { "post": { "description": "Increment a test-mode Authorization.
", @@ -158772,6 +159796,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "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", + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -158840,6 +159970,11 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", @@ -159361,6 +160496,112 @@ "purchase_details": { "description": "Additional purchase information that is optionally provided by the merchant.", "properties": { + "fleet": { + "description": "Fleet-specific information for transactions using Fleet cards.", + "properties": { + "cardholder_prompt_data": { + "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.", + "properties": { + "driver_id": { + "description": "Driver ID.", + "maxLength": 5000, + "type": "string" + }, + "odometer": { + "description": "Odometer reading.", + "type": "integer" + }, + "unspecified_id": { + "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.", + "maxLength": 5000, + "type": "string" + }, + "user_id": { + "description": "User ID.", + "maxLength": 5000, + "type": "string" + }, + "vehicle_number": { + "description": "Vehicle number.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_cardholder_prompt_data_specs", + "type": "object" + }, + "purchase_type": { + "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.", + "enum": [ + "fuel_and_non_fuel_purchase", + "fuel_purchase", + "non_fuel_purchase" + ], + "maxLength": 5000, + "type": "string" + }, + "reported_breakdown": { + "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.", + "properties": { + "fuel": { + "description": "Breakdown of fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_fuel_specs", + "type": "object" + }, + "non_fuel": { + "description": "Breakdown of non-fuel portion of the purchase.", + "properties": { + "gross_amount_decimal": { + "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.", + "format": "decimal", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_non_fuel_specs", + "type": "object" + }, + "tax": { + "description": "Information about tax included in this transaction.", + "properties": { + "local_amount_decimal": { + "description": "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", + "type": "string" + }, + "national_amount_decimal": { + "description": "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", + "type": "string" + } + }, + "title": "fleet_reported_breakdown_tax_specs", + "type": "object" + } + }, + "title": "fleet_reported_breakdown_specs", + "type": "object" + }, + "service_type": { + "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.", + "enum": [ + "full_service", + "non_fuel_transaction", + "self_service" + ], + "maxLength": 5000, + "type": "string" + } + }, + "title": "fleet_specs", + "type": "object" + }, "flight": { "description": "Information about the flight that was purchased with this transaction.", "properties": { @@ -159429,6 +160670,11 @@ "fuel": { "description": "Information about fuel that was purchased with this transaction.", "properties": { + "industry_product_code": { + "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.", + "maxLength": 5000, + "type": "string" + }, "quantity_decimal": { "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.", "format": "decimal", diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml index 2867c326..8a496196 100644 --- a/openapi/spec3.sdk.yaml +++ b/openapi/spec3.sdk.yaml @@ -19601,6 +19601,19 @@ components: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string + fleet: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_data' + description: Fleet-specific information for authorizations using Fleet cards. + nullable: true + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fuel_data' + description: >- + 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. + nullable: true id: description: Unique identifier for the object. maxLength: 5000 @@ -19728,6 +19741,8 @@ components: - cardholder - created - currency + - fleet + - fuel - id - livemode - merchant_amount @@ -19749,6 +19764,8 @@ components: - balance_transactions - card - cardholder + - fleet + - fuel - merchant_data - network_data - pending_request @@ -19799,6 +19816,12 @@ components: method_type: custom operation: post path: '/v1/test_helpers/issuing/authorizations/{authorization}/expire' + - method_name: finalize_amount + method_on: service + method_type: custom + operation: post + path: >- + /v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount - method_name: increment method_on: service method_type: custom @@ -21063,6 +21086,241 @@ components: title: IssuingAuthorizationAuthenticationExemption type: object x-expandableFields: [] + issuing_authorization_fleet_cardholder_prompt_data: + description: '' + properties: + alphanumeric_id: + 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. + maxLength: 5000 + nullable: true + type: string + driver_id: + description: Driver ID. + maxLength: 5000 + nullable: true + type: string + odometer: + description: Odometer reading. + nullable: true + type: integer + unspecified_id: + 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. + maxLength: 5000 + nullable: true + type: string + user_id: + description: User ID. + maxLength: 5000 + nullable: true + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + nullable: true + type: string + required: + - alphanumeric_id + - driver_id + - odometer + - unspecified_id + - user_id + - vehicle_number + title: IssuingAuthorizationFleetCardholderPromptData + type: object + x-expandableFields: [] + issuing_authorization_fleet_data: + description: '' + properties: + cardholder_prompt_data: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_cardholder_prompt_data + 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. + nullable: true + purchase_type: + description: The type of purchase. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + nullable: true + type: string + reported_breakdown: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_reported_breakdown + 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. + nullable: true + service_type: + description: The type of fuel service. + enum: + - full_service + - non_fuel_transaction + - self_service + nullable: true + type: string + required: + - cardholder_prompt_data + - purchase_type + - reported_breakdown + - service_type + title: IssuingAuthorizationFleetData + type: object + x-expandableFields: + - cardholder_prompt_data + - reported_breakdown + issuing_authorization_fleet_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Quantity multiplied by Fuel + Unit Cost, inclusive of taxes. + format: decimal + nullable: true + type: string + required: + - gross_amount_decimal + title: IssuingAuthorizationFleetFuelPriceData + type: object + x-expandableFields: [] + issuing_authorization_fleet_non_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum of the line items, + inclusive of taxes. + format: decimal + nullable: true + type: string + required: + - gross_amount_decimal + title: IssuingAuthorizationFleetNonFuelPriceData + type: object + x-expandableFields: [] + issuing_authorization_fleet_reported_breakdown: + description: '' + properties: + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_fuel_price_data' + description: Breakdown of fuel portion of the purchase. + nullable: true + non_fuel: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_non_fuel_price_data + description: Breakdown of non-fuel portion of the purchase. + nullable: true + tax: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_tax_data' + description: Information about tax included in this transaction. + nullable: true + required: + - fuel + - non_fuel + - tax + title: IssuingAuthorizationFleetReportedBreakdown + type: object + x-expandableFields: + - fuel + - non_fuel + - tax + issuing_authorization_fleet_tax_data: + description: '' + properties: + local_amount_decimal: + description: >- + 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 + nullable: true + type: string + national_amount_decimal: + description: >- + 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 + nullable: true + type: string + required: + - local_amount_decimal + - national_amount_decimal + title: IssuingAuthorizationFleetTaxData + type: object + x-expandableFields: [] + issuing_authorization_fuel_data: + description: '' + properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + nullable: true + type: string + quantity_decimal: + description: >- + The quantity of `unit`s of fuel that was dispensed, represented as a + decimal string with at most 12 decimal places. + format: decimal + nullable: true + type: string + type: + description: The type of fuel that was purchased. + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + nullable: true + type: string + unit: + description: The units for `quantity_decimal`. + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + nullable: true + type: string + unit_cost_decimal: + description: >- + The cost in cents per each unit of fuel, represented as a decimal + string with at most 12 decimal places. + format: decimal + nullable: true + type: string + required: + - industry_product_code + - quantity_decimal + - type + - unit + - unit_cost_decimal + title: IssuingAuthorizationFuelData + type: object + x-expandableFields: [] issuing_authorization_merchant_data: description: '' properties: @@ -21301,11 +21559,16 @@ components: enum: - account_disabled - card_active + - card_canceled + - card_expired - card_inactive + - cardholder_blocked - cardholder_inactive - cardholder_verification_required + - insecure_authorization_method - insufficient_funds - not_allowed + - pin_blocked - spending_controls - suspected_fraud - verification_failed @@ -24931,6 +25194,169 @@ components: title: IssuingTransactionAmountDetails type: object x-expandableFields: [] + issuing_transaction_fleet_cardholder_prompt_data: + description: '' + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + nullable: true + type: string + odometer: + description: Odometer reading. + nullable: true + type: integer + unspecified_id: + 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. + maxLength: 5000 + nullable: true + type: string + user_id: + description: User ID. + maxLength: 5000 + nullable: true + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + nullable: true + type: string + required: + - driver_id + - odometer + - unspecified_id + - user_id + - vehicle_number + title: IssuingTransactionFleetCardholderPromptData + type: object + x-expandableFields: [] + issuing_transaction_fleet_data: + description: '' + properties: + cardholder_prompt_data: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_cardholder_prompt_data + description: Answers to prompts presented to cardholder at point of sale. + nullable: true + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, + or `fuel_and_non_fuel_purchase`. + maxLength: 5000 + nullable: true + type: string + reported_breakdown: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_reported_breakdown + description: >- + More information about the total amount. This information is not + guaranteed to be accurate as some merchants may provide unreliable + data. + nullable: true + service_type: + description: >- + The type of fuel service. One of `non_fuel_transaction`, + `full_service`, or `self_service`. + maxLength: 5000 + nullable: true + type: string + required: + - cardholder_prompt_data + - purchase_type + - reported_breakdown + - service_type + title: IssuingTransactionFleetData + type: object + x-expandableFields: + - cardholder_prompt_data + - reported_breakdown + issuing_transaction_fleet_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Volume multipled by Fuel + Unit Cost, inclusive of taxes. + format: decimal + nullable: true + type: string + required: + - gross_amount_decimal + title: IssuingTransactionFleetFuelPriceData + type: object + x-expandableFields: [] + issuing_transaction_fleet_non_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum of the line items, + inclusive of taxes. + format: decimal + nullable: true + type: string + required: + - gross_amount_decimal + title: IssuingTransactionFleetNonFuelPriceData + type: object + x-expandableFields: [] + issuing_transaction_fleet_reported_breakdown: + description: '' + properties: + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_fuel_price_data' + description: Breakdown of fuel portion of the purchase. + nullable: true + non_fuel: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_non_fuel_price_data + description: Breakdown of non-fuel portion of the purchase. + nullable: true + tax: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_tax_data' + description: Information about tax included in this transaction. + nullable: true + required: + - fuel + - non_fuel + - tax + title: IssuingTransactionFleetReportedBreakdown + type: object + x-expandableFields: + - fuel + - non_fuel + - tax + issuing_transaction_fleet_tax_data: + description: '' + properties: + local_amount_decimal: + description: >- + 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 + nullable: true + type: string + national_amount_decimal: + description: >- + 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 + nullable: true + type: string + required: + - local_amount_decimal + - national_amount_decimal + title: IssuingTransactionFleetTaxData + type: object + x-expandableFields: [] issuing_transaction_flight_data: description: '' properties: @@ -25013,6 +25439,14 @@ components: issuing_transaction_fuel_data: description: '' properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + nullable: true + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, represented as a @@ -25040,6 +25474,7 @@ components: format: decimal type: string required: + - industry_product_code - quantity_decimal - type - unit @@ -25104,6 +25539,11 @@ components: issuing_transaction_purchase_details: description: '' properties: + fleet: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_data' + description: Fleet-specific information for transactions using Fleet cards. + nullable: true flight: anyOf: - $ref: '#/components/schemas/issuing_transaction_flight_data' @@ -25133,6 +25573,7 @@ components: nullable: true type: string required: + - fleet - flight - fuel - lodging @@ -25141,6 +25582,7 @@ components: title: IssuingTransactionPurchaseDetails type: object x-expandableFields: + - fleet - flight - fuel - lodging @@ -147808,6 +148250,12 @@ paths: expand: explode: true style: deepObject + fleet: + explode: true + style: deepObject + fuel: + explode: true + style: deepObject merchant_data: explode: true style: deepObject @@ -147868,6 +148316,171 @@ paths: maxLength: 5000 type: string type: array + fleet: + description: >- + Fleet-specific information for authorizations using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Volume + multipled by Fuel Unit Cost, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum + of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: Information about tax included in this transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of `non_fuel_transaction`, + `full_service`, or `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object + fuel: + description: >- + Information about fuel that was purchased with this + transaction. + properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string + quantity_decimal: + description: >- + The quantity of `unit`s of fuel that was dispensed, + represented as a decimal string with at most 12 decimal + places. + format: decimal + type: string + type: + description: >- + The type of fuel that was purchased. One of `diesel`, + `unleaded_plus`, `unleaded_regular`, `unleaded_super`, + or `other`. + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + maxLength: 5000 + type: string + unit: + description: >- + The units for `quantity_decimal`. One of + `charging_minute`, `imperial_gallon`, `kilogram`, + `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or + `other`. + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + maxLength: 5000 + type: string + unit_cost_decimal: + description: >- + The cost in cents per each unit of fuel, represented as + a decimal string with at most 12 decimal places. + format: decimal + type: string + title: fuel_specs + type: object is_amount_controllable: description: >- If set `true`, you may provide @@ -148402,6 +149015,120 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + description: >- + Fleet-specific information for transactions using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or + `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel + Volume multipled by Fuel Unit Cost, + inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the + sum of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: >- + Information about tax included in this + transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of + `non_fuel_transaction`, `full_service`, or + `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: description: >- Information about the flight that was purchased with @@ -148463,6 +149190,13 @@ paths: Information about fuel that was purchased with this transaction. properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, @@ -148603,6 +149337,231 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount': + post: + description: >- +Finalize the amount on an Authorization prior to capture, when the + initial authorization was for an estimated amount.
+ operationId: PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount + parameters: + - in: path + name: authorization + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + fleet: + explode: true + style: deepObject + fuel: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + final_amount: + description: >- + The final authorization amount that will be captured by the + merchant. This amount is in the authorization currency and + in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + fleet: + description: >- + Fleet-specific information for authorizations using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Volume + multipled by Fuel Unit Cost, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum + of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: Information about tax included in this transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of `non_fuel_transaction`, + `full_service`, or `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object + fuel: + description: >- + Information about fuel that was purchased with this + transaction. + properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string + quantity_decimal: + description: >- + The quantity of `unit`s of fuel that was dispensed, + represented as a decimal string with at most 12 decimal + places. + format: decimal + type: string + type: + description: >- + The type of fuel that was purchased. One of `diesel`, + `unleaded_plus`, `unleaded_regular`, `unleaded_super`, + or `other`. + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + maxLength: 5000 + type: string + unit: + description: >- + The units for `quantity_decimal`. One of + `charging_minute`, `imperial_gallon`, `kilogram`, + `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or + `other`. + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + maxLength: 5000 + type: string + unit_cost_decimal: + description: >- + The cost in cents per each unit of fuel, represented as + a decimal string with at most 12 decimal places. + format: decimal + type: string + title: fuel_specs + type: object + required: + - final_amount + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.authorization' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/test_helpers/issuing/authorizations/{authorization}/increment': post: description:Increment a test-mode Authorization.
@@ -149471,6 +150430,120 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + description: >- + Fleet-specific information for transactions using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or + `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel + Volume multipled by Fuel Unit Cost, + inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the + sum of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: >- + Information about tax included in this + transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of + `non_fuel_transaction`, `full_service`, or + `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: description: >- Information about the flight that was purchased with @@ -149532,6 +150605,13 @@ paths: Information about fuel that was purchased with this transaction. properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, @@ -150039,6 +151119,120 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + description: >- + Fleet-specific information for transactions using Fleet + cards. + properties: + cardholder_prompt_data: + 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. + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + type: string + odometer: + description: Odometer reading. + type: integer + unspecified_id: + 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. + maxLength: 5000 + type: string + user_id: + description: User ID. + maxLength: 5000 + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, + `non_fuel_purchase`, or + `fuel_and_non_fuel_purchase`. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + description: >- + More information about the total amount. This + information is not guaranteed to be accurate as some + merchants may provide unreliable data. + properties: + fuel: + description: Breakdown of fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel + Volume multipled by Fuel Unit Cost, + inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + description: Breakdown of non-fuel portion of the purchase. + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the + sum of the line items, inclusive of taxes. + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + description: >- + Information about tax included in this + transaction. + properties: + local_amount_decimal: + description: >- + 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 + type: string + national_amount_decimal: + description: >- + 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 + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + description: >- + The type of fuel service. One of + `non_fuel_transaction`, `full_service`, or + `self_service`. + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: description: >- Information about the flight that was purchased with @@ -150100,6 +151294,13 @@ paths: Information about fuel that was purchased with this transaction. properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml index 0563c23a..5f642bc6 100644 --- a/openapi/spec3.yaml +++ b/openapi/spec3.yaml @@ -15929,6 +15929,19 @@ components: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string + fleet: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_data' + description: Fleet-specific information for authorizations using Fleet cards. + nullable: true + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fuel_data' + description: >- + 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. + nullable: true id: description: Unique identifier for the object. maxLength: 5000 @@ -16072,6 +16085,8 @@ components: - balance_transactions - card - cardholder + - fleet + - fuel - merchant_data - network_data - pending_request @@ -17153,6 +17168,212 @@ components: title: IssuingAuthorizationAuthenticationExemption type: object x-expandableFields: [] + issuing_authorization_fleet_cardholder_prompt_data: + description: '' + properties: + alphanumeric_id: + 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. + maxLength: 5000 + nullable: true + type: string + driver_id: + description: Driver ID. + maxLength: 5000 + nullable: true + type: string + odometer: + description: Odometer reading. + nullable: true + type: integer + unspecified_id: + 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. + maxLength: 5000 + nullable: true + type: string + user_id: + description: User ID. + maxLength: 5000 + nullable: true + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + nullable: true + type: string + title: IssuingAuthorizationFleetCardholderPromptData + type: object + x-expandableFields: [] + issuing_authorization_fleet_data: + description: '' + properties: + cardholder_prompt_data: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_cardholder_prompt_data + 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. + nullable: true + purchase_type: + description: The type of purchase. + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + nullable: true + type: string + reported_breakdown: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_reported_breakdown + 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. + nullable: true + service_type: + description: The type of fuel service. + enum: + - full_service + - non_fuel_transaction + - self_service + nullable: true + type: string + title: IssuingAuthorizationFleetData + type: object + x-expandableFields: + - cardholder_prompt_data + - reported_breakdown + issuing_authorization_fleet_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Quantity multiplied by Fuel + Unit Cost, inclusive of taxes. + format: decimal + nullable: true + type: string + title: IssuingAuthorizationFleetFuelPriceData + type: object + x-expandableFields: [] + issuing_authorization_fleet_non_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum of the line items, + inclusive of taxes. + format: decimal + nullable: true + type: string + title: IssuingAuthorizationFleetNonFuelPriceData + type: object + x-expandableFields: [] + issuing_authorization_fleet_reported_breakdown: + description: '' + properties: + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_fuel_price_data' + description: Breakdown of fuel portion of the purchase. + nullable: true + non_fuel: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_fleet_non_fuel_price_data + description: Breakdown of non-fuel portion of the purchase. + nullable: true + tax: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_fleet_tax_data' + description: Information about tax included in this transaction. + nullable: true + title: IssuingAuthorizationFleetReportedBreakdown + type: object + x-expandableFields: + - fuel + - non_fuel + - tax + issuing_authorization_fleet_tax_data: + description: '' + properties: + local_amount_decimal: + description: >- + 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 + nullable: true + type: string + national_amount_decimal: + description: >- + 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 + nullable: true + type: string + title: IssuingAuthorizationFleetTaxData + type: object + x-expandableFields: [] + issuing_authorization_fuel_data: + description: '' + properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + nullable: true + type: string + quantity_decimal: + description: >- + The quantity of `unit`s of fuel that was dispensed, represented as a + decimal string with at most 12 decimal places. + format: decimal + nullable: true + type: string + type: + description: The type of fuel that was purchased. + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + nullable: true + type: string + unit: + description: The units for `quantity_decimal`. + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + nullable: true + type: string + unit_cost_decimal: + description: >- + The cost in cents per each unit of fuel, represented as a decimal + string with at most 12 decimal places. + format: decimal + nullable: true + type: string + title: IssuingAuthorizationFuelData + type: object + x-expandableFields: [] issuing_authorization_merchant_data: description: '' properties: @@ -17378,11 +17599,16 @@ components: enum: - account_disabled - card_active + - card_canceled + - card_expired - card_inactive + - cardholder_blocked - cardholder_inactive - cardholder_verification_required + - insecure_authorization_method - insufficient_funds - not_allowed + - pin_blocked - spending_controls - suspected_fraud - verification_failed @@ -20693,6 +20919,147 @@ components: title: IssuingTransactionAmountDetails type: object x-expandableFields: [] + issuing_transaction_fleet_cardholder_prompt_data: + description: '' + properties: + driver_id: + description: Driver ID. + maxLength: 5000 + nullable: true + type: string + odometer: + description: Odometer reading. + nullable: true + type: integer + unspecified_id: + 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. + maxLength: 5000 + nullable: true + type: string + user_id: + description: User ID. + maxLength: 5000 + nullable: true + type: string + vehicle_number: + description: Vehicle number. + maxLength: 5000 + nullable: true + type: string + title: IssuingTransactionFleetCardholderPromptData + type: object + x-expandableFields: [] + issuing_transaction_fleet_data: + description: '' + properties: + cardholder_prompt_data: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_cardholder_prompt_data + description: Answers to prompts presented to cardholder at point of sale. + nullable: true + purchase_type: + description: >- + The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, + or `fuel_and_non_fuel_purchase`. + maxLength: 5000 + nullable: true + type: string + reported_breakdown: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_reported_breakdown + description: >- + More information about the total amount. This information is not + guaranteed to be accurate as some merchants may provide unreliable + data. + nullable: true + service_type: + description: >- + The type of fuel service. One of `non_fuel_transaction`, + `full_service`, or `self_service`. + maxLength: 5000 + nullable: true + type: string + title: IssuingTransactionFleetData + type: object + x-expandableFields: + - cardholder_prompt_data + - reported_breakdown + issuing_transaction_fleet_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross fuel amount that should equal Fuel Volume multipled by Fuel + Unit Cost, inclusive of taxes. + format: decimal + nullable: true + type: string + title: IssuingTransactionFleetFuelPriceData + type: object + x-expandableFields: [] + issuing_transaction_fleet_non_fuel_price_data: + description: '' + properties: + gross_amount_decimal: + description: >- + Gross non-fuel amount that should equal the sum of the line items, + inclusive of taxes. + format: decimal + nullable: true + type: string + title: IssuingTransactionFleetNonFuelPriceData + type: object + x-expandableFields: [] + issuing_transaction_fleet_reported_breakdown: + description: '' + properties: + fuel: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_fuel_price_data' + description: Breakdown of fuel portion of the purchase. + nullable: true + non_fuel: + anyOf: + - $ref: >- + #/components/schemas/issuing_transaction_fleet_non_fuel_price_data + description: Breakdown of non-fuel portion of the purchase. + nullable: true + tax: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_tax_data' + description: Information about tax included in this transaction. + nullable: true + title: IssuingTransactionFleetReportedBreakdown + type: object + x-expandableFields: + - fuel + - non_fuel + - tax + issuing_transaction_fleet_tax_data: + description: '' + properties: + local_amount_decimal: + description: >- + 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 + nullable: true + type: string + national_amount_decimal: + description: >- + 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 + nullable: true + type: string + title: IssuingTransactionFleetTaxData + type: object + x-expandableFields: [] issuing_transaction_flight_data: description: '' properties: @@ -20762,6 +21129,14 @@ components: issuing_transaction_fuel_data: description: '' properties: + industry_product_code: + description: >- + [Conexxus Payment System Product + Code](https://www.conexxus.org/conexxus-payment-system-product-codes) + identifying the primary fuel product purchased. + maxLength: 5000 + nullable: true + type: string quantity_decimal: description: >- The quantity of `unit`s of fuel that was dispensed, represented as a @@ -20845,6 +21220,11 @@ components: issuing_transaction_purchase_details: description: '' properties: + fleet: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_fleet_data' + description: Fleet-specific information for transactions using Fleet cards. + nullable: true flight: anyOf: - $ref: '#/components/schemas/issuing_transaction_flight_data' @@ -20876,6 +21256,7 @@ components: title: IssuingTransactionPurchaseDetails type: object x-expandableFields: + - fleet - flight - fuel - lodging @@ -124881,6 +125262,12 @@ paths: expand: explode: true style: deepObject + fleet: + explode: true + style: deepObject + fuel: + explode: true + style: deepObject merchant_data: explode: true style: deepObject @@ -124939,6 +125326,110 @@ paths: maxLength: 5000 type: string type: array + fleet: + description: >- + Fleet-specific information for authorizations using Fleet + cards. + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object + fuel: + description: >- + Information about fuel that was purchased with this + transaction. + properties: + industry_product_code: + maxLength: 5000 + type: string + quantity_decimal: + format: decimal + type: string + type: + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + maxLength: 5000 + type: string + unit: + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + maxLength: 5000 + type: string + unit_cost_decimal: + format: decimal + type: string + title: fuel_specs + type: object is_amount_controllable: description: >- If set `true`, you may provide @@ -125432,6 +125923,70 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: properties: departure_at: @@ -125472,6 +126027,9 @@ paths: type: object fuel: properties: + industry_product_code: + maxLength: 5000 + type: string quantity_decimal: format: decimal type: string @@ -125589,6 +126147,170 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount': + post: + description: >- +Finalize the amount on an Authorization prior to capture, when the + initial authorization was for an estimated amount.
+ operationId: PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount + parameters: + - in: path + name: authorization + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + fleet: + explode: true + style: deepObject + fuel: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + final_amount: + description: >- + The final authorization amount that will be captured by the + merchant. This amount is in the authorization currency and + in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + fleet: + description: >- + Fleet-specific information for authorizations using Fleet + cards. + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object + fuel: + description: >- + Information about fuel that was purchased with this + transaction. + properties: + industry_product_code: + maxLength: 5000 + type: string + quantity_decimal: + format: decimal + type: string + type: + enum: + - diesel + - other + - unleaded_plus + - unleaded_regular + - unleaded_super + maxLength: 5000 + type: string + unit: + enum: + - charging_minute + - imperial_gallon + - kilogram + - kilowatt_hour + - liter + - other + - pound + - us_gallon + maxLength: 5000 + type: string + unit_cost_decimal: + format: decimal + type: string + title: fuel_specs + type: object + required: + - final_amount + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.authorization' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/test_helpers/issuing/authorizations/{authorization}/increment': post: description:Increment a test-mode Authorization.
@@ -126437,6 +127159,70 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: properties: departure_at: @@ -126477,6 +127263,9 @@ paths: type: object fuel: properties: + industry_product_code: + maxLength: 5000 + type: string quantity_decimal: format: decimal type: string @@ -126943,6 +127732,70 @@ paths: Additional purchase information that is optionally provided by the merchant. properties: + fleet: + properties: + cardholder_prompt_data: + properties: + driver_id: + maxLength: 5000 + type: string + odometer: + type: integer + unspecified_id: + maxLength: 5000 + type: string + user_id: + maxLength: 5000 + type: string + vehicle_number: + maxLength: 5000 + type: string + title: fleet_cardholder_prompt_data_specs + type: object + purchase_type: + enum: + - fuel_and_non_fuel_purchase + - fuel_purchase + - non_fuel_purchase + maxLength: 5000 + type: string + reported_breakdown: + properties: + fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_fuel_specs + type: object + non_fuel: + properties: + gross_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_non_fuel_specs + type: object + tax: + properties: + local_amount_decimal: + format: decimal + type: string + national_amount_decimal: + format: decimal + type: string + title: fleet_reported_breakdown_tax_specs + type: object + title: fleet_reported_breakdown_specs + type: object + service_type: + enum: + - full_service + - non_fuel_transaction + - self_service + maxLength: 5000 + type: string + title: fleet_specs + type: object flight: properties: departure_at: @@ -126983,6 +127836,9 @@ paths: type: object fuel: properties: + industry_product_code: + maxLength: 5000 + type: string quantity_decimal: format: decimal type: string