exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.Refunds (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_refunds_opts()
get_refunds_refund_opts()

Functions

get_refunds(client, opts \\ [])

description: <p>Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.</p>

get_refunds_refund(client, refund, opts \\ [])

description: <p>Retrieves the details of an existing refund.</p>

post_refunds(client, body)

description: <p>Create a refund.</p>

post_refunds_refund(client, body, refund)

description: <p>Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

post_refunds_refund_cancel(client, body, refund)

description: <p>Cancels a refund with a status of <code>requires_action</code>.</p>

Link to this section Types

Link to this type

get_refunds_opts()

View Source 
@type get_refunds_opts() ::
  {:starting_after, String.t()}
  | {:payment_intent, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
  | {:charge, String.t()}
Link to this type

get_refunds_refund_opts()

View Source 
@type get_refunds_refund_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

get_refunds(client, opts \\ [])

View Source 
@spec get_refunds(client :: ExOAPI.Client.t(), [get_refunds_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Refund.t()]
     }
   | map()}
  | {:error, any()}

description: <p>Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.</p>

Link to this function

get_refunds_refund(client, refund, opts \\ [])

View Source 
@spec get_refunds_refund(
  client :: ExOAPI.Client.t(),
  refund :: String.t(),
  [get_refunds_refund_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Refund.t() | map()}
  | {:error, any()}

description: <p>Retrieves the details of an existing refund.</p>

Link to this function

post_refunds(client, body)

View Source 
@spec post_refunds(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      reverse_transfer: boolean(),
      refund_application_fee: boolean(),
      reason: String.t() | :duplicate | :fraudulent | :requested_by_customer,
      payment_intent: String.t(),
      metadata: String.t() | map(),
      expand: [String.t()],
      charge: String.t(),
      amount: integer()
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Refund.t() | map()}
  | {:error, any()}

description: <p>Create a refund.</p>

Link to this function

post_refunds_refund(client, body, refund)

View Source 
@spec post_refunds_refund(
  client :: ExOAPI.Client.t(),
  body :: %{metadata: String.t() | map(), expand: [String.t()]} | map(),
  refund :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Refund.t() | map()}
  | {:error, any()}

description: <p>Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

This request only accepts metadata as an argument.

Link to this function

post_refunds_refund_cancel(client, body, refund)

View Source 
@spec post_refunds_refund_cancel(
  client :: ExOAPI.Client.t(),
  body :: %{expand: [String.t()]} | map(),
  refund :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Refund.t() | map()}
  | {:error, any()}

description: <p>Cancels a refund with a status of <code>requires_action</code>.</p>

Refunds in other states cannot be canceled, and only refunds for payment methods that require customer action will enter the requires_action state.