exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Recipient (exoapi_stripe v0.1.4)

description: With Recipient objects, you can transfer money from your Stripe account to a third-party bank account or debit card. The API allows you to create, delete, and update your recipients. You can retrieve individual recipients as well as a list of all your recipients.

Recipient objects have been deprecated in favor of Connect, specifically Connect's much more powerful Account objects. Stripe accounts that don't already use recipients can no longer begin doing so. Please use Account objects instead.

:active_account :: ExOAPI.Stripe.Schemas.BankAccount

Hash describing the current account on the recipient, if there is one.

::data :: ExOAPI.Stripe.Schemas.Card

:has_more :: :boolean

True if this list has another page of items after this one that can be fetched.

:object :: :string

String representing the object's type. Objects of the same type share the same value. Always has the value list.

:url :: :string

The URL where this list can be accessed.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:default_card :: ExOAPI.Stripe.Schemas.Card | :string

The default card to use for creating transfers to this recipient.

:description :: :string

An arbitrary string attached to the object. Often useful for displaying to users.

:email :: :string

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:metadata :: :map

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.

:migrated_to :: ExOAPI.Stripe.Schemas.Account | :string

The ID of the Custom account this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.

:name :: :string

Full, legal name of the recipient.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:rolled_back_from :: ExOAPI.Stripe.Schemas.Account | :string

:type :: :string

Type of the recipient, one of individual or corporation.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Recipient{
  active_account: ExOAPI.EctoTypes.AnyOf.t() | nil,
  cards: map() | nil,
  created: integer() | nil,
  default_card: ExOAPI.EctoTypes.AnyOf.t() | nil,
  description: String.t() | nil,
  email: String.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  migrated_to: ExOAPI.EctoTypes.AnyOf.t() | nil,
  name: String.t() | nil,
  object: :recipient | nil,
  rolled_back_from: ExOAPI.EctoTypes.AnyOf.t() | nil,
  type: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()