stripity_stripe v2.0.0-alpha.10 Stripe.Charge

Work with Stripe charge objects.

You can:

Capture a charge
Retrieve a charge

Stripe API reference: https://stripe.com/docs/api#charge

Summary

Types

t()

Functions

capture(id, opts \\ [])

Capture a charge

create(changes, opts \\ [])

Create a charge

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

List all charges

retrieve(id, opts \\ [])

Retrieve a charge

Types

t()

t :: %Stripe.Charge{transfer: term, outcome: term, currency: term, amount_refunded: term, dispute: term, failure_message: term, refunds: term, fraud_details: term, metadata: term, status: term, amount: term, failure_code: term, description: term, review: term, order: term, source_transfer: term, receipt_number: term, statement_descriptor: term, source: term, refunded: term, destination: term, receipt_email: term, livemode: term, balance_transaction: term, id: term, application_fee: term, paid: term, captured: term, invoice: term, shipping: term, application: term, created: term, customer: term, object: term}

Functions

capture(id, opts \\ [])

capture(binary, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Capture a charge.

create(changes, opts \\ [])

create(map, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Create a charge.

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

list(map, Keyword.t) ::
  {:ok, Stripe.List.t} |
  {:error, Stripe.api_error_struct}

List all charges.

retrieve(id, opts \\ [])

retrieve(binary, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Retrieve a charge.