stripity_stripe v2.7.0 Stripe.Transfer View Source
Work with Stripe transfer objects.
Stripe API reference: https://stripe.com/docs/api#transfers
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %Stripe.Transfer{
amount: integer(),
amount_reversed: integer(),
balance_transaction: Stripe.id() | Stripe.BalanceTransaction.t(),
created: Stripe.timestamp(),
currency: String.t(),
description: String.t(),
destination: Stripe.id() | Stripe.Account.t(),
destination_payment: String.t(),
id: Stripe.id(),
livemode: boolean(),
metadata: Stripe.Types.metadata(),
object: String.t(),
reversals: Stripe.List.t(Stripe.TransferReversal.t()),
reversed: boolean(),
source_transaction: Stripe.id() | Stripe.Charge.t(),
source_type: String.t(),
transfer_group: String.t()
}
t() :: %Stripe.Transfer{
amount: integer(),
amount_reversed: integer(),
balance_transaction: Stripe.id() | Stripe.BalanceTransaction.t(),
created: Stripe.timestamp(),
currency: String.t(),
description: String.t(),
destination: Stripe.id() | Stripe.Account.t(),
destination_payment: String.t(),
id: Stripe.id(),
livemode: boolean(),
metadata: Stripe.Types.metadata(),
object: String.t(),
reversals: Stripe.List.t(Stripe.TransferReversal.t()),
reversed: boolean(),
source_transaction: Stripe.id() | Stripe.Charge.t(),
source_type: String.t(),
transfer_group: String.t()
}
Link to this section Functions
Link to this function
create(params, opts \\ [])
View Source
create(params, opts \\ [])
View Source
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
:amount => pos_integer(),
:currency => String.t(),
:destination => Stripe.id() | Stripe.Account.t(),
optional(:metadata) => Stripe.Types.metadata(),
optional(:source_transaction) => Stripe.id() | Stripe.Charge.t(),
optional(:transfer_group) => String.t()
}
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ :amount => pos_integer(), :currency => String.t(), :destination => Stripe.id() | Stripe.Account.t(), optional(:metadata) => Stripe.Types.metadata(), optional(:source_transaction) => Stripe.id() | Stripe.Charge.t(), optional(:transfer_group) => String.t() }
Create a transfer.
Link to this function
list(params \\ %{}, opts \\ [])
View Source
list(params \\ %{}, opts \\ [])
View Source
list(params, Stripe.options()) ::
{:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
optional(:created) => Stripe.date_query(),
optional(:destination) => Stripe.id() | Stripe.Account.t(),
optional(:ending_before) => t() | Stripe.id(),
optional(:limit) => 1..100,
optional(:starting_after) => t() | Stripe.id(),
optional(:transfer_group) => String.t()
}
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:created) => Stripe.date_query(), optional(:destination) => Stripe.id() | Stripe.Account.t(), optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:starting_after) => t() | Stripe.id(), optional(:transfer_group) => String.t() }
List all transfers.
Link to this function
retrieve(id, opts \\ [])
View Source
retrieve(id, opts \\ [])
View Source
retrieve(Stripe.id() | t(), Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a transfer.
Link to this function
update(id, params, opts \\ [])
View Source
update(id, params, opts \\ [])
View Source
update(Stripe.id() | t(), params, Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
optional(:description) => String.t(),
optional(:metadata) => Stripe.Types.metadata()
}
update(Stripe.id() | t(), params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ optional(:description) => String.t(), optional(:metadata) => Stripe.Types.metadata() }
Update a transfer.
Takes the id and a map of changes.