Stripe.Params.Treasury.OutboundPaymentCreateParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for outbound payment create.

Summary

Types

destination_payment_method_data()

@type destination_payment_method_data() :: %{
  optional(:billing_details) =>
    destination_payment_method_data_billing_details() | nil,
  optional(:financial_account) => String.t() | nil,
  optional(:metadata) => %{required(String.t()) => String.t()} | nil,
  optional(:type) => String.t() | nil,
  optional(:us_bank_account) =>
    destination_payment_method_data_us_bank_account() | nil,
  optional(String.t()) => term()
}
  • billing_details - Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
  • financial_account - Required if type is set to financial_account. The FinancialAccount ID to send funds to.
  • 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.
  • type - The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. Possible values: financial_account, us_bank_account.
  • us_bank_account - Required hash if type is set to us_bank_account.

destination_payment_method_data_billing_details()

@type destination_payment_method_data_billing_details() :: %{
  optional(:address) => map() | nil,
  optional(:email) => map() | nil,
  optional(:name) => map() | nil,
  optional(:phone) => map() | nil,
  optional(String.t()) => term()
}
  • address - Billing address.
  • email - Email address.
  • name - Full name.
  • phone - Billing phone number (including extension).

destination_payment_method_data_us_bank_account()

@type destination_payment_method_data_us_bank_account() :: %{
  optional(:account_holder_type) => String.t() | nil,
  optional(:account_number) => String.t() | nil,
  optional(:account_type) => String.t() | nil,
  optional(:financial_connections_account) => String.t() | nil,
  optional(:routing_number) => String.t() | nil,
  optional(String.t()) => term()
}
  • account_holder_type - Account holder type: individual or company. Possible values: company, individual.
  • account_number - Account number of the bank account. Max length: 5000.
  • account_type - Account type: checkings or savings. Defaults to checking if omitted. Possible values: checking, savings.
  • financial_connections_account - The ID of a Financial Connections Account to use as a payment method. Max length: 5000.
  • routing_number - Routing number of the bank account. Max length: 5000.

destination_payment_method_options()

@type destination_payment_method_options() :: %{
  optional(:us_bank_account) => map() | nil,
  optional(String.t()) => term()
}
  • us_bank_account - Optional fields for us_bank_account.

end_user_details()

@type end_user_details() :: %{
  optional(:ip_address) => String.t() | nil,
  optional(:present) => boolean() | nil,
  optional(String.t()) => term()
}
  • ip_address - IP address of the user initiating the OutboundPayment. Must be supplied if present is set to true.
  • present - True if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, false.

t()

@type t() :: %Stripe.Params.Treasury.OutboundPaymentCreateParams{
  amount: integer(),
  currency: String.t(),
  customer: String.t() | nil,
  description: String.t() | nil,
  destination_payment_method: String.t() | nil,
  destination_payment_method_data: destination_payment_method_data() | nil,
  destination_payment_method_options:
    destination_payment_method_options() | nil,
  end_user_details: end_user_details() | nil,
  expand: [String.t()] | nil,
  financial_account: String.t(),
  metadata: %{required(String.t()) => String.t()} | nil,
  statement_descriptor: String.t() | nil
}
  • 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.
  • customer - ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the destination_payment_method passed in. Max length: 5000.
  • 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 OutboundPayment. Exclusive with destination_payment_method_data. Max length: 5000.
  • destination_payment_method_data - Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with destination_payment_method.
  • destination_payment_method_options - Payment method-specific configuration for this OutboundPayment.
  • end_user_details - End user 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 - The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for ach payments, 140 characters for us_domestic_wire payments, or 500 characters for stripe network transfers. Can only include -#.$&*, spaces, and alphanumeric characters. The default value is "payment". Max length: 5000.