exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Issuing_authorization (exoapi_stripe v0.1.4)

description: 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.

:amount :: :integer

The total amount that was authorized or rejected. This amount is in the card's currency and in the smallest currency unit.

:amount_details :: ExOAPI.Stripe.Schemas.IssuingAuthorizationAmountDetails

Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.

:approved :: :boolean

Whether the authorization has been approved.

:authorization_method :: :string

How the card details were provided.

::balance_transactions :: ExOAPI.Stripe.Schemas.BalanceTransaction

:card :: ExOAPI.Stripe.Schemas.Issuing_card

:cardholder :: ExOAPI.Stripe.Schemas.Issuing_cardholder | :string

The cardholder to whom this authorization belongs.

:created :: :integer

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

:currency :: :string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

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

:merchant_amount :: :integer

The total amount that was authorized or rejected. This amount is in the merchant_currency and in the smallest currency unit.

:merchant_currency :: :string

The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.

:merchant_data :: ExOAPI.Stripe.Schemas.IssuingAuthorizationMerchantData

:metadata :: :map

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.

:object :: :string

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

:pending_request :: ExOAPI.Stripe.Schemas.IssuingAuthorizationPendingRequest

The pending authorization request. This field will only be non-null during an issuing_authorization.request webhook.

::request_history :: ExOAPI.Stripe.Schemas.IssuingAuthorizationRequest

:status :: :string

The current status of the authorization in its lifecycle.

::transactions :: ExOAPI.Stripe.Schemas.Issuing_transaction

:verification_data :: ExOAPI.Stripe.Schemas.IssuingAuthorizationVerificationData

:wallet :: :string

The digital wallet used for this authorization. One of apple_pay, google_pay, or samsung_pay.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Issuing_authorization{
  amount: integer() | nil,
  amount_details: ExOAPI.EctoTypes.AnyOf.t() | nil,
  approved: boolean() | nil,
  authorization_method:
    (:swipe | :online | :keyed_in | :contactless | :chip) | nil,
  balance_transactions: [ExOAPI.Stripe.Schemas.BalanceTransaction.t()],
  card: ExOAPI.Stripe.Schemas.Issuing_card.t() | nil,
  cardholder: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  merchant_amount: integer() | nil,
  merchant_currency: String.t() | nil,
  merchant_data:
    ExOAPI.Stripe.Schemas.IssuingAuthorizationMerchantData.t() | nil,
  metadata: map() | nil,
  object: :"issuing.authorization" | nil,
  pending_request: ExOAPI.EctoTypes.AnyOf.t() | nil,
  request_history: [ExOAPI.Stripe.Schemas.IssuingAuthorizationRequest.t()],
  status: (:reversed | :pending | :closed) | nil,
  transactions: [ExOAPI.Stripe.Schemas.Issuing_transaction.t()],
  verification_data:
    ExOAPI.Stripe.Schemas.IssuingAuthorizationVerificationData.t() | nil,
  wallet: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()