mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-05 00:02:50 -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
357 lines
15 KiB
Ruby
357 lines
15 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
module Treasury
|
|
# Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
|
|
#
|
|
# Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)
|
|
class InboundTransfer < APIResource
|
|
extend Stripe::APIOperations::Create
|
|
extend Stripe::APIOperations::List
|
|
|
|
OBJECT_NAME = "treasury.inbound_transfer"
|
|
def self.object_name
|
|
"treasury.inbound_transfer"
|
|
end
|
|
|
|
class FailureDetails < Stripe::StripeObject
|
|
# Reason for the failure.
|
|
attr_reader :code
|
|
end
|
|
|
|
class LinkedFlows < Stripe::StripeObject
|
|
# If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.
|
|
attr_reader :received_debit
|
|
end
|
|
|
|
class OriginPaymentMethodDetails < 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 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
|
|
# The type of the payment method used in the InboundTransfer.
|
|
attr_reader :type
|
|
# Attribute for field us_bank_account
|
|
attr_reader :us_bank_account
|
|
end
|
|
|
|
class StatusTransitions < Stripe::StripeObject
|
|
# Timestamp describing when an InboundTransfer changed status to `canceled`.
|
|
attr_reader :canceled_at
|
|
# Timestamp describing when an InboundTransfer changed status to `failed`.
|
|
attr_reader :failed_at
|
|
# Timestamp describing when an InboundTransfer changed status to `succeeded`.
|
|
attr_reader :succeeded_at
|
|
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 InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.
|
|
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
|
|
# 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
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
# The FinancialAccount to send funds to.
|
|
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
|
|
# The origin payment method to be debited for the InboundTransfer.
|
|
attr_accessor :origin_payment_method
|
|
# The complete description that appears on your customers' statements. Maximum 10 characters.
|
|
attr_accessor :statement_descriptor
|
|
|
|
def initialize(
|
|
amount: nil,
|
|
currency: nil,
|
|
description: nil,
|
|
expand: nil,
|
|
financial_account: nil,
|
|
metadata: nil,
|
|
origin_payment_method: nil,
|
|
statement_descriptor: nil
|
|
)
|
|
@amount = amount
|
|
@currency = currency
|
|
@description = description
|
|
@expand = expand
|
|
@financial_account = financial_account
|
|
@metadata = metadata
|
|
@origin_payment_method = origin_payment_method
|
|
@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 FailParams < Stripe::RequestParams
|
|
class FailureDetails < Stripe::RequestParams
|
|
# Reason for the failure.
|
|
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 failed InboundTransfer.
|
|
attr_accessor :failure_details
|
|
|
|
def initialize(expand: nil, failure_details: nil)
|
|
@expand = expand
|
|
@failure_details = failure_details
|
|
end
|
|
end
|
|
|
|
class ReturnInboundTransferParams < Stripe::RequestParams
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
|
|
def initialize(expand: nil)
|
|
@expand = expand
|
|
end
|
|
end
|
|
|
|
class SucceedParams < Stripe::RequestParams
|
|
# Specifies which fields in the response should be expanded.
|
|
attr_accessor :expand
|
|
|
|
def initialize(expand: nil)
|
|
@expand = expand
|
|
end
|
|
end
|
|
# Amount (in cents) transferred.
|
|
attr_reader :amount
|
|
# Returns `true` if the InboundTransfer is able to be canceled.
|
|
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
|
|
# Details about this InboundTransfer's failure. Only set when status is `failed`.
|
|
attr_reader :failure_details
|
|
# The FinancialAccount that received the funds.
|
|
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
|
|
# Attribute for field linked_flows
|
|
attr_reader :linked_flows
|
|
# 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
|
|
# The origin payment method to be debited for an InboundTransfer.
|
|
attr_reader :origin_payment_method
|
|
# Details about the PaymentMethod for an InboundTransfer.
|
|
attr_reader :origin_payment_method_details
|
|
# Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.
|
|
attr_reader :returned
|
|
# Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.
|
|
attr_reader :statement_descriptor
|
|
# Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.
|
|
attr_reader :status
|
|
# Attribute for field status_transitions
|
|
attr_reader :status_transitions
|
|
# The Transaction associated with this object.
|
|
attr_reader :transaction
|
|
|
|
# Cancels an InboundTransfer.
|
|
def cancel(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/treasury/inbound_transfers/%<inbound_transfer>s/cancel", { inbound_transfer: CGI.escape(self["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Cancels an InboundTransfer.
|
|
def self.cancel(inbound_transfer, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/treasury/inbound_transfers/%<inbound_transfer>s/cancel", { inbound_transfer: CGI.escape(inbound_transfer) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Creates an InboundTransfer.
|
|
def self.create(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: "/v1/treasury/inbound_transfers",
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Returns a list of InboundTransfers sent from the specified FinancialAccount.
|
|
def self.list(params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :get,
|
|
path: "/v1/treasury/inbound_transfers",
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
def test_helpers
|
|
TestHelpers.new(self)
|
|
end
|
|
|
|
class TestHelpers < APIResourceTestHelpers
|
|
RESOURCE_CLASS = InboundTransfer
|
|
def self.resource_class
|
|
"InboundTransfer"
|
|
end
|
|
|
|
# Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
|
|
def self.fail(id, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/fail", { id: CGI.escape(id) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
|
|
def fail(params = {}, opts = {})
|
|
@resource.request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/fail", { id: CGI.escape(@resource["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
|
|
def self.return_inbound_transfer(id, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/return", { id: CGI.escape(id) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
|
|
def return_inbound_transfer(params = {}, opts = {})
|
|
@resource.request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/return", { id: CGI.escape(@resource["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
|
|
def self.succeed(id, params = {}, opts = {})
|
|
request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/succeed", { id: CGI.escape(id) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
|
|
# Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
|
|
def succeed(params = {}, opts = {})
|
|
@resource.request_stripe_object(
|
|
method: :post,
|
|
path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/succeed", { id: CGI.escape(@resource["id"]) }),
|
|
params: params,
|
|
opts: opts
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|