View Source ExOAPI.Stripe.SDK.Payouts (exoapi_stripe v0.1.4)

Link to this section Summary

Functions

description: <p>Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.</p>

description: <p>Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.</p>

description: <p>To send funds to your own bank account, you create a new payout object. Your <a href="#balance">Stripe balance</a> must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.</p>

description: <p>Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.</p>

description: <p>A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.</p>

description: <p>Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the <code>pending</code> status, <code>/v1/payouts/:id/cancel</code> should be used instead.</p>

Link to this section Types

@type get_payouts_opts() ::
  {:status, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:destination, String.t()}
  | {:created, String.t()}
  | {:arrival_date, String.t()}
Link to this type

get_payouts_payout_opts()

View Source
@type get_payouts_payout_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

get_payouts(client, opts \\ [])

View Source
@spec get_payouts(client :: ExOAPI.Client.t(), [get_payouts_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Payout.t()]
     }
   | map()}
  | {:error, any()}

description: <p>Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.</p>

Link to this function

get_payouts_payout(client, payout, opts \\ [])

View Source
@spec get_payouts_payout(
  client :: ExOAPI.Client.t(),
  payout :: String.t(),
  [get_payouts_payout_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Payout.t() | map()}
  | {:error, any()}

description: <p>Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.</p>

Link to this function

post_payouts(client, body)

View Source
@spec post_payouts(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      statement_descriptor: String.t(),
      source_type: String.t() | :bank_account | :card | :fpx,
      method: String.t() | :instant | :standard,
      metadata: map(),
      expand: [String.t()],
      destination: String.t(),
      description: String.t(),
      currency: String.t(),
      amount: integer()
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Payout.t() | map()}
  | {:error, any()}

description: <p>To send funds to your own bank account, you create a new payout object. Your <a href="#balance">Stripe balance</a> must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.</p>

If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

Link to this function

post_payouts_payout(client, body, payout)

View Source
@spec post_payouts_payout(
  client :: ExOAPI.Client.t(),
  body :: %{metadata: String.t() | map(), expand: [String.t()]} | map(),
  payout :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Payout.t() | map()}
  | {:error, any()}

description: <p>Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.</p>

Link to this function

post_payouts_payout_cancel(client, body, payout)

View Source
@spec post_payouts_payout_cancel(
  client :: ExOAPI.Client.t(),
  body :: %{expand: [String.t()]} | map(),
  payout :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Payout.t() | map()}
  | {:error, any()}

description: <p>A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.</p>

Link to this function

post_payouts_payout_reverse(client, body, payout)

View Source
@spec post_payouts_payout_reverse(
  client :: ExOAPI.Client.t(),
  body :: %{metadata: map(), expand: [String.t()]} | map(),
  payout :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Payout.t() | map()}
  | {:error, any()}

description: <p>Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the <code>pending</code> status, <code>/v1/payouts/:id/cancel</code> should be used instead.</p>

By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.