@type billing_details() :: %{
  optional(:address) => address() | binary(),
  optional(:email) => binary() | binary(),
  optional(:name) => binary() | binary(),
  optional(:phone) => binary() | binary()
}

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

@type destination_payment_method_data() :: %{
  optional(:billing_details) => billing_details(),
  optional(:financial_account) => binary(),
  optional(:metadata) => %{optional(binary()) => binary()},
  optional(:type) => :financial_account | :us_bank_account,
  optional(:us_bank_account) => us_bank_account()
}

Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with destination_payment_method.

@type destination_payment_method_options() :: %{
  optional(:us_bank_account) => us_bank_account() | binary()
}

Payment method-specific configuration for this OutboundPayment.

@type end_user_details() :: %{
  optional(:ip_address) => binary(),
  optional(:present) => boolean()
}

End user details.

@type returned_details() :: %{
  optional(:code) =>
    :account_closed
    | :account_frozen
    | :bank_account_restricted
    | :bank_ownership_changed
    | :declined
    | :incorrect_account_holder_name
    | :invalid_account_number
    | :invalid_currency
    | :no_account
    | :other
}

Optional hash to set the the return code.

@type t() :: %Stripe.Treasury.OutboundPayment{
  amount: integer(),
  cancelable: boolean(),
  created: integer(),
  currency: binary(),
  customer: binary() | nil,
  description: binary() | nil,
  destination_payment_method: binary() | nil,
  destination_payment_method_details: term() | nil,
  end_user_details: term() | nil,
  expected_arrival_date: integer(),
  financial_account: binary(),
  hosted_regulatory_receipt_url: binary() | nil,
  id: binary(),
  livemode: boolean(),
  metadata: term(),
  object: binary(),
  returned_details: term() | nil,
  statement_descriptor: binary(),
  status: binary(),
  status_transitions: term(),
  transaction: binary() | Stripe.Treasury.Transaction.t()
}

The treasury.outbound_payment type.

• amount Amount (in cents) transferred.
• cancelable Returns true if the object can be canceled, and false otherwise.
• created Time at which the object was created. Measured in seconds since the Unix epoch.
• currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
• customer ID of the customer to whom an OutboundPayment is sent.
• description An arbitrary string attached to the object. Often useful for displaying to users.
• destination_payment_method The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.
• destination_payment_method_details Details about the PaymentMethod for an OutboundPayment.
• end_user_details Details about the end user.
• expected_arrival_date The date when funds are expected to arrive in the destination account.
• financial_account The FinancialAccount that funds were pulled from.
• hosted_regulatory_receipt_url A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
• id Unique identifier for the object.
• livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
• 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.
• object String representing the object's type. Objects of the same type share the same value.
• returned_details Details about a returned OutboundPayment. Only set when the status is returned.
• statement_descriptor The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
• status Current status of the OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundPayment fails to arrive at its destination, its status will change to returned.
• status_transitions
• transaction The Transaction associated with this object.