Stripe.Recipient (stripity_stripe v2.17.2) View Source
Work with Stripe recipient objects.
Stripe API reference: https://stripe.com/docs/api#recipients
Recent versions of the Stripe API no longer support recipients. Users should migrate to (Connect)[https://stripe.com/docs/connect/recipient-account-migrations].
Link to this section Summary
Functions
Create a recipient
Delete a recipient.
List all recipients.
Retrieve a recipient.
Update a recipient.
Link to this section Types
Specs
t() :: %Stripe.Recipient{ active_account: %{ id: Stripe.id(), object: String.t(), account: Stripe.id(), account_holder_name: String.t(), account_holder_type: String.t(), bank_name: String.t(), country: String.t(), currency: String.t(), customer: Stripe.id(), default_for_currency: boolean(), fingerprint: String.t(), last4: String.t(), metadata: Stripe.Types.metadata(), routing_number: String.t(), status: String.t() } | nil, cards: Stripe.List.t(Stripe.Card.t()), created: Stripe.timestamp(), default_card: Stripe.id() | Stripe.Card.t(), deleted: boolean() | nil, description: String.t() | nil, email: String.t() | nil, id: Stripe.id(), livemode: boolean(), metadata: Stripe.Types.metadata(), migrated_to: Stripe.id() | Stripe.Account.t(), name: String.t() | nil, object: String.t(), rolled_back_from: Stripe.id() | Stripe.Account.t(), type: String.t() }
Link to this section Functions
Specs
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ :name => String.t(), :type => String.t(), optional(:bank_account) => Stripe.id() | Stripe.BankAccount.t(), optional(:recipient) => Stripe.id() | Stripe.Card.t(), optional(:description) => String.t(), optional(:email) => String.t(), optional(:metadata) => Stripe.Types.metadata(), optional(:tax_id) => String.t() }
Create a recipient
Specs
delete(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Delete a recipient.
Specs
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:created) => Stripe.timestamp(), optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:starting_after) => t() | Stripe.id(), optional(:type) => String.t(), optional(:verified) => boolean() }
List all recipients.
Specs
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a recipient.
Specs
update(Stripe.id() | t(), params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ optional(:bank_account) => Stripe.id() | Stripe.BankAccount.t(), optional(:card) => Stripe.id() | Stripe.Card.t(), optional(:default_card) => Stripe.id() | Stripe.Card.t(), optional(:description) => String.t(), optional(:email) => String.t(), optional(:metadata) => Stripe.Types.metadata(), optional(:name) => String.t(), optional(:tax_id) => String.t() }
Update a recipient.
Takes the id
and a map of changes