class

Stripe::IssuingAuthorization

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

When an issued card is used to make a purchase, an Issuing Authorization object is created. Authorizations must be approved for the purchase to be completed successfully. Related guide: Issued card authorizations

Constants

ERROR_MESSAGE_FOR_AUTHORIZATION_METHOD = "invalid value for \"authorization_method\", must be one of [chip, contactless, keyed_in, online, swipe]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [issuing.authorization]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [closed, pending, reversed]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_WALLET = 5000
VALID_VALUES_FOR_AUTHORIZATION_METHOD = String.static_array("chip", "contactless", "keyed_in", "online", "swipe")
VALID_VALUES_FOR_OBJECT = String.static_array("issuing.authorization")
VALID_VALUES_FOR_STATUS = String.static_array("closed", "pending", "reversed")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, amount_details : Stripe::IssuingAuthorizationAmountDetails1 | Nil = nil, approved : Bool | Nil = nil, authorization_method : String | Nil = nil, balance_transactions : Array(Stripe::BalanceTransaction) | Nil = nil, card : Stripe::IssuingCard | Nil = nil, cardholder : Stripe::IssuingAuthorizationCardholder | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, fleet : Stripe::IssuingAuthorizationFleet | Nil = nil, fuel : Stripe::IssuingAuthorizationFuel | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, merchant_amount : Int64 | Nil = nil, merchant_currency : String | Nil = nil, merchant_data : Stripe::IssuingAuthorizationMerchantData | Nil = nil, metadata : Hash(String, String) | Nil = nil, network_data : Stripe::IssuingAuthorizationNetworkData1 | Nil = nil, object : String | Nil = nil, pending_request : Stripe::IssuingAuthorizationPendingRequest1 | Nil = nil, request_history : Array(Stripe::IssuingAuthorizationRequest) | Nil = nil, status : String | Nil = nil, transactions : Array(Stripe::IssuingTransaction) | Nil = nil, verification_data : Stripe::IssuingAuthorizationVerificationData | Nil = nil, wallet : String | Nil = nil, token : Stripe::IssuingAuthorizationToken | Nil = nil, treasury : Stripe::IssuingAuthorizationTreasury1 | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

amount

The total amount that was authorized or rejected. This amount is in currency and in the smallest currency unit. amount should be the same as merchant_amount, unless currency and merchant_currency are different.

Source
amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned

Source
amount_details
Source
amount_details=(new_value : Stripe::IssuingAuthorizationAmountDetails1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount_details Object to be assigned

Source
approved

Whether the authorization has been approved.

Source
approved=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] approved Object to be assigned

Source
authorization_method

How the card details were provided.

Source
authorization_method=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] authorization_method Object to be assigned

Source
balance_transactions

List of balance transactions associated with this authorization.

Source
balance_transactions=(new_value : Array(Stripe::BalanceTransaction) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] balance_transactions Object to be assigned

Source
card
Source
card=(new_value : Stripe::IssuingCard | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] card Object to be assigned

Source
cardholder
Source
cardholder=(new_value : Stripe::IssuingAuthorizationCardholder | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cardholder Object to be assigned

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
currency

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, in lowercase. Must be a supported currency.

Source
currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

Source
fleet
Source
fleet=(new_value : Stripe::IssuingAuthorizationFleet | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] fleet Object to be assigned

Source
fuel
Source
fuel=(new_value : Stripe::IssuingAuthorizationFuel | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] fuel Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
merchant_amount

The total amount that was authorized or rejected. This amount is in the merchant_currency and in the smallest currency unit. merchant_amount should be the same as amount, unless merchant_currency and currency are different.

Source
merchant_amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] merchant_amount Object to be assigned

Source
merchant_currency

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, in lowercase. Must be a supported currency.

Source
merchant_currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] merchant_currency Object to be assigned

Source
merchant_data
Source
merchant_data=(new_value : Stripe::IssuingAuthorizationMerchantData | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] merchant_data Object to be assigned

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
network_data
Source
network_data=(new_value : Stripe::IssuingAuthorizationNetworkData1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] network_data Object to be assigned

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
pending_request
Source
pending_request=(new_value : Stripe::IssuingAuthorizationPendingRequest1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] pending_request Object to be assigned

Source
request_history

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.

Source
request_history=(new_value : Array(Stripe::IssuingAuthorizationRequest) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_history Object to be assigned

Source
status

The current status of the authorization in its lifecycle.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
token
Source
token=(new_value : Stripe::IssuingAuthorizationToken | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] token Object to be assigned

Source
token_present=(token_present : Bool)
Source
token_present?
Source
transactions

List of transactions associated with this authorization.

Source
transactions=(new_value : Array(Stripe::IssuingTransaction) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transactions Object to be assigned

Source
treasury
Source
treasury=(new_value : Stripe::IssuingAuthorizationTreasury1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] treasury Object to be assigned

Source
treasury_present=(treasury_present : Bool)
Source
treasury_present?
Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source
verification_data
Source
verification_data=(new_value : Stripe::IssuingAuthorizationVerificationData | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] verification_data Object to be assigned

Source
wallet

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.

Source
wallet=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] wallet Object to be assigned

Source