mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-06 00:02:18 -04:00
1521 lines
69 KiB
Ruby
1521 lines
69 KiB
Ruby
# File generated from our OpenAPI spec
|
||
# frozen_string_literal: true
|
||
|
||
module Stripe
|
||
module Issuing
|
||
# When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`
|
||
# object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the
|
||
# purchase to be completed successfully.
|
||
#
|
||
# Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)
|
||
class Authorization < APIResource
|
||
extend Gem::Deprecate
|
||
extend Stripe::APIOperations::List
|
||
include Stripe::APIOperations::Save
|
||
|
||
OBJECT_NAME = "issuing.authorization"
|
||
def self.object_name
|
||
"issuing.authorization"
|
||
end
|
||
|
||
class AmountDetails < Stripe::StripeObject
|
||
# The fee charged by the ATM for the cash withdrawal.
|
||
attr_reader :atm_fee
|
||
# The amount of cash requested by the cardholder.
|
||
attr_reader :cashback_amount
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class Fleet < Stripe::StripeObject
|
||
class CardholderPromptData < Stripe::StripeObject
|
||
# [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.
|
||
attr_reader :alphanumeric_id
|
||
# Driver ID.
|
||
attr_reader :driver_id
|
||
# Odometer reading.
|
||
attr_reader :odometer
|
||
# 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.
|
||
attr_reader :unspecified_id
|
||
# User ID.
|
||
attr_reader :user_id
|
||
# Vehicle number.
|
||
attr_reader :vehicle_number
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class ReportedBreakdown < Stripe::StripeObject
|
||
class Fuel < Stripe::StripeObject
|
||
# Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.
|
||
attr_reader :gross_amount_decimal
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class NonFuel < Stripe::StripeObject
|
||
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
|
||
attr_reader :gross_amount_decimal
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class Tax < Stripe::StripeObject
|
||
# Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.
|
||
attr_reader :local_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.
|
||
attr_reader :national_amount_decimal
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
# Breakdown of fuel portion of the purchase.
|
||
attr_reader :fuel
|
||
# Breakdown of non-fuel portion of the purchase.
|
||
attr_reader :non_fuel
|
||
# Information about tax included in this transaction.
|
||
attr_reader :tax
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = { fuel: Fuel, non_fuel: NonFuel, tax: Tax }
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
# 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.
|
||
attr_reader :cardholder_prompt_data
|
||
# The type of purchase.
|
||
attr_reader :purchase_type
|
||
# 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.
|
||
attr_reader :reported_breakdown
|
||
# The type of fuel service.
|
||
attr_reader :service_type
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {
|
||
cardholder_prompt_data: CardholderPromptData,
|
||
reported_breakdown: ReportedBreakdown,
|
||
}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class FraudChallenge < Stripe::StripeObject
|
||
# The method by which the fraud challenge was delivered to the cardholder.
|
||
attr_reader :channel
|
||
# The status of the fraud challenge.
|
||
attr_reader :status
|
||
# If the challenge is not deliverable, the reason why.
|
||
attr_reader :undeliverable_reason
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class Fuel < Stripe::StripeObject
|
||
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
|
||
attr_reader :industry_product_code
|
||
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
|
||
attr_reader :quantity_decimal
|
||
# The type of fuel that was purchased.
|
||
attr_reader :type
|
||
# The units for `quantity_decimal`.
|
||
attr_reader :unit
|
||
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
|
||
attr_reader :unit_cost_decimal
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class MerchantData < Stripe::StripeObject
|
||
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
|
||
attr_reader :category
|
||
# The merchant category code for the seller’s business
|
||
attr_reader :category_code
|
||
# City where the seller is located
|
||
attr_reader :city
|
||
# Country where the seller is located
|
||
attr_reader :country
|
||
# Name of the seller
|
||
attr_reader :name
|
||
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
|
||
attr_reader :network_id
|
||
# Postal code where the seller is located
|
||
attr_reader :postal_code
|
||
# State where the seller is located
|
||
attr_reader :state
|
||
# The seller's tax identification number. Currently populated for French merchants only.
|
||
attr_reader :tax_id
|
||
# An ID assigned by the seller to the location of the sale.
|
||
attr_reader :terminal_id
|
||
# URL provided by the merchant on a 3DS request
|
||
attr_reader :url
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class NetworkData < Stripe::StripeObject
|
||
# Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.
|
||
attr_reader :acquiring_institution_id
|
||
# The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.
|
||
attr_reader :system_trace_audit_number
|
||
# Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
|
||
attr_reader :transaction_id
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class PendingRequest < Stripe::StripeObject
|
||
class AmountDetails < Stripe::StripeObject
|
||
# The fee charged by the ATM for the cash withdrawal.
|
||
attr_reader :atm_fee
|
||
# The amount of cash requested by the cardholder.
|
||
attr_reader :cashback_amount
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
# The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_reader :amount
|
||
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_reader :amount_details
|
||
# 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).
|
||
attr_reader :currency
|
||
# 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.
|
||
attr_reader :is_amount_controllable
|
||
# The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_reader :merchant_amount
|
||
# The local currency the merchant is requesting to authorize.
|
||
attr_reader :merchant_currency
|
||
# The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
|
||
attr_reader :network_risk_score
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = { amount_details: AmountDetails }
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class RequestHistory < Stripe::StripeObject
|
||
class AmountDetails < Stripe::StripeObject
|
||
# The fee charged by the ATM for the cash withdrawal.
|
||
attr_reader :atm_fee
|
||
# The amount of cash requested by the cardholder.
|
||
attr_reader :cashback_amount
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
# The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.
|
||
attr_reader :amount
|
||
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_reader :amount_details
|
||
# Whether this request was approved.
|
||
attr_reader :approved
|
||
# A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
|
||
attr_reader :authorization_code
|
||
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
||
attr_reader :created
|
||
# 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).
|
||
attr_reader :currency
|
||
# The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_reader :merchant_amount
|
||
# The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
||
attr_reader :merchant_currency
|
||
# The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
|
||
attr_reader :network_risk_score
|
||
# When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.
|
||
attr_reader :reason
|
||
# If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.
|
||
attr_reader :reason_message
|
||
# Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.
|
||
attr_reader :requested_at
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = { amount_details: AmountDetails }
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class Treasury < Stripe::StripeObject
|
||
# The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization
|
||
attr_reader :received_credits
|
||
# The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization
|
||
attr_reader :received_debits
|
||
# The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization
|
||
attr_reader :transaction
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class VerificationData < Stripe::StripeObject
|
||
class AuthenticationExemption < Stripe::StripeObject
|
||
# The entity that requested the exemption, either the acquiring merchant or the Issuing user.
|
||
attr_reader :claimed_by
|
||
# The specific exemption claimed for this authorization.
|
||
attr_reader :type
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class ThreeDSecure < Stripe::StripeObject
|
||
# The outcome of the 3D Secure authentication request.
|
||
attr_reader :result
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
# Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.
|
||
attr_reader :address_line1_check
|
||
# Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.
|
||
attr_reader :address_postal_code_check
|
||
# The exemption applied to this authorization.
|
||
attr_reader :authentication_exemption
|
||
# Whether the cardholder provided a CVC and if it matched Stripe’s record.
|
||
attr_reader :cvc_check
|
||
# Whether the cardholder provided an expiry date and if it matched Stripe’s record.
|
||
attr_reader :expiry_check
|
||
# The postal code submitted as part of the authorization used for postal code verification.
|
||
attr_reader :postal_code
|
||
# 3D Secure details.
|
||
attr_reader :three_d_secure
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {
|
||
authentication_exemption: AuthenticationExemption,
|
||
three_d_secure: ThreeDSecure,
|
||
}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
|
||
class ListParams < Stripe::RequestParams
|
||
class Created < Stripe::RequestParams
|
||
# Minimum value to filter by (exclusive)
|
||
attr_accessor :gt
|
||
# Minimum value to filter by (inclusive)
|
||
attr_accessor :gte
|
||
# Maximum value to filter by (exclusive)
|
||
attr_accessor :lt
|
||
# Maximum value to filter by (inclusive)
|
||
attr_accessor :lte
|
||
|
||
def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
|
||
@gt = gt
|
||
@gte = gte
|
||
@lt = lt
|
||
@lte = lte
|
||
end
|
||
end
|
||
# Only return authorizations that belong to the given card.
|
||
attr_accessor :card
|
||
# Only return authorizations that belong to the given cardholder.
|
||
attr_accessor :cardholder
|
||
# Only return authorizations that were created during the given date interval.
|
||
attr_accessor :created
|
||
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
||
attr_accessor :ending_before
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
||
attr_accessor :limit
|
||
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
||
attr_accessor :starting_after
|
||
# Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.
|
||
attr_accessor :status
|
||
|
||
def initialize(
|
||
card: nil,
|
||
cardholder: nil,
|
||
created: nil,
|
||
ending_before: nil,
|
||
expand: nil,
|
||
limit: nil,
|
||
starting_after: nil,
|
||
status: nil
|
||
)
|
||
@card = card
|
||
@cardholder = cardholder
|
||
@created = created
|
||
@ending_before = ending_before
|
||
@expand = expand
|
||
@limit = limit
|
||
@starting_after = starting_after
|
||
@status = status
|
||
end
|
||
end
|
||
|
||
class UpdateParams < Stripe::RequestParams
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||
attr_accessor :metadata
|
||
|
||
def initialize(expand: nil, metadata: nil)
|
||
@expand = expand
|
||
@metadata = metadata
|
||
end
|
||
end
|
||
|
||
class ApproveParams < Stripe::RequestParams
|
||
# If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).
|
||
attr_accessor :amount
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||
attr_accessor :metadata
|
||
|
||
def initialize(amount: nil, expand: nil, metadata: nil)
|
||
@amount = amount
|
||
@expand = expand
|
||
@metadata = metadata
|
||
end
|
||
end
|
||
|
||
class DeclineParams < Stripe::RequestParams
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||
attr_accessor :metadata
|
||
|
||
def initialize(expand: nil, metadata: nil)
|
||
@expand = expand
|
||
@metadata = metadata
|
||
end
|
||
end
|
||
|
||
class CreateParams < Stripe::RequestParams
|
||
class AmountDetails < Stripe::RequestParams
|
||
# The ATM withdrawal fee.
|
||
attr_accessor :atm_fee
|
||
# The amount of cash requested by the cardholder.
|
||
attr_accessor :cashback_amount
|
||
|
||
def initialize(atm_fee: nil, cashback_amount: nil)
|
||
@atm_fee = atm_fee
|
||
@cashback_amount = cashback_amount
|
||
end
|
||
end
|
||
|
||
class Fleet < Stripe::RequestParams
|
||
class CardholderPromptData < Stripe::RequestParams
|
||
# Driver ID.
|
||
attr_accessor :driver_id
|
||
# Odometer reading.
|
||
attr_accessor :odometer
|
||
# 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.
|
||
attr_accessor :unspecified_id
|
||
# User ID.
|
||
attr_accessor :user_id
|
||
# Vehicle number.
|
||
attr_accessor :vehicle_number
|
||
|
||
def initialize(
|
||
driver_id: nil,
|
||
odometer: nil,
|
||
unspecified_id: nil,
|
||
user_id: nil,
|
||
vehicle_number: nil
|
||
)
|
||
@driver_id = driver_id
|
||
@odometer = odometer
|
||
@unspecified_id = unspecified_id
|
||
@user_id = user_id
|
||
@vehicle_number = vehicle_number
|
||
end
|
||
end
|
||
|
||
class ReportedBreakdown < Stripe::RequestParams
|
||
class Fuel < Stripe::RequestParams
|
||
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
|
||
attr_accessor :gross_amount_decimal
|
||
|
||
def initialize(gross_amount_decimal: nil)
|
||
@gross_amount_decimal = gross_amount_decimal
|
||
end
|
||
end
|
||
|
||
class NonFuel < Stripe::RequestParams
|
||
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
|
||
attr_accessor :gross_amount_decimal
|
||
|
||
def initialize(gross_amount_decimal: nil)
|
||
@gross_amount_decimal = gross_amount_decimal
|
||
end
|
||
end
|
||
|
||
class Tax < Stripe::RequestParams
|
||
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||
attr_accessor :local_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.
|
||
attr_accessor :national_amount_decimal
|
||
|
||
def initialize(local_amount_decimal: nil, national_amount_decimal: nil)
|
||
@local_amount_decimal = local_amount_decimal
|
||
@national_amount_decimal = national_amount_decimal
|
||
end
|
||
end
|
||
# Breakdown of fuel portion of the purchase.
|
||
attr_accessor :fuel
|
||
# Breakdown of non-fuel portion of the purchase.
|
||
attr_accessor :non_fuel
|
||
# Information about tax included in this transaction.
|
||
attr_accessor :tax
|
||
|
||
def initialize(fuel: nil, non_fuel: nil, tax: nil)
|
||
@fuel = fuel
|
||
@non_fuel = non_fuel
|
||
@tax = tax
|
||
end
|
||
end
|
||
# 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.
|
||
attr_accessor :cardholder_prompt_data
|
||
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
|
||
attr_accessor :purchase_type
|
||
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
|
||
attr_accessor :reported_breakdown
|
||
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
|
||
attr_accessor :service_type
|
||
|
||
def initialize(
|
||
cardholder_prompt_data: nil,
|
||
purchase_type: nil,
|
||
reported_breakdown: nil,
|
||
service_type: nil
|
||
)
|
||
@cardholder_prompt_data = cardholder_prompt_data
|
||
@purchase_type = purchase_type
|
||
@reported_breakdown = reported_breakdown
|
||
@service_type = service_type
|
||
end
|
||
end
|
||
|
||
class Fuel < Stripe::RequestParams
|
||
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
|
||
attr_accessor :industry_product_code
|
||
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
|
||
attr_accessor :quantity_decimal
|
||
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
|
||
attr_accessor :type
|
||
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
|
||
attr_accessor :unit
|
||
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
|
||
attr_accessor :unit_cost_decimal
|
||
|
||
def initialize(
|
||
industry_product_code: nil,
|
||
quantity_decimal: nil,
|
||
type: nil,
|
||
unit: nil,
|
||
unit_cost_decimal: nil
|
||
)
|
||
@industry_product_code = industry_product_code
|
||
@quantity_decimal = quantity_decimal
|
||
@type = type
|
||
@unit = unit
|
||
@unit_cost_decimal = unit_cost_decimal
|
||
end
|
||
end
|
||
|
||
class MerchantData < Stripe::RequestParams
|
||
# A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
|
||
attr_accessor :category
|
||
# City where the seller is located
|
||
attr_accessor :city
|
||
# Country where the seller is located
|
||
attr_accessor :country
|
||
# Name of the seller
|
||
attr_accessor :name
|
||
# Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
|
||
attr_accessor :network_id
|
||
# Postal code where the seller is located
|
||
attr_accessor :postal_code
|
||
# State where the seller is located
|
||
attr_accessor :state
|
||
# An ID assigned by the seller to the location of the sale.
|
||
attr_accessor :terminal_id
|
||
# URL provided by the merchant on a 3DS request
|
||
attr_accessor :url
|
||
|
||
def initialize(
|
||
category: nil,
|
||
city: nil,
|
||
country: nil,
|
||
name: nil,
|
||
network_id: nil,
|
||
postal_code: nil,
|
||
state: nil,
|
||
terminal_id: nil,
|
||
url: nil
|
||
)
|
||
@category = category
|
||
@city = city
|
||
@country = country
|
||
@name = name
|
||
@network_id = network_id
|
||
@postal_code = postal_code
|
||
@state = state
|
||
@terminal_id = terminal_id
|
||
@url = url
|
||
end
|
||
end
|
||
|
||
class NetworkData < Stripe::RequestParams
|
||
# Identifier assigned to the acquirer by the card network.
|
||
attr_accessor :acquiring_institution_id
|
||
|
||
def initialize(acquiring_institution_id: nil)
|
||
@acquiring_institution_id = acquiring_institution_id
|
||
end
|
||
end
|
||
|
||
class VerificationData < Stripe::RequestParams
|
||
class AuthenticationExemption < Stripe::RequestParams
|
||
# The entity that requested the exemption, either the acquiring merchant or the Issuing user.
|
||
attr_accessor :claimed_by
|
||
# The specific exemption claimed for this authorization.
|
||
attr_accessor :type
|
||
|
||
def initialize(claimed_by: nil, type: nil)
|
||
@claimed_by = claimed_by
|
||
@type = type
|
||
end
|
||
end
|
||
|
||
class ThreeDSecure < Stripe::RequestParams
|
||
# The outcome of the 3D Secure authentication request.
|
||
attr_accessor :result
|
||
|
||
def initialize(result: nil)
|
||
@result = result
|
||
end
|
||
end
|
||
# Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.
|
||
attr_accessor :address_line1_check
|
||
# Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.
|
||
attr_accessor :address_postal_code_check
|
||
# The exemption applied to this authorization.
|
||
attr_accessor :authentication_exemption
|
||
# Whether the cardholder provided a CVC and if it matched Stripe’s record.
|
||
attr_accessor :cvc_check
|
||
# Whether the cardholder provided an expiry date and if it matched Stripe’s record.
|
||
attr_accessor :expiry_check
|
||
# 3D Secure details.
|
||
attr_accessor :three_d_secure
|
||
|
||
def initialize(
|
||
address_line1_check: nil,
|
||
address_postal_code_check: nil,
|
||
authentication_exemption: nil,
|
||
cvc_check: nil,
|
||
expiry_check: nil,
|
||
three_d_secure: nil
|
||
)
|
||
@address_line1_check = address_line1_check
|
||
@address_postal_code_check = address_postal_code_check
|
||
@authentication_exemption = authentication_exemption
|
||
@cvc_check = cvc_check
|
||
@expiry_check = expiry_check
|
||
@three_d_secure = three_d_secure
|
||
end
|
||
end
|
||
# The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_accessor :amount
|
||
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_accessor :amount_details
|
||
# How the card details were provided. Defaults to online.
|
||
attr_accessor :authorization_method
|
||
# Card associated with this authorization.
|
||
attr_accessor :card
|
||
# The currency of the authorization. If not provided, defaults to the currency of the card. 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).
|
||
attr_accessor :currency
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# Fleet-specific information for authorizations using Fleet cards.
|
||
attr_accessor :fleet
|
||
# Information about fuel that was purchased with this transaction.
|
||
attr_accessor :fuel
|
||
# 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.
|
||
attr_accessor :is_amount_controllable
|
||
# The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_accessor :merchant_amount
|
||
# The currency of the authorization. If not provided, defaults to the currency of the card. 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).
|
||
attr_accessor :merchant_currency
|
||
# Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
|
||
attr_accessor :merchant_data
|
||
# Details about the authorization, such as identifiers, set by the card network.
|
||
attr_accessor :network_data
|
||
# Verifications that Stripe performed on information that the cardholder provided to the merchant.
|
||
attr_accessor :verification_data
|
||
# The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
|
||
attr_accessor :wallet
|
||
|
||
def initialize(
|
||
amount: nil,
|
||
amount_details: nil,
|
||
authorization_method: nil,
|
||
card: nil,
|
||
currency: nil,
|
||
expand: nil,
|
||
fleet: nil,
|
||
fuel: nil,
|
||
is_amount_controllable: nil,
|
||
merchant_amount: nil,
|
||
merchant_currency: nil,
|
||
merchant_data: nil,
|
||
network_data: nil,
|
||
verification_data: nil,
|
||
wallet: nil
|
||
)
|
||
@amount = amount
|
||
@amount_details = amount_details
|
||
@authorization_method = authorization_method
|
||
@card = card
|
||
@currency = currency
|
||
@expand = expand
|
||
@fleet = fleet
|
||
@fuel = fuel
|
||
@is_amount_controllable = is_amount_controllable
|
||
@merchant_amount = merchant_amount
|
||
@merchant_currency = merchant_currency
|
||
@merchant_data = merchant_data
|
||
@network_data = network_data
|
||
@verification_data = verification_data
|
||
@wallet = wallet
|
||
end
|
||
end
|
||
|
||
class CaptureParams < Stripe::RequestParams
|
||
class PurchaseDetails < Stripe::RequestParams
|
||
class Fleet < Stripe::RequestParams
|
||
class CardholderPromptData < Stripe::RequestParams
|
||
# Driver ID.
|
||
attr_accessor :driver_id
|
||
# Odometer reading.
|
||
attr_accessor :odometer
|
||
# 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.
|
||
attr_accessor :unspecified_id
|
||
# User ID.
|
||
attr_accessor :user_id
|
||
# Vehicle number.
|
||
attr_accessor :vehicle_number
|
||
|
||
def initialize(
|
||
driver_id: nil,
|
||
odometer: nil,
|
||
unspecified_id: nil,
|
||
user_id: nil,
|
||
vehicle_number: nil
|
||
)
|
||
@driver_id = driver_id
|
||
@odometer = odometer
|
||
@unspecified_id = unspecified_id
|
||
@user_id = user_id
|
||
@vehicle_number = vehicle_number
|
||
end
|
||
end
|
||
|
||
class ReportedBreakdown < Stripe::RequestParams
|
||
class Fuel < Stripe::RequestParams
|
||
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
|
||
attr_accessor :gross_amount_decimal
|
||
|
||
def initialize(gross_amount_decimal: nil)
|
||
@gross_amount_decimal = gross_amount_decimal
|
||
end
|
||
end
|
||
|
||
class NonFuel < Stripe::RequestParams
|
||
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
|
||
attr_accessor :gross_amount_decimal
|
||
|
||
def initialize(gross_amount_decimal: nil)
|
||
@gross_amount_decimal = gross_amount_decimal
|
||
end
|
||
end
|
||
|
||
class Tax < Stripe::RequestParams
|
||
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||
attr_accessor :local_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.
|
||
attr_accessor :national_amount_decimal
|
||
|
||
def initialize(local_amount_decimal: nil, national_amount_decimal: nil)
|
||
@local_amount_decimal = local_amount_decimal
|
||
@national_amount_decimal = national_amount_decimal
|
||
end
|
||
end
|
||
# Breakdown of fuel portion of the purchase.
|
||
attr_accessor :fuel
|
||
# Breakdown of non-fuel portion of the purchase.
|
||
attr_accessor :non_fuel
|
||
# Information about tax included in this transaction.
|
||
attr_accessor :tax
|
||
|
||
def initialize(fuel: nil, non_fuel: nil, tax: nil)
|
||
@fuel = fuel
|
||
@non_fuel = non_fuel
|
||
@tax = tax
|
||
end
|
||
end
|
||
# 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.
|
||
attr_accessor :cardholder_prompt_data
|
||
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
|
||
attr_accessor :purchase_type
|
||
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
|
||
attr_accessor :reported_breakdown
|
||
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
|
||
attr_accessor :service_type
|
||
|
||
def initialize(
|
||
cardholder_prompt_data: nil,
|
||
purchase_type: nil,
|
||
reported_breakdown: nil,
|
||
service_type: nil
|
||
)
|
||
@cardholder_prompt_data = cardholder_prompt_data
|
||
@purchase_type = purchase_type
|
||
@reported_breakdown = reported_breakdown
|
||
@service_type = service_type
|
||
end
|
||
end
|
||
|
||
class Flight < Stripe::RequestParams
|
||
class Segment < Stripe::RequestParams
|
||
# The three-letter IATA airport code of the flight's destination.
|
||
attr_accessor :arrival_airport_code
|
||
# The airline carrier code.
|
||
attr_accessor :carrier
|
||
# The three-letter IATA airport code that the flight departed from.
|
||
attr_accessor :departure_airport_code
|
||
# The flight number.
|
||
attr_accessor :flight_number
|
||
# The flight's service class.
|
||
attr_accessor :service_class
|
||
# Whether a stopover is allowed on this flight.
|
||
attr_accessor :stopover_allowed
|
||
|
||
def initialize(
|
||
arrival_airport_code: nil,
|
||
carrier: nil,
|
||
departure_airport_code: nil,
|
||
flight_number: nil,
|
||
service_class: nil,
|
||
stopover_allowed: nil
|
||
)
|
||
@arrival_airport_code = arrival_airport_code
|
||
@carrier = carrier
|
||
@departure_airport_code = departure_airport_code
|
||
@flight_number = flight_number
|
||
@service_class = service_class
|
||
@stopover_allowed = stopover_allowed
|
||
end
|
||
end
|
||
# The time that the flight departed.
|
||
attr_accessor :departure_at
|
||
# The name of the passenger.
|
||
attr_accessor :passenger_name
|
||
# Whether the ticket is refundable.
|
||
attr_accessor :refundable
|
||
# The legs of the trip.
|
||
attr_accessor :segments
|
||
# The travel agency that issued the ticket.
|
||
attr_accessor :travel_agency
|
||
|
||
def initialize(
|
||
departure_at: nil,
|
||
passenger_name: nil,
|
||
refundable: nil,
|
||
segments: nil,
|
||
travel_agency: nil
|
||
)
|
||
@departure_at = departure_at
|
||
@passenger_name = passenger_name
|
||
@refundable = refundable
|
||
@segments = segments
|
||
@travel_agency = travel_agency
|
||
end
|
||
end
|
||
|
||
class Fuel < Stripe::RequestParams
|
||
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
|
||
attr_accessor :industry_product_code
|
||
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
|
||
attr_accessor :quantity_decimal
|
||
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
|
||
attr_accessor :type
|
||
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
|
||
attr_accessor :unit
|
||
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
|
||
attr_accessor :unit_cost_decimal
|
||
|
||
def initialize(
|
||
industry_product_code: nil,
|
||
quantity_decimal: nil,
|
||
type: nil,
|
||
unit: nil,
|
||
unit_cost_decimal: nil
|
||
)
|
||
@industry_product_code = industry_product_code
|
||
@quantity_decimal = quantity_decimal
|
||
@type = type
|
||
@unit = unit
|
||
@unit_cost_decimal = unit_cost_decimal
|
||
end
|
||
end
|
||
|
||
class Lodging < Stripe::RequestParams
|
||
# The time of checking into the lodging.
|
||
attr_accessor :check_in_at
|
||
# The number of nights stayed at the lodging.
|
||
attr_accessor :nights
|
||
|
||
def initialize(check_in_at: nil, nights: nil)
|
||
@check_in_at = check_in_at
|
||
@nights = nights
|
||
end
|
||
end
|
||
|
||
class Receipt < Stripe::RequestParams
|
||
# Attribute for param field description
|
||
attr_accessor :description
|
||
# Attribute for param field quantity
|
||
attr_accessor :quantity
|
||
# Attribute for param field total
|
||
attr_accessor :total
|
||
# Attribute for param field unit_cost
|
||
attr_accessor :unit_cost
|
||
|
||
def initialize(description: nil, quantity: nil, total: nil, unit_cost: nil)
|
||
@description = description
|
||
@quantity = quantity
|
||
@total = total
|
||
@unit_cost = unit_cost
|
||
end
|
||
end
|
||
# Fleet-specific information for transactions using Fleet cards.
|
||
attr_accessor :fleet
|
||
# Information about the flight that was purchased with this transaction.
|
||
attr_accessor :flight
|
||
# Information about fuel that was purchased with this transaction.
|
||
attr_accessor :fuel
|
||
# Information about lodging that was purchased with this transaction.
|
||
attr_accessor :lodging
|
||
# The line items in the purchase.
|
||
attr_accessor :receipt
|
||
# A merchant-specific order number.
|
||
attr_accessor :reference
|
||
|
||
def initialize(
|
||
fleet: nil,
|
||
flight: nil,
|
||
fuel: nil,
|
||
lodging: nil,
|
||
receipt: nil,
|
||
reference: nil
|
||
)
|
||
@fleet = fleet
|
||
@flight = flight
|
||
@fuel = fuel
|
||
@lodging = lodging
|
||
@receipt = receipt
|
||
@reference = reference
|
||
end
|
||
end
|
||
# 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](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_accessor :capture_amount
|
||
# Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.
|
||
attr_accessor :close_authorization
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# Additional purchase information that is optionally provided by the merchant.
|
||
attr_accessor :purchase_details
|
||
|
||
def initialize(
|
||
capture_amount: nil,
|
||
close_authorization: nil,
|
||
expand: nil,
|
||
purchase_details: nil
|
||
)
|
||
@capture_amount = capture_amount
|
||
@close_authorization = close_authorization
|
||
@expand = expand
|
||
@purchase_details = purchase_details
|
||
end
|
||
end
|
||
|
||
class ExpireParams < Stripe::RequestParams
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
|
||
def initialize(expand: nil)
|
||
@expand = expand
|
||
end
|
||
end
|
||
|
||
class FinalizeAmountParams < Stripe::RequestParams
|
||
class Fleet < Stripe::RequestParams
|
||
class CardholderPromptData < Stripe::RequestParams
|
||
# Driver ID.
|
||
attr_accessor :driver_id
|
||
# Odometer reading.
|
||
attr_accessor :odometer
|
||
# 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.
|
||
attr_accessor :unspecified_id
|
||
# User ID.
|
||
attr_accessor :user_id
|
||
# Vehicle number.
|
||
attr_accessor :vehicle_number
|
||
|
||
def initialize(
|
||
driver_id: nil,
|
||
odometer: nil,
|
||
unspecified_id: nil,
|
||
user_id: nil,
|
||
vehicle_number: nil
|
||
)
|
||
@driver_id = driver_id
|
||
@odometer = odometer
|
||
@unspecified_id = unspecified_id
|
||
@user_id = user_id
|
||
@vehicle_number = vehicle_number
|
||
end
|
||
end
|
||
|
||
class ReportedBreakdown < Stripe::RequestParams
|
||
class Fuel < Stripe::RequestParams
|
||
# Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
|
||
attr_accessor :gross_amount_decimal
|
||
|
||
def initialize(gross_amount_decimal: nil)
|
||
@gross_amount_decimal = gross_amount_decimal
|
||
end
|
||
end
|
||
|
||
class NonFuel < Stripe::RequestParams
|
||
# Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
|
||
attr_accessor :gross_amount_decimal
|
||
|
||
def initialize(gross_amount_decimal: nil)
|
||
@gross_amount_decimal = gross_amount_decimal
|
||
end
|
||
end
|
||
|
||
class Tax < Stripe::RequestParams
|
||
# Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||
attr_accessor :local_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.
|
||
attr_accessor :national_amount_decimal
|
||
|
||
def initialize(local_amount_decimal: nil, national_amount_decimal: nil)
|
||
@local_amount_decimal = local_amount_decimal
|
||
@national_amount_decimal = national_amount_decimal
|
||
end
|
||
end
|
||
# Breakdown of fuel portion of the purchase.
|
||
attr_accessor :fuel
|
||
# Breakdown of non-fuel portion of the purchase.
|
||
attr_accessor :non_fuel
|
||
# Information about tax included in this transaction.
|
||
attr_accessor :tax
|
||
|
||
def initialize(fuel: nil, non_fuel: nil, tax: nil)
|
||
@fuel = fuel
|
||
@non_fuel = non_fuel
|
||
@tax = tax
|
||
end
|
||
end
|
||
# 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.
|
||
attr_accessor :cardholder_prompt_data
|
||
# The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
|
||
attr_accessor :purchase_type
|
||
# More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
|
||
attr_accessor :reported_breakdown
|
||
# The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
|
||
attr_accessor :service_type
|
||
|
||
def initialize(
|
||
cardholder_prompt_data: nil,
|
||
purchase_type: nil,
|
||
reported_breakdown: nil,
|
||
service_type: nil
|
||
)
|
||
@cardholder_prompt_data = cardholder_prompt_data
|
||
@purchase_type = purchase_type
|
||
@reported_breakdown = reported_breakdown
|
||
@service_type = service_type
|
||
end
|
||
end
|
||
|
||
class Fuel < Stripe::RequestParams
|
||
# [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
|
||
attr_accessor :industry_product_code
|
||
# The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
|
||
attr_accessor :quantity_decimal
|
||
# The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
|
||
attr_accessor :type
|
||
# The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
|
||
attr_accessor :unit
|
||
# The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
|
||
attr_accessor :unit_cost_decimal
|
||
|
||
def initialize(
|
||
industry_product_code: nil,
|
||
quantity_decimal: nil,
|
||
type: nil,
|
||
unit: nil,
|
||
unit_cost_decimal: nil
|
||
)
|
||
@industry_product_code = industry_product_code
|
||
@quantity_decimal = quantity_decimal
|
||
@type = type
|
||
@unit = unit
|
||
@unit_cost_decimal = unit_cost_decimal
|
||
end
|
||
end
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# 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).
|
||
attr_accessor :final_amount
|
||
# Fleet-specific information for authorizations using Fleet cards.
|
||
attr_accessor :fleet
|
||
# Information about fuel that was purchased with this transaction.
|
||
attr_accessor :fuel
|
||
|
||
def initialize(expand: nil, final_amount: nil, fleet: nil, fuel: nil)
|
||
@expand = expand
|
||
@final_amount = final_amount
|
||
@fleet = fleet
|
||
@fuel = fuel
|
||
end
|
||
end
|
||
|
||
class RespondParams < Stripe::RequestParams
|
||
# Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false).
|
||
attr_accessor :confirmed
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
|
||
def initialize(confirmed: nil, expand: nil)
|
||
@confirmed = confirmed
|
||
@expand = expand
|
||
end
|
||
end
|
||
|
||
class IncrementParams < Stripe::RequestParams
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_accessor :increment_amount
|
||
# 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.
|
||
attr_accessor :is_amount_controllable
|
||
|
||
def initialize(expand: nil, increment_amount: nil, is_amount_controllable: nil)
|
||
@expand = expand
|
||
@increment_amount = increment_amount
|
||
@is_amount_controllable = is_amount_controllable
|
||
end
|
||
end
|
||
|
||
class ReverseParams < Stripe::RequestParams
|
||
# Specifies which fields in the response should be expanded.
|
||
attr_accessor :expand
|
||
# The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_accessor :reverse_amount
|
||
|
||
def initialize(expand: nil, reverse_amount: nil)
|
||
@expand = expand
|
||
@reverse_amount = reverse_amount
|
||
end
|
||
end
|
||
# The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.
|
||
attr_reader :amount
|
||
# Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||
attr_reader :amount_details
|
||
# Whether the authorization has been approved.
|
||
attr_reader :approved
|
||
# How the card details were provided.
|
||
attr_reader :authorization_method
|
||
# List of balance transactions associated with this authorization.
|
||
attr_reader :balance_transactions
|
||
# You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders.
|
||
attr_reader :card
|
||
# The cardholder to whom this authorization belongs.
|
||
attr_reader :cardholder
|
||
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
||
attr_reader :created
|
||
# 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).
|
||
attr_reader :currency
|
||
# Fleet-specific information for authorizations using Fleet cards.
|
||
attr_reader :fleet
|
||
# Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.
|
||
attr_reader :fraud_challenges
|
||
# 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.
|
||
attr_reader :fuel
|
||
# Unique identifier for the object.
|
||
attr_reader :id
|
||
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
||
attr_reader :livemode
|
||
# The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.
|
||
attr_reader :merchant_amount
|
||
# The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
||
attr_reader :merchant_currency
|
||
# Attribute for field merchant_data
|
||
attr_reader :merchant_data
|
||
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
||
attr_reader :metadata
|
||
# Details about the authorization, such as identifiers, set by the card network.
|
||
attr_reader :network_data
|
||
# String representing the object's type. Objects of the same type share the same value.
|
||
attr_reader :object
|
||
# The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.
|
||
attr_reader :pending_request
|
||
# History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.
|
||
attr_reader :request_history
|
||
# The current status of the authorization in its lifecycle.
|
||
attr_reader :status
|
||
# [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.
|
||
attr_reader :token
|
||
# List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.
|
||
attr_reader :transactions
|
||
# [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).
|
||
attr_reader :treasury
|
||
# Attribute for field verification_data
|
||
attr_reader :verification_data
|
||
# Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.
|
||
attr_reader :verified_by_fraud_challenge
|
||
# The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
|
||
attr_reader :wallet
|
||
|
||
# [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow.
|
||
# This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
|
||
def approve(params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/issuing/authorizations/%<authorization>s/approve", { authorization: CGI.escape(self["id"]) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
deprecate :approve, :none, 2024, 3
|
||
# [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow.
|
||
# This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
|
||
def self.approve(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/issuing/authorizations/%<authorization>s/approve", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
class << self
|
||
extend Gem::Deprecate
|
||
deprecate :approve, :none, 2024, 3
|
||
end
|
||
|
||
# [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow.
|
||
# This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
|
||
def decline(params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/issuing/authorizations/%<authorization>s/decline", { authorization: CGI.escape(self["id"]) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
deprecate :decline, :none, 2024, 3
|
||
# [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow.
|
||
# This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
|
||
def self.decline(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/issuing/authorizations/%<authorization>s/decline", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
class << self
|
||
extend Gem::Deprecate
|
||
deprecate :decline, :none, 2024, 3
|
||
end
|
||
|
||
# Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
|
||
def self.list(params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :get,
|
||
path: "/v1/issuing/authorizations",
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
||
def self.update(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/issuing/authorizations/%<authorization>s", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
def test_helpers
|
||
TestHelpers.new(self)
|
||
end
|
||
|
||
class TestHelpers < APIResourceTestHelpers
|
||
RESOURCE_CLASS = Authorization
|
||
def self.resource_class
|
||
"Authorization"
|
||
end
|
||
|
||
# Capture a test-mode authorization.
|
||
def self.capture(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/capture", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Capture a test-mode authorization.
|
||
def capture(params = {}, opts = {})
|
||
@resource.request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/capture", { authorization: CGI.escape(@resource["id"]) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Create a test-mode authorization.
|
||
def self.create(params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: "/v1/test_helpers/issuing/authorizations",
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Expire a test-mode Authorization.
|
||
def self.expire(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/expire", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Expire a test-mode Authorization.
|
||
def expire(params = {}, opts = {})
|
||
@resource.request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/expire", { authorization: CGI.escape(@resource["id"]) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
|
||
def self.finalize_amount(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/finalize_amount", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
|
||
def finalize_amount(params = {}, opts = {})
|
||
@resource.request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/finalize_amount", { authorization: CGI.escape(@resource["id"]) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Increment a test-mode Authorization.
|
||
def self.increment(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/increment", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Increment a test-mode Authorization.
|
||
def increment(params = {}, opts = {})
|
||
@resource.request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/increment", { authorization: CGI.escape(@resource["id"]) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.
|
||
def self.respond(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/fraud_challenges/respond", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.
|
||
def respond(params = {}, opts = {})
|
||
@resource.request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/fraud_challenges/respond", { authorization: CGI.escape(@resource["id"]) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Reverse a test-mode Authorization.
|
||
def self.reverse(authorization, params = {}, opts = {})
|
||
request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/reverse", { authorization: CGI.escape(authorization) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
|
||
# Reverse a test-mode Authorization.
|
||
def reverse(params = {}, opts = {})
|
||
@resource.request_stripe_object(
|
||
method: :post,
|
||
path: format("/v1/test_helpers/issuing/authorizations/%<authorization>s/reverse", { authorization: CGI.escape(@resource["id"]) }),
|
||
params: params,
|
||
opts: opts
|
||
)
|
||
end
|
||
end
|
||
|
||
def self.inner_class_types
|
||
@inner_class_types = {
|
||
amount_details: AmountDetails,
|
||
fleet: Fleet,
|
||
fraud_challenges: FraudChallenge,
|
||
fuel: Fuel,
|
||
merchant_data: MerchantData,
|
||
network_data: NetworkData,
|
||
pending_request: PendingRequest,
|
||
request_history: RequestHistory,
|
||
treasury: Treasury,
|
||
verification_data: VerificationData,
|
||
}
|
||
end
|
||
|
||
def self.field_remappings
|
||
@field_remappings = {}
|
||
end
|
||
end
|
||
end
|
||
end
|