Striped v0.5.0

View Source Stripe.Transfer (Striped v0.5.0) (generated)

A Transfer object is created when you move funds between Stripe accounts as part of Connect.

Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more information, read about the transfer/payout split.

Related guide: Creating Separate Charges and Transfers.

Link to this section Summary

Types

created()
t()

The transfer type.

Functions

create(client, params \\ %{}, opts \\ [])

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

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

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

retrieve(client, transfer, params \\ %{}, opts \\ [])

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

update(client, transfer, params \\ %{}, opts \\ [])

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Link to this section Types

Link to this type

created()

View Source 
@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

t()

View Source 
@type t() :: %Stripe.Transfer{
  amount: integer(),
  amount_reversed: integer(),
  balance_transaction: (binary() | Stripe.BalanceTransaction.t()) | nil,
  created: integer(),
  currency: binary(),
  description: binary() | nil,
  destination: (binary() | Stripe.Account.t()) | nil,
  destination_payment: binary() | Stripe.Charge.t(),
  id: binary(),
  livemode: boolean(),
  metadata: term(),
  object: binary(),
  reversals: term(),
  reversed: boolean(),
  source_transaction: (binary() | Stripe.Charge.t()) | nil,
  source_type: binary(),
  transfer_group: binary() | nil
}

The transfer type.

  • amount Amount in %s to be transferred.
  • amount_reversed Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
  • balance_transaction Balance transaction that describes the impact of this transfer on your account balance.
  • created Time that this record of the transfer was first created.
  • currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
  • description An arbitrary string attached to the object. Often useful for displaying to users.
  • destination ID of the Stripe account the transfer was sent to.
  • destination_payment If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
  • id Unique identifier for the object.
  • livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
  • object String representing the object's type. Objects of the same type share the same value.
  • reversals A list of reversals that have been applied to the transfer.
  • reversed Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
  • source_transaction ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.
  • source_type The source balance this transfer came from. One of card, fpx, or bank_account.
  • transfer_group A string that identifies this transaction as part of a group. See the Connect documentation for details.

Link to this section Functions

Link to this function

create(client, params \\ %{}, opts \\ [])

View Source 
@spec create(
  client :: Stripe.t(),
  params :: %{
    optional(:amount) => integer(),
    optional(:currency) => binary(),
    optional(:description) => binary(),
    optional(:destination) => binary(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()},
    optional(:source_transaction) => binary(),
    optional(:source_type) => :bank_account | :card | :fpx,
    optional(:transfer_group) => binary()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

Details

  • Method: post
  • Path: /v1/transfers
Link to this function

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

View Source 
@spec list(
  client :: Stripe.t(),
  params :: %{
    optional(:created) => created() | integer(),
    optional(:destination) => binary(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary(),
    optional(:transfer_group) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

Details

  • Method: get
  • Path: /v1/transfers
Link to this function

retrieve(client, transfer, params \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  client :: Stripe.t(),
  transfer :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

Details

  • Method: get
  • Path: /v1/transfers/{transfer}
Link to this function

update(client, transfer, params \\ %{}, opts \\ [])

View Source 
@spec update(
  client :: Stripe.t(),
  transfer :: binary(),
  params :: %{
    optional(:description) => binary(),
    optional(:expand) => [binary()],
    optional(:metadata) => %{optional(binary()) => binary()} | binary()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts only metadata as an argument.

Details

  • Method: post
  • Path: /v1/transfers/{transfer}