stripity_stripe v2.2.0 Stripe.TransferReversal View Source
Work with Stripe transfer_reversal objects.
Stripe API reference: https://stripe.com/docs/api#transfer_reversal_object
Link to this section Summary
Functions
Create a transfer reversal
List all transfers
Retrieve a transfer reversal
Update a transfer
Link to this section Types
Link to this type
t()
View Source
t() :: %Stripe.TransferReversal{ amount: integer(), balance_transaction: String.t() | Stripe.BalanceTransaction.t(), created: Stripe.timestamp(), currency: String.t(), description: boolean(), id: Stripe.id(), metadata: Stripe.Types.metadata(), object: String.t(), transfer: Stripe.id() | Stripe.Transfer.t() }
Link to this section Functions
Link to this function
create(id, params, opts \\ [])
View Source
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
Link to this function
list(id, params \\ %{}, opts \\ [])
View Source
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.
Link to this function
retrieve(id, reversal_id, opts \\ [])
View Source
retrieve(Stripe.id() | t(), Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a transfer reversal.
Link to this function
update(id, reversal_id, params, opts \\ [])
View Source
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.