Stripe.Params.TestHelpers.Issuing.AuthorizationCaptureParams (tiger_stripe v0.3.0)

Parameters for authorization capture.

Summary

Types

purchase_details()

purchase_details_fleet()

purchase_details_fleet_cardholder_prompt_data()

purchase_details_fleet_reported_breakdown()

purchase_details_fleet_reported_breakdown_fuel()

purchase_details_fleet_reported_breakdown_non_fuel()

purchase_details_fleet_reported_breakdown_tax()

purchase_details_flight()

purchase_details_flight_segments()

purchase_details_fuel()

purchase_details_lodging()

purchase_details_receipt()

t()

Types

purchase_details()

@type purchase_details() :: %{
  optional(:fleet) => purchase_details_fleet() | nil,
  optional(:flight) => purchase_details_flight() | nil,
  optional(:fuel) => purchase_details_fuel() | nil,
  optional(:lodging) => purchase_details_lodging() | nil,
  optional(:receipt) => [purchase_details_receipt()] | nil,
  optional(:reference) => String.t() | nil,
  optional(String.t()) => term()
}

fleet - Fleet-specific information for transactions using Fleet cards.
flight - Information about the flight that was purchased with this transaction.
fuel - Information about fuel that was purchased with this transaction.
lodging - Information about lodging that was purchased with this transaction.
receipt - The line items in the purchase.
reference - A merchant-specific order number. Max length: 5000.

purchase_details_fleet()

@type purchase_details_fleet() :: %{
  optional(:cardholder_prompt_data) =>
    purchase_details_fleet_cardholder_prompt_data() | nil,
  optional(:purchase_type) => String.t() | nil,
  optional(:reported_breakdown) =>
    purchase_details_fleet_reported_breakdown() | nil,
  optional(:service_type) => String.t() | nil,
  optional(String.t()) => term()
}

cardholder_prompt_data - 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.
purchase_type - The type of purchase. One of fuel_purchase, non_fuel_purchase, or fuel_and_non_fuel_purchase. Possible values: fuel_and_non_fuel_purchase, fuel_purchase, non_fuel_purchase. Max length: 5000.
reported_breakdown - More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
service_type - The type of fuel service. One of non_fuel_transaction, full_service, or self_service. Possible values: full_service, non_fuel_transaction, self_service. Max length: 5000.

purchase_details_fleet_cardholder_prompt_data()

@type purchase_details_fleet_cardholder_prompt_data() :: %{
  optional(:driver_id) => String.t() | nil,
  optional(:odometer) => integer() | nil,
  optional(:unspecified_id) => String.t() | nil,
  optional(:user_id) => String.t() | nil,
  optional(:vehicle_number) => String.t() | nil,
  optional(String.t()) => term()
}

driver_id - Driver ID. Max length: 5000.
odometer - Odometer reading.
unspecified_id - 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. Max length: 5000.
user_id - User ID. Max length: 5000.
vehicle_number - Vehicle number. Max length: 5000.

purchase_details_fleet_reported_breakdown()

@type purchase_details_fleet_reported_breakdown() :: %{
  optional(:fuel) => purchase_details_fleet_reported_breakdown_fuel() | nil,
  optional(:non_fuel) =>
    purchase_details_fleet_reported_breakdown_non_fuel() | nil,
  optional(:tax) => purchase_details_fleet_reported_breakdown_tax() | nil,
  optional(String.t()) => term()
}

fuel - Breakdown of fuel portion of the purchase.
non_fuel - Breakdown of non-fuel portion of the purchase.
tax - Information about tax included in this transaction.

purchase_details_fleet_reported_breakdown_fuel()

@type purchase_details_fleet_reported_breakdown_fuel() :: %{
  optional(:gross_amount_decimal) => String.t() | nil,
  optional(String.t()) => term()
}

gross_amount_decimal - Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes. Format: decimal string.

purchase_details_fleet_reported_breakdown_non_fuel()

@type purchase_details_fleet_reported_breakdown_non_fuel() :: %{
  optional(:gross_amount_decimal) => String.t() | nil,
  optional(String.t()) => term()
}

gross_amount_decimal - Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. Format: decimal string.

purchase_details_fleet_reported_breakdown_tax()

@type purchase_details_fleet_reported_breakdown_tax() :: %{
  optional(:local_amount_decimal) => String.t() | nil,
  optional(:national_amount_decimal) => String.t() | nil,
  optional(String.t()) => term()
}

local_amount_decimal - 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 string.
national_amount_decimal - 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 string.

purchase_details_flight()

@type purchase_details_flight() :: %{
  optional(:departure_at) => integer() | nil,
  optional(:passenger_name) => String.t() | nil,
  optional(:refundable) => boolean() | nil,
  optional(:segments) => [purchase_details_flight_segments()] | nil,
  optional(:travel_agency) => String.t() | nil,
  optional(String.t()) => term()
}

departure_at - The time that the flight departed. Format: Unix timestamp.
passenger_name - The name of the passenger. Max length: 5000.
refundable - Whether the ticket is refundable.
segments - The legs of the trip.
travel_agency - The travel agency that issued the ticket. Max length: 5000.

purchase_details_flight_segments()

@type purchase_details_flight_segments() :: %{
  optional(:arrival_airport_code) => String.t() | nil,
  optional(:carrier) => String.t() | nil,
  optional(:departure_airport_code) => String.t() | nil,
  optional(:flight_number) => String.t() | nil,
  optional(:service_class) => String.t() | nil,
  optional(:stopover_allowed) => boolean() | nil,
  optional(String.t()) => term()
}

arrival_airport_code - The three-letter IATA airport code of the flight's destination. Max length: 3.
carrier - The airline carrier code. Max length: 5000.
departure_airport_code - The three-letter IATA airport code that the flight departed from. Max length: 3.
flight_number - The flight number. Max length: 5000.
service_class - The flight's service class. Max length: 5000.
stopover_allowed - Whether a stopover is allowed on this flight.

purchase_details_fuel()

@type purchase_details_fuel() :: %{
  optional(:industry_product_code) => String.t() | nil,
  optional(:quantity_decimal) => String.t() | nil,
  optional(:type) => String.t() | nil,
  optional(:unit) => String.t() | nil,
  optional(:unit_cost_decimal) => String.t() | nil,
  optional(String.t()) => term()
}

industry_product_code - Conexxus Payment System Product Code identifying the primary fuel product purchased. Max length: 5000.
quantity_decimal - The quantity of units of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. Format: decimal string.
type - The type of fuel that was purchased. One of diesel, unleaded_plus, unleaded_regular, unleaded_super, or other. Possible values: diesel, other, unleaded_plus, unleaded_regular, unleaded_super. Max length: 5000.
unit - The units for quantity_decimal. One of charging_minute, imperial_gallon, kilogram, kilowatt_hour, liter, pound, us_gallon, or other. Possible values: charging_minute, imperial_gallon, kilogram, kilowatt_hour, liter, other, pound, us_gallon. Max length: 5000.
unit_cost_decimal - The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. Format: decimal string.

purchase_details_lodging()

@type purchase_details_lodging() :: %{
  optional(:check_in_at) => integer() | nil,
  optional(:nights) => integer() | nil,
  optional(String.t()) => term()
}

check_in_at - The time of checking into the lodging. Format: Unix timestamp.
nights - The number of nights stayed at the lodging.

purchase_details_receipt()

@type purchase_details_receipt() :: %{
  optional(:description) => String.t() | nil,
  optional(:quantity) => String.t() | nil,
  optional(:total) => integer() | nil,
  optional(:unit_cost) => integer() | nil,
  optional(String.t()) => term()
}

description - Max length: 26.
quantity - Format: decimal string.
total
unit_cost

t()

@type t() :: %Stripe.Params.TestHelpers.Issuing.AuthorizationCaptureParams{
  capture_amount: integer() | nil,
  close_authorization: boolean() | nil,
  expand: [String.t()] | nil,
  purchase_details: purchase_details() | nil
}

capture_amount - The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the smallest currency unit.
close_authorization - Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.
expand - Specifies which fields in the response should be expanded.
purchase_details - Additional purchase information that is optionally provided by the merchant.