Stripe.TransferReversal (stripity_stripe_fb v2.13.1) View Source

Work with Stripe transfer_reversal objects.

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

Link to this section Summary

Types

t()

Functions

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

Create a transfer reversal

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

List all transfers.

retrieve(id, reversal_id, opts \\ [])

Retrieve a transfer reversal.

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

Update a transfer.

Link to this section Types

t()

Specs

t() :: %Stripe.TransferReversal{
  amount: integer(),
  balance_transaction: String.t() | Stripe.BalanceTransaction.t(),
  created: Stripe.timestamp(),
  currency: String.t(),
  description: boolean(),
  destination_payment_refund: Stripe.id() | Stripe.Refund.t() | nil,
  id: Stripe.id(),
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  source_refund: Stripe.id() | Stripe.Refund.t() | nil,
  transfer: Stripe.id() | Stripe.Transfer.t()
}

Link to this section Functions

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

Specs

create(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:amount) => pos_integer(),
       optional(:description) => String.t(),
       optional(:metadata) => Stripe.Types.metadata(),
       optional(:refund_application_fee) => boolean()
     }

Create a transfer reversal

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

Specs

list(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

List all transfers.

retrieve(id, reversal_id, opts \\ [])

Specs

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

Retrieve a transfer reversal.

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

Specs

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

Update a transfer.

Takes the id and a map of changes.