NAME
Net::API::Stripe::Treasury::OutboundTransfer - The OutboundTransfer object
SYNOPSIS
VERSION
v0.1.0DESCRIPTION
Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments 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.
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 object can be canceled, and false otherwise.
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.
destination_payment_method string
The PaymentMethod used as the payment instrument for an OutboundTransfer.
destination_payment_method_details object
Details about the PaymentMethod for an OutboundTransfer
This is a Net::API::Stripe::Payment::Method object.
expected_arrival_date timestamp
The date when funds are expected to arrive in the destination account.
financial_account string
The FinancialAccount that funds were pulled from.
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.
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.
returned_details hash
Details about a returned OutboundTransfer. Only set when the status is returned.
It has the following properties:
codestring-
Reason for the return.
transactionstring expandable-
The Transaction associated with this object.
When expanded this is an Net::API::Stripe::Treasury::Transaction object.
statement_descriptor string
Information about the OutboundTransfer to be sent to the recipient account.
status string
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.
status_transitions hash
Hash containing timestamps of when the object transitioned to a particular status.
It has the following properties:
canceled_attimestamp-
Timestamp describing when an OutboundTransfer changed status to
canceled failed_attimestamp-
Timestamp describing when an OutboundTransfer changed status to
failed posted_attimestamp-
Timestamp describing when an OutboundTransfer changed status to
posted returned_attimestamp-
Timestamp describing when an OutboundTransfer changed status to
returned
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" : "1662261085", "currency" : "usd", "description" : "OutboundTransfer to my external bank account", "destination_payment_method" : "pm_1Le9F32eZvKYlo2CpHGQxg2C", "destination_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" } }, "expected_arrival_date" : "1662422400", "financial_account" : "fa_1Le9F32eZvKYlo2CjbQcDQUE", "hosted_regulatory_receipt_url" : "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKN6u0JgGMgYg10dl2l46NpNi7-U4RHGRK4gmazw1MJMHmoXQhqSVwlK_KfXIpam3FgzagG7PLAcDtvccPlM_sJNFGTBUBQ", "id" : "obt_1Le9F32eZvKYlo2CPQD5jo2F", "livemode" : 0, "metadata" : {}, "object" : "treasury.outbound_transfer", "returned_details" : null, "statement_descriptor" : "transfer", "status" : "processing", "status_transitions" : { "canceled_at" : null, "failed_at" : null, "posted_at" : null, "returned_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.