NAME
Net::API::Stripe::Treasury::InboundTransfer - The InboundTransfer object
SYNOPSIS
VERSION
v0.1.0DESCRIPTION
Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
METHODS
id string
Unique identifier for the object.
object string
String representing the object's type. Objects of the same type share the same value.
amount integer
Amount (in cents) transferred.
cancelable boolean
Returns true if the InboundTransfer is able to be canceled.
created timestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
currency currency
Three-letter ISO currency code, in lowercase. Must be a supported currency.
description string
An arbitrary string attached to the object. Often useful for displaying to users.
failure_details object
Details about this InboundTransfer's failure. Only set when status is failed.
This is a Net::API::Stripe::Error object.
financial_account string
The FinancialAccount that received the funds.
hosted_regulatory_receipt_url string
A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
linked_flows hash
Other flows linked to a InboundTransfer.
It has the following properties:
received_debitstring-
If funds for this flow were returned after the flow went to the
succeededstate, this field contains a reference to the ReceivedDebit return.
livemode boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata hash
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.
origin_payment_method string
The origin payment method to be debited for an InboundTransfer.
origin_payment_method_details object
Details about the PaymentMethod for an InboundTransfer.
This is a Net::API::Stripe::Payment::Method object.
returned boolean
Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.
statement_descriptor string
Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.
status string
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.
status_transitions hash
Hash containing timestamps of when the object transitioned to a particular status.
It has the following properties:
failed_attimestamp-
Timestamp describing when an InboundTransfer changed status to
failed. succeeded_attimestamp-
Timestamp describing when an InboundTransfer changed status to
succeeded.
transaction expandable
The Transaction associated with this object.
When expanded this is an Net::API::Stripe::Treasury::Transaction object.
API SAMPLE
[ { "amount" : "10000", "cancelable" : 1, "created" : "1662261086", "currency" : "usd", "description" : "InboundTransfer from my external bank account", "failure_details" : null, "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE", "hosted_regulatory_receipt_url" : "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKN6u0JgGMgYX_o2noYA6NpN4jXrpZ4wHFa5zF22DiASaNO0VqFyFqmmxq76HgJ6U3fMErijpEIwaJZheg_11U9lfHZvHaQ", "id" : "ibt_1Le9F42eZvKYlo2CxDLDB04R", "linked_flows" : { "received_debit" : null }, "livemode" : 0, "metadata" : {}, "object" : "treasury.inbound_transfer", "origin_payment_method" : "pm_1Le9F32eZvKYlo2CpHGQxg2C", "origin_payment_method_details" : { "billing_details" : { "address" : { "city" : "San Francisco", "country" : "US", "line1" : "1234 Fake Street", "line2" : null, "postal_code" : "94102", "state" : "CA" }, "email" : null, "name" : "Jane Austen" }, "type" : "us_bank_account", "us_bank_account" : { "account_holder_type" : "company", "account_type" : "checking", "bank_name" : "STRIPE TEST BANK", "fingerprint" : "1JWtPxqbdX5Gamtc", "last4" : "6789", "network" : "ach", "routing_number" : "110000000" } }, "returned" : 0, "statement_descriptor" : "transfer", "status" : "processing", "status_transitions" : { "failed_at" : null, "succeeded_at" : null }, "transaction" : "trxn_1Le9F32eZvKYlo2C2dtkse82" } ]
HISTORY
v0.1.0
Initial version
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
COPYRIGHT & LICENSE
Copyright (c) 2019-2022 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.