Stripe.Params.Treasury.OutboundTransferCreateParams (tiger_stripe v0.4.0)

Copy Markdown View Source

Parameters for outbound transfer create.

Summary

Types

t()

Types

t()

@type t() :: %Stripe.Params.Treasury.OutboundTransferCreateParams{
  amount: term(),
  currency: term(),
  description: term(),
  destination_payment_method: term(),
  destination_payment_method_data: term(),
  destination_payment_method_options: term(),
  expand: term(),
  financial_account: term(),
  metadata: term(),
  statement_descriptor: term()
}
  • amount - Amount (in cents) to be transferred.
  • currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.
  • description - An arbitrary string attached to the object. Often useful for displaying to users. Max length: 5000.
  • destination_payment_method - The PaymentMethod to use as the payment instrument for the OutboundTransfer. Max length: 5000.
  • destination_payment_method_data - Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with destination_payment_method.
  • destination_payment_method_options - Hash describing payment method configuration details.
  • expand - Specifies which fields in the response should be expanded.
  • financial_account - The FinancialAccount to pull funds from.
  • 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
  • statement_descriptor - Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for ach transfers or 140 characters for us_domestic_wire transfers. The default value is "transfer". Can only include -#.$&*, spaces, and alphanumeric characters. Max length: 5000.