Stripe.Resources.Issuing.Authorization (tiger_stripe v0.1.10)

IssuingAuthorization

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

Summary

Types

t()

Functions

expandable_fields()

object_name()

Types

t()

@type t() :: %Stripe.Resources.Issuing.Authorization{
  amount: integer(),
  amount_details: Stripe.Resources.Issuing.Authorization.AmountDetails.t(),
  approved: boolean(),
  authorization_method: String.t(),
  balance_transactions: [Stripe.Resources.BalanceTransaction.t()],
  card: Stripe.Resources.Issuing.Card.t(),
  cardholder: String.t() | Stripe.Resources.Issuing.Cardholder.t(),
  created: integer(),
  currency: String.t(),
  fleet: Stripe.Resources.Issuing.Authorization.Fleet.t(),
  fraud_challenges:
    [Stripe.Resources.Issuing.Authorization.FraudChallenges.t()] | nil,
  fuel: Stripe.Resources.Issuing.Authorization.Fuel.t(),
  id: String.t(),
  livemode: boolean(),
  merchant_amount: integer(),
  merchant_currency: String.t(),
  merchant_data: Stripe.Resources.Issuing.Authorization.MerchantData.t(),
  metadata: %{required(String.t()) => String.t()},
  network_data: Stripe.Resources.Issuing.Authorization.NetworkData.t(),
  object: String.t(),
  pending_request: Stripe.Resources.Issuing.Authorization.PendingRequest.t(),
  request_history: [Stripe.Resources.Issuing.Authorization.RequestHistory.t()],
  status: String.t(),
  token: String.t() | Stripe.Resources.Issuing.Token.t() | nil,
  transactions: [Stripe.Resources.Issuing.Transaction.t()],
  treasury: Stripe.Resources.Issuing.Authorization.Treasury.t() | nil,
  verification_data:
    Stripe.Resources.Issuing.Authorization.VerificationData.t(),
  verified_by_fraud_challenge: boolean(),
  wallet: String.t()
}

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.
amount_details - Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit. Nullable. Expandable.
approved - Whether the authorization has been approved.
authorization_method - How the card details were provided. Possible values: chip, contactless, keyed_in, online, swipe.
balance_transactions - List of balance transactions associated with this authorization. Expandable.
card - Expandable.
cardholder - The cardholder to whom this authorization belongs. Nullable. Expandable.
created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
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. Format: ISO 4217 currency code.
fleet - Fleet-specific information for authorizations using Fleet cards. Nullable. Expandable.
fraud_challenges - Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. Nullable. Expandable.
fuel - 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. Expandable.
id - Unique identifier for the object. Max length: 5000.
livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
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.
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. Format: ISO 4217 currency code.
merchant_data - Expandable.
metadata - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
network_data - Details about the authorization, such as identifiers, set by the card network. Nullable. Expandable.
object - String representing the object's type. Objects of the same type share the same value. Possible values: issuing.authorization.
pending_request - The pending authorization request. This field will only be non-null during an issuing_authorization.request webhook. Nullable. Expandable.
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. Expandable.
status - The current status of the authorization in its lifecycle. Possible values: closed, expired, pending, reversed.
token - Token object used for this authorization. If a network token was not used for this authorization, this field will be null. Nullable. Expandable.
transactions - List of transactions associated with this authorization. Expandable.
treasury - Treasury details related to this authorization if it was created on a FinancialAccount. Nullable. Expandable.
verification_data - Expandable.
verified_by_fraud_challenge - 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. Nullable.
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. Max length: 5000. Nullable.