Stripe.Issuing.Authorization (stripity_stripe v2.17.3) View Source

pending_request() :: %{
  amount: integer(),
  currency: String.t(),
  is_amount_controllable: boolean(),
  merchant_amount: integer(),
  merchant_currency: String.t()
}

request_history()

Specs

request_history() :: %{
  approved: boolean(),
  authorized_amount: integer(),
  authorized_currency: String.t(),
  created: Stripe.timestamp(),
  held_amount: integer(),
  held_currency: String.t(),
  reason: String.t()
}

t()

Specs

t() :: %Stripe.Issuing.Authorization{
  amount: integer(),
  approved: boolean(),
  authorization_method: String.t(),
  balance_transactions: Stripe.List.t(Stripe.BalanceTransaction.t()),
  card: Stripe.Issuing.Card.t(),
  cardholder: Stripe.id() | Stripe.Issuing.Cardholder.t(),
  created: Stripe.timestamp(),
  currency: String.t(),
  id: Stripe.id(),
  livemode: boolean(),
  merchant_amount: integer(),
  merchant_currency: String.t(),
  merchant_data: Stripe.Issuing.Types.merchant_data(),
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  pending_request: pending_request() | nil,
  request_history: Stripe.List.t(request_history()),
  status: String.t(),
  transactions: Stripe.List.t(Stripe.Issuing.Transaction.t()),
  verification_data: verification_data(),
  wallet: String.t() | nil
}

verification_data()

Specs

verification_data() :: %{
  address_line1_check: String.t(),
  address_zip_check: String.t(),
  cvc_check: String.t()
}

Link to this section Functions

approve(id, params \\ %{}, opts \\ [])

Specs

approve(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{optional(:held_amount) => non_neg_integer()} | %{}

Approve an authorization.

decline(id, opts \\ [])

Specs

decline(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Decline an authorization.

list(params \\ %{}, opts \\ [])

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:card) => Stripe.Issuing.Card.t() | Stripe.id(),
         optional(:cardholder) => Stripe.Issuing.Cardholder.t() | Stripe.id(),
         optional(:created) => String.t() | Stripe.date_query(),
         optional(:ending_before) => t() | Stripe.id(),
         optional(:limit) => 1..100,
         optional(:starting_after) => t() | Stripe.id(),
         optional(:status) => String.t()
       }
       | %{}

List all authorizations.

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve an authorization.

update(id, params, opts \\ [])

Specs

update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{optional(:metadata) => Stripe.Types.metadata()} | %{}

Update an authorization.