stripity_stripe v2.0.0-alpha.11 Stripe.Refund

Work with Stripe refund objects.

You can:

  • Create a refund
  • Retrieve a refund
  • Update a refund

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

Summary

Types

t()
t :: %Stripe.Refund{amount: term, balance_transaction: term, charge: term, created: term, currency: term, id: term, metadata: term, object: term, reason: term, receipt_number: term, status: term}

Functions

create(changes, opts \\ [])
create(map, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Create a refund.

list(params \\ %{}, opts \\ [])
list(map, Keyword.t) ::
  {:ok, Stripe.List.t} |
  {:error, Stripe.api_error_struct}

List all refunds.

retrieve(id, opts \\ [])
retrieve(binary, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Retrieve a refund

update(id, changes, opts \\ [])
update(binary, map, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Update a refund