exoapi_stripe v0.1.4

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

Link to this section Summary

Types

get_recipients_id_opts()
get_recipients_opts()

Functions

delete_recipients_id(client, body, id)

description: <p>Permanently deletes a recipient. It cannot be undone.</p>

get_recipients(client, opts \\ [])

description: <p>Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.</p>

get_recipients_id(client, id, opts \\ [])

description: <p>Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.</p>

post_recipients(client, body)

description: <p>Creates a new <code>Recipient</code> object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.</p>

post_recipients_id(client, body, id)

description: <p>Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

Link to this section Types

Link to this type

get_recipients_id_opts()

View Source 
@type get_recipients_id_opts() :: {:expand, String.t()}
Link to this type

get_recipients_opts()

View Source 
@type get_recipients_opts() ::
  {:verified, String.t()}
  | {:type, String.t()}
  | {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}

Link to this section Functions

Link to this function

delete_recipients_id(client, body, id)

View Source 
@spec delete_recipients_id(
  client :: ExOAPI.Client.t(),
  body :: %{} | map(),
  id :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedRecipient.t()
   | map()}
  | {:error, any()}

description: <p>Permanently deletes a recipient. It cannot be undone.</p>

deprecated: true

Link to this function

get_recipients(client, opts \\ [])

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

description: <p>Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.</p>

deprecated: true

Link to this function

get_recipients_id(client, id, opts \\ [])

View Source 
@spec get_recipients_id(
  client :: ExOAPI.Client.t(),
  id :: String.t(),
  [get_recipients_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedRecipient.t()
   | ExOAPI.Stripe.Schemas.Recipient.t()
   | map()}
  | {:error, any()}

description: <p>Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.</p>

deprecated: true

Link to this function

post_recipients(client, body)

View Source 
@spec post_recipients(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      type: String.t(),
      tax_id: String.t(),
      name: String.t(),
      metadata: String.t() | map(),
      expand: [String.t()],
      email: String.t(),
      description: String.t(),
      card: String.t(),
      bank_account: String.t()
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Recipient.t() | map()}
  | {:error, any()}

description: <p>Creates a new <code>Recipient</code> object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.</p>

deprecated: true

Link to this function

post_recipients_id(client, body, id)

View Source 
@spec post_recipients_id(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      tax_id: String.t(),
      name: String.t(),
      metadata: String.t() | map(),
      expand: [String.t()],
      email: String.t(),
      description: String.t(),
      default_card: String.t(),
      card: String.t(),
      bank_account: String.t()
    }
    | map(),
  id :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Recipient.t() | map()}
  | {:error, any()}

description: <p>Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

If you update the name or tax ID, the identity verification will automatically be rerun.If you update the bank account, the bank account validation will automatically be rerun.

**deprecated**: true