mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-06 00:02:18 -04:00
dc5174725f
* Introduce types to ruby * rubocop * forgot these files * other request methods * more tests, fix for raw request * Add README entry for types * rebase and regen
494 lines
22 KiB
Ruby
494 lines
22 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
module Treasury
|
|
# Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
|
|
#
|
|
# Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
|
|
#
|
|
# Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
|
|
class OutboundTransfer < APIResource
|
|
extend Stripe::APIOperations::Create
|
|
extend Stripe::APIOperations::List
|
|
|
|
OBJECT_NAME = "treasury.outbound_transfer"
|
|
def self.object_name
|
|
"treasury.outbound_transfer"
|
|
end
|
|
|
|
class DestinationPaymentMethodDetails < Stripe::StripeObject
|
|
class BillingDetails < Stripe::StripeObject
|
|
class Address < Stripe::StripeObject
|
|
# City, district, suburb, town, or village.
|
|
attr_reader :city
|
|
# Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
|
|
attr_reader :country
|
|
# Address line 1 (e.g., street, PO Box, or company name).
|
|
attr_reader :line1
|
|
# Address line 2 (e.g., apartment, suite, unit, or building).
|
|
attr_reader :line2
|
|
# ZIP or postal code.
|
|
attr_reader :postal_code
|
|
# State, county, province, or region.
|
|
attr_reader :state
|
|
end
|
|
# Attribute for field address
|
|
attr_reader :address
|
|
# Email address.
|
|
attr_reader :email
|
|
# Full name.
|
|
attr_reader :name
|
|
end
|
|
|
|
class FinancialAccount < Stripe::StripeObject
|
|
# Token of the FinancialAccount.
|
|
attr_reader :id
|
|
# The rails used to send funds.
|
|
attr_reader :network
|
|
end
|
|
|
|
class UsBankAccount < Stripe::StripeObject
|
|
# Account holder type: individual or company.
|
|
attr_reader :account_holder_type
|
|
# Account type: checkings or savings. Defaults to checking if omitted.
|
|
attr_reader :account_type
|
|
# Name of the bank associated with the bank account.
|
|
attr_reader :bank_name
|
|
# Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
|
|
attr_reader :fingerprint
|
|
# Last four digits of the bank account number.
|
|
attr_reader :last4
|
|
# ID of the mandate used to make this payment.
|
|
attr_reader :mandate
|
|
# The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
|
|
attr_reader :network
|
|
# Routing number of the bank account.
|
|
attr_reader :routing_number
|
|
end
|
|
# Attribute for field billing_details
|
|
attr_reader :billing_details
|
|
# Attribute for field financial_account
|
|
attr_reader :financial_account
|
|
# The type of the payment method used in the OutboundTransfer.
|
|
attr_reader :type
|
|
# Attribute for field us_bank_account
|
|
attr_reader :us_bank_account
|
|
end
|
|
|
|
class ReturnedDetails < Stripe::StripeObject
|
|
# Reason for the return.
|
|
attr_reader :code
|
|
# The Transaction associated with this object.
|
|
attr_reader :transaction
|
|
end
|
|
|
|
class StatusTransitions < Stripe::StripeObject
|
|
# Timestamp describing when an OutboundTransfer changed status to `canceled`
|
|
attr_reader :canceled_at
|
|
# Timestamp describing when an OutboundTransfer changed status to `failed`
|
|
attr_reader :failed_at
|
|
# Timestamp describing when an OutboundTransfer changed status to `posted`
|
|
attr_reader :posted_at
|
|
# Timestamp describing when an OutboundTransfer changed status to `returned`
|
|
attr_reader :returned_at
|
|
end
|
|
|
|
class TrackingDetails < Stripe::StripeObject
|
|
class Ach < Stripe::StripeObject
|
|
# ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.
|
|
attr_reader :trace_id
|
|
end
|
|
|
|
class UsDomesticWire < Stripe::StripeObject
|
|
# CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
|
|
attr_reader :chips
|
|
# IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
|
|
attr_reader :imad
|
|
# OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
|
|
attr_reader :omad
|
|
end
|
|
# Attribute for field ach
|
|
attr_reader :ach
|
|
# The US bank account network used to send funds.
|
|
attr_reader :type
|
|
# Attribute for field us_domestic_wire
|
|
attr_reader :us_domestic_wire
|
|
end
|
|
|
|
class ListParams < Stripe::RequestParams
|
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
|
attr_accessor :ending_before
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
# Returns objects associated with this FinancialAccount.
|
|
attr_accessor :financial_account
|
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
|
attr_accessor :limit
|
|
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
|
attr_accessor :starting_after
|
|
# Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.
|
|
attr_accessor :status
|
|
|
|
def initialize(
|
|
ending_before: nil,
|
|
expand: nil,
|
|
financial_account: nil,
|
|
limit: nil,
|
|
starting_after: nil,
|
|
status: nil
|
|
)
|
|
@ending_before = ending_before
|
|
@expand = expand
|
|
@financial_account = financial_account
|
|
@limit = limit
|
|
@starting_after = starting_after
|
|
@status = status
|
|
end
|
|
end
|
|
|
|
class CreateParams < Stripe::RequestParams
|
|
class DestinationPaymentMethodData < Stripe::RequestParams
|
|
# Required if type is set to `financial_account`. The FinancialAccount ID to send funds to.
|
|
attr_accessor :financial_account
|
|
# The type of the destination.
|
|
attr_accessor :type
|
|
|
|
def initialize(financial_account: nil, type: nil)
|
|
@financial_account = financial_account
|
|
@type = type
|
|
end
|
|
end
|
|
|
|
class DestinationPaymentMethodOptions < Stripe::RequestParams
|
|
class UsBankAccount < Stripe::RequestParams
|
|
# Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
|
|
attr_accessor :network
|
|
|
|
def initialize(network: nil)
|
|
@network = network
|
|
end
|
|
end
|
|
# Optional fields for `us_bank_account`.
|
|
attr_accessor :us_bank_account
|
|
|
|
def initialize(us_bank_account: nil)
|
|
@us_bank_account = us_bank_account
|
|
end
|
|
end
|
|
# Amount (in cents) to be transferred.
|
|
attr_accessor :amount
|
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
attr_accessor :currency
|
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
attr_accessor :description
|
|
# The PaymentMethod to use as the payment instrument for the OutboundTransfer.
|
|
attr_accessor :destination_payment_method
|
|
# Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`.
|
|
attr_accessor :destination_payment_method_data
|
|
# Hash describing payment method configuration details.
|
|
attr_accessor :destination_payment_method_options
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
# The FinancialAccount to pull funds from.
|
|
attr_accessor :financial_account
|
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.
|
|
attr_accessor :metadata
|
|
# 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".
|
|
attr_accessor :statement_descriptor
|
|
|
|
def initialize(
|
|
amount: nil,
|
|
currency: nil,
|
|
description: nil,
|
|
destination_payment_method: nil,
|
|
destination_payment_method_data: nil,
|
|
destination_payment_method_options: nil,
|
|
expand: nil,
|
|
financial_account: nil,
|
|
metadata: nil,
|
|
statement_descriptor: nil
|
|
)
|
|
@amount = amount
|
|
@currency = currency
|
|
@description = description
|
|
@destination_payment_method = destination_payment_method
|
|
@destination_payment_method_data = destination_payment_method_data
|
|
@destination_payment_method_options = destination_payment_method_options
|
|
@expand = expand
|
|
@financial_account = financial_account
|
|
@metadata = metadata
|
|
@statement_descriptor = statement_descriptor
|
|
end
|
|
end
|
|
|
|
class CancelParams < Stripe::RequestParams
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
|
|
def initialize(expand: nil)
|
|
@expand = expand
|
|
end
|
|
end
|
|
|
|
class UpdateParams < Stripe::RequestParams
|
|
class TrackingDetails < Stripe::RequestParams
|
|
class Ach < Stripe::RequestParams
|
|
# ACH trace ID for funds sent over the `ach` network.
|
|
attr_accessor :trace_id
|
|
|
|
def initialize(trace_id: nil)
|
|
@trace_id = trace_id
|
|
end
|
|
end
|
|
|
|
class UsDomesticWire < Stripe::RequestParams
|
|
# CHIPS System Sequence Number (SSN) for funds sent over the `us_domestic_wire` network.
|
|
attr_accessor :chips
|
|
# IMAD for funds sent over the `us_domestic_wire` network.
|
|
attr_accessor :imad
|
|
# OMAD for funds sent over the `us_domestic_wire` network.
|
|
attr_accessor :omad
|
|
|
|
def initialize(chips: nil, imad: nil, omad: nil)
|
|
@chips = chips
|
|
@imad = imad
|
|
@omad = omad
|
|
end
|
|
end
|
|
# ACH network tracking details.
|
|
attr_accessor :ach
|
|
# The US bank account network used to send funds.
|
|
attr_accessor :type
|
|
# US domestic wire network tracking details.
|
|
attr_accessor :us_domestic_wire
|
|
|
|
def initialize(ach: nil, type: nil, us_domestic_wire: nil)
|
|
@ach = ach
|
|
@type = type
|
|
@us_domestic_wire = us_domestic_wire
|
|
end
|
|
end
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
# Details about network-specific tracking information.
|
|
attr_accessor :tracking_details
|
|
|
|
def initialize(expand: nil, tracking_details: nil)
|
|
@expand = expand
|
|
@tracking_details = tracking_details
|
|
end
|
|
end
|
|
|
|
class FailParams < Stripe::RequestParams
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
|
|
def initialize(expand: nil)
|
|
@expand = expand
|
|
end
|
|
end
|
|
|
|
class PostParams < Stripe::RequestParams
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
|
|
def initialize(expand: nil)
|
|
@expand = expand
|
|
end
|
|
end
|
|
|
|
class ReturnOutboundTransferParams < Stripe::RequestParams
|
|
class ReturnedDetails < Stripe::RequestParams
|
|
# Reason for the return.
|
|
attr_accessor :code
|
|
|
|
def initialize(code: nil)
|
|
@code = code
|
|
end
|
|
end
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
# Details about a returned OutboundTransfer.
|
|
attr_accessor :returned_details
|
|
|
|
def initialize(expand: nil, returned_details: nil)
|
|
@expand = expand
|
|
@returned_details = returned_details
|
|
end
|
|
end
|
|
# Amount (in cents) transferred.
|
|
attr_reader :amount
|
|
# Returns `true` if the object can be canceled, and `false` otherwise.
|
|
attr_reader :cancelable
|
|
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
|
attr_reader :created
|
|
# Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
|
attr_reader :currency
|
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
|
attr_reader :description
|
|
# The PaymentMethod used as the payment instrument for an OutboundTransfer.
|
|
attr_reader :destination_payment_method
|
|
# Attribute for field destination_payment_method_details
|
|
attr_reader :destination_payment_method_details
|
|
# The date when funds are expected to arrive in the destination account.
|
|
attr_reader :expected_arrival_date
|
|
# The FinancialAccount that funds were pulled from.
|
|
attr_reader :financial_account
|
|
# A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
|
|
attr_reader :hosted_regulatory_receipt_url
|
|
# Unique identifier for the object.
|
|
attr_reader :id
|
|
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
|
attr_reader :livemode
|
|
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
|
attr_reader :metadata
|
|
# String representing the object's type. Objects of the same type share the same value.
|
|
attr_reader :object
|
|
# Details about a returned OutboundTransfer. Only set when the status is `returned`.
|
|
attr_reader :returned_details
|
|
# Information about the OutboundTransfer to be sent to the recipient account.
|
|
attr_reader :statement_descriptor
|
|
# Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.
|
|
attr_reader :status
|
|
# Attribute for field status_transitions
|
|
attr_reader :status_transitions
|
|
# Details about network-specific tracking information if available.
|
|
attr_reader :tracking_details
|
|
# The Transaction associated with this object.
|
|
attr_reader :transaction
|
|
|
|
# An OutboundTransfer can be canceled if the funds have not yet been paid out.
|
|
def cancel(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/treasury/outbound_transfers/%<outbound_transfer>s/cancel", { outbound_transfer: CGI.escape(self["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# An OutboundTransfer can be canceled if the funds have not yet been paid out.
|
|
def self.cancel(outbound_transfer, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/treasury/outbound_transfers/%<outbound_transfer>s/cancel", { outbound_transfer: CGI.escape(outbound_transfer) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Creates an OutboundTransfer.
|
|
def self.create(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: "/v1/treasury/outbound_transfers",
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Returns a list of OutboundTransfers sent from the specified FinancialAccount.
|
|
def self.list(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :get,
|
|
path: "/v1/treasury/outbound_transfers",
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
def test_helpers
|
|
TestHelpers.new(self)
|
|
end
|
|
|
|
class TestHelpers < APIResourceTestHelpers
|
|
RESOURCE_CLASS = OutboundTransfer
|
|
def self.resource_class
|
|
"OutboundTransfer"
|
|
end
|
|
|
|
# Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
|
|
def self.fail(outbound_transfer, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/fail", { outbound_transfer: CGI.escape(outbound_transfer) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
|
|
def fail(params = {}, opts = {})
|
|
@resource.request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/fail", { outbound_transfer: CGI.escape(@resource["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
|
|
def self.post(outbound_transfer, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/post", { outbound_transfer: CGI.escape(outbound_transfer) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
|
|
def post(params = {}, opts = {})
|
|
@resource.request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/post", { outbound_transfer: CGI.escape(@resource["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
|
|
def self.return_outbound_transfer(outbound_transfer, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/return", { outbound_transfer: CGI.escape(outbound_transfer) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
|
|
def return_outbound_transfer(params = {}, opts = {})
|
|
@resource.request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/return", { outbound_transfer: CGI.escape(@resource["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
|
|
def self.update(outbound_transfer, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s", { outbound_transfer: CGI.escape(outbound_transfer) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
|
|
def update(params = {}, opts = {})
|
|
@resource.request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s", { outbound_transfer: CGI.escape(@resource["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|