Stripe.Transfer (stripity_stripe v2.17.2) View Source

Work with Stripe transfer objects.

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

Link to this section Summary

Types

t()

Functions

create(params, opts \\ [])

Create a transfer.

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

List all transfers.

retrieve(id, opts \\ [])

Retrieve a transfer.

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

Update a transfer.

Link to this section Types

t()

Specs

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

create(params, opts \\ [])

Specs

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(),
       optional(:description) => String.t(),
       optional(:source_type) => String.t()
     }

Create a transfer.

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

Specs

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.

retrieve(id, opts \\ [])

Specs

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

Retrieve a transfer.

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

Specs

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.