stripity_stripe

stripity_stripe v2.7.0 Stripe.Charge View Source

Work with Stripe charge objects.

You can:

Link to this section Summary

Types

billing_details()
card_info()
charge_outcome()
charge_outcome_rule()
stripe_fraud_report()
t()
transfer_data()
user_fraud_report()

Functions

capture(id)
capture(id, opts)

[DEPRECATED] Capture a charge.

capture(id, params, opts)

Capture a charge.

create(params, opts \\ [])

Create a charge.

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

List all charges.

retrieve(id, opts \\ [])

Retrieve a charge.

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

Update a charge.

Link to this section Types

Link to this type

billing_details() View Source 
billing_details() :: %{
  email: String.t(),
  address: String.t() | nil,
  name: String.t(),
  phone: String.t() | nil
}

Link to this type

card_info() View Source 
card_info() :: %{
  exp_month: number(),
  exp_year: number(),
  number: String.t(),
  object: String.t(),
  cvc: String.t(),
  address_city: String.t() | nil,
  address_country: String.t() | nil,
  address_line1: String.t() | nil,
  address_line2: String.t() | nil,
  name: String.t() | nil,
  address_state: String.t() | nil,
  address_zip: String.t() | nil
}

Link to this type

charge_outcome() View Source 
charge_outcome() :: %{
  network_status: String.t() | nil,
  reason: String.t() | nil,
  risk_level: String.t(),
  rule: Stripe.id() | charge_outcome_rule(),
  seller_message: String.t() | nil,
  type: String.t()
}

Link to this type

charge_outcome_rule() View Source 
charge_outcome_rule() :: %{
  action: String.t(),
  id: String.t(),
  predicate: String.t()
}

Link to this type

stripe_fraud_report() View Source 
stripe_fraud_report() :: %{stripe_report: String.t()}

Link to this type

t() View Source 
t() :: %Stripe.Charge{
  amount: non_neg_integer(),
  amount_refunded: non_neg_integer(),
  application: Stripe.id() | nil,
  application_fee: Stripe.id() | Stripe.ApplicationFee.t() | nil,
  application_fee_amount: Stripe.id() | Stripe.ApplicationFee.t() | nil,
  balance_transaction: Stripe.id() | Stripe.BalanceTransaction.t() | nil,
  billing_details: billing_details() | nil,
  captured: boolean(),
  created: Stripe.timestamp(),
  currency: String.t(),
  customer: Stripe.id() | Stripe.Customer.t() | nil,
  description: String.t() | nil,
  dispute: Stripe.id() | Stripe.Dispute.t() | nil,
  failure_code: Stripe.Error.card_error_code() | nil,
  failure_message: String.t() | nil,
  fraud_details: user_fraud_report() | stripe_fraud_report() | %{},
  id: Stripe.id(),
  invoice: Stripe.id() | Stripe.Invoice.t() | nil,
  livemode: boolean(),
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  on_behalf_of: Stripe.id() | Stripe.Account.t() | nil,
  order: Stripe.id() | Stripe.Order.t() | nil,
  outcome: charge_outcome() | nil,
  paid: boolean(),
  payment_intent: Stripe.id() | Stripe.PaymentIntent.t() | nil,
  payment_method: Stripe.id() | Stripe.PaymentMethod.t() | nil,
  payment_method_details: map(),
  receipt_email: String.t() | nil,
  receipt_number: String.t() | nil,
  receipt_url: String.t() | nil,
  refunded: boolean(),
  refunds: Stripe.List.t(Stripe.Refund.t()),
  review: Stripe.id() | Stripe.Review.t() | nil,
  shipping: Stripe.Types.shipping() | nil,
  source: Stripe.Card.t() | map(),
  source_transfer: Stripe.id() | Stripe.Transfer.t() | nil,
  statement_descriptor: String.t() | nil,
  status: String.t(),
  transfer: Stripe.id() | Stripe.Transfer.t() | nil,
  transfer_data: transfer_data() | nil,
  transfer_group: String.t() | nil
}

Link to this type

transfer_data() View Source 
transfer_data() :: %{amount: non_neg_integer(), destination: String.t()}

Link to this type

user_fraud_report() View Source 
user_fraud_report() :: %{user_report: String.t()}

Link to this section Functions

Link to this function

capture(id) View Source 
capture(Stripe.id() | t()) :: {:ok, t()} | {:error, Stripe.Error.t()}

Link to this function

capture(id, opts) View Source 
capture(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
capture(Stripe.id() | t(), map()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

[DEPRECATED] Capture a charge.

This version of the function is deprecated. Please use capture/3 instead.

Link to this function

capture(id, params, opts) View Source 
capture(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:amount) => non_neg_integer(),
       optional(:application_fee_amount) => non_neg_integer(),
       optional(:receipt_email) => String.t(),
       optional(:statement_descriptor) => String.t(),
       optional(:transfer_data) => transfer_data(),
       optional(:transfer_group) => String.t()
     }

Capture a charge.

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

See the Stripe docs.

Link to this function

create(params, opts \\ []) View Source 
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         :amount => pos_integer(),
         :currency => String.t(),
         optional(:application_fee_amount) => non_neg_integer(),
         optional(:capture) => boolean(),
         optional(:customer) => Stripe.id() | Stripe.Customer.t(),
         optional(:description) => String.t(),
         optional(:on_behalf_of) => Stripe.id() | Stripe.Account.t(),
         optional(:metadata) => map(),
         optional(:receipt_email) => String.t(),
         optional(:shipping) => Stripe.Types.shipping(),
         optional(:source) => Stripe.id() | Stripe.Card.t() | card_info(),
         optional(:statement_descriptor) => String.t(),
         optional(:transfer_data) => transfer_data(),
         optional(:transfer_group) => String.t()
       }
       | %{}

Create a charge.

If your API key is in test mode, the supplied payment source (e.g., card) won't actually be charged, though everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

See the Stripe docs.

Link to this function

list(params \\ %{}, opts \\ []) View Source 
list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       optional(:created) => Stripe.date_query(),
       optional(:customer) => Stripe.Customer.t() | Stripe.id(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:source) => %{optional(:object) => String.t()},
       optional(:starting_after) => t() | Stripe.id(),
       optional(:transfer_group) => String.t()
     }

List all charges.

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

See the Stripe docs.

Link to this function

retrieve(id, opts \\ []) View Source 
retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a charge.

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

See the Stripe docs.

Link to this function

update(id, params, opts \\ []) View Source 
update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:customer) => Stripe.id() | Stripe.Customer.t(),
         optional(:description) => String.t(),
         optional(:fraud_details) => user_fraud_report(),
         optional(:metadata) => Stripe.Types.metadata(),
         optional(:receipt_email) => String.t(),
         optional(:shipping) => Stripe.Types.shipping(),
         optional(:transfer_group) => String.t()
       }
       | %{}

Update a charge.

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts only the :description, :metadata, :receipt_email, :fraud_details, and :shipping as arguments, as well as :transfer_group in some cases.

The charge to be updated may either be passed in as a struct or an ID.

See the Stripe docs.

Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/ or s
Focus search bar
?
Bring up this help dialog