Search documentation of tiger_stripe

# Stripe.Resources.Treasury.OutboundPayment (tiger_stripe v0.1.1)

Copy Markdown View Source

TreasuryOutboundPaymentsResourceOutboundPayment

Use OutboundPayments to send funds to another party's external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.

Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.

Related guide: Moving money with Treasury using OutboundPayment objects

## Summary

### Types

t()

### Functions

expandable_fields()
object_name()

## Types

# t()

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

- `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. Format: Unix timestamp.
- `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 an OutboundPayment is sent. Max length: 5000. Nullable.
- `description` - An arbitrary string attached to the object. Often useful for displaying to users. Max length: 5000. Nullable.
- `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`. Max length: 5000. Nullable.
- `destination_payment_method_details` - Details about the PaymentMethod for an OutboundPayment. Nullable. Expandable.
- `end_user_details` - Details about the end user. Nullable. Expandable.
- `expected_arrival_date` - The date when funds are expected to arrive in the destination account. Format: Unix timestamp.
- `financial_account` - The FinancialAccount that funds were pulled from. Max length: 5000.
- `hosted_regulatory_receipt_url` - A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. Max length: 5000. Nullable.
- `id` - Unique identifier for the object. Max length: 5000.
- `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. Possible values: `treasury.outbound_payment`.
- `returned_details` - Details about a returned OutboundPayment. Only set when the status is `returned`. Nullable. Expandable.
- `statement_descriptor` - The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). Max length: 5000.
- `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`. Possible values: `canceled`, `failed`, `posted`, `processing`, `returned`.
- `status_transitions` - Expandable.
- `tracking_details` - Details about network-specific tracking information if available. Nullable. Expandable.
- `transaction` - The Transaction associated with this object. Expandable.

## Functions

# expandable_fields()

# object_name()