Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- amountinteger
Amount (in cents) transferred.
- cancelableboolean
Returns
true
if the InboundTransfer is able to be canceled. - createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- descriptionnullable string
An arbitrary string attached to the object. Often useful for displaying to users.
- failure_
detailsnullable object Details about this InboundTransfer’s failure. Only set when status is
failed
. - financial_
accountstring The FinancialAccount that received the funds.
- hosted_
regulatory_ receipt_ urlnullable string A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
- linked_
flowsobject Other flows linked to a InboundTransfer.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - metadataobject
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_ methodnullable string The origin payment method to be debited for an InboundTransfer.
- origin_
payment_ method_ detailsnullable object Details about the PaymentMethod for an InboundTransfer.
- returnednullable boolean
Returns
true
if the funds for an InboundTransfer were returned after the InboundTransfer went to thesucceeded
state. - statement_
descriptorstring Statement descriptor shown when funds are debited from the source. Not all payment networks support
statement_
.descriptor - statusenum
Status of the InboundTransfer:
processing
,succeeded
,failed
, andcanceled
. An InboundTransfer isprocessing
if it is created and pending. The status changes tosucceeded
once the funds have been “confirmed” and atransaction
is created and posted. The status changes tofailed
if the transfer fails. - status_
transitionsobject Hash containing timestamps of when the object transitioned to a particular
status
. - transactionnullable stringExpandable
The Transaction associated with this object.
Creates an InboundTransfer.
Parameters
- amountintegerRequired
Amount (in cents) to be transferred.
- currencyenumRequired
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- financial_
accountstringRequired The FinancialAccount to send funds to.
- origin_
payment_ methodstringRequired The origin payment method to be debited for the InboundTransfer.
- descriptionstring
An arbitrary string attached to the object. Often useful for displaying to users.
- metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - statement_
descriptorstring The complete description that appears on your customers’ statements. Maximum 10 characters.
Returns
Returns an InboundTransfer object if there were no issues with InboundTransfer creation. The status of the created InboundTransfer object is initially marked as processing
.
{ "id": "ibt_1MtaDN2eZvKYlo2CxcxF1Qwi", "object": "treasury.inbound_transfer", "amount": 10000, "cancelable": true, "created": 1680716025, "currency": "usd", "description": "InboundTransfer from my bank account", "failure_details": null, "financial_account": "fa_1MtaDM2eZvKYlo2CvXrQknN4", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKPnhtqEGMgYYdf7K2aE6NpN7tVDs9F1hxjKU9i3In9yfJWRBNJycDGlZZ22xgY_IuRs_jih19J4q6c4yUsv0SimaA57pww", "linked_flows": { "received_debit": null }, "livemode": false, "metadata": {}, "origin_payment_method": "pm_1KMDdkGPnV27VyGeAgGz8bsi", "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": "AP24Iso0btGp4N10", "last4": "6789", "network": "ach", "routing_number": "110000000" } }, "returned": false, "statement_descriptor": "transfer", "status": "processing", "status_transitions": { "failed_at": null, "succeeded_at": null }, "transaction": "trxn_1MtaDM2eZvKYlo2CKxgPNzLa"}
Retrieves the details of an existing InboundTransfer.
Parameters
No parameters.
Returns
Returns an InboundTransfer object if a valid identifier was provided. Otherwise, returns an error.
{ "id": "ibt_1MtaDN2eZvKYlo2CxcxF1Qwi", "object": "treasury.inbound_transfer", "amount": 10000, "cancelable": true, "created": 1680716025, "currency": "usd", "description": "InboundTransfer from my bank account", "failure_details": null, "financial_account": "fa_1MtaDM2eZvKYlo2CvXrQknN4", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKPnhtqEGMgYYdf7K2aE6NpN7tVDs9F1hxjKU9i3In9yfJWRBNJycDGlZZ22xgY_IuRs_jih19J4q6c4yUsv0SimaA57pww", "linked_flows": { "received_debit": null }, "livemode": false, "metadata": {}, "origin_payment_method": "pm_1KMDdkGPnV27VyGeAgGz8bsi", "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": "AP24Iso0btGp4N10", "last4": "6789", "network": "ach", "routing_number": "110000000" } }, "returned": false, "statement_descriptor": "transfer", "status": "processing", "status_transitions": { "failed_at": null, "succeeded_at": null }, "transaction": "trxn_1MtaDM2eZvKYlo2CKxgPNzLa"}
Returns a list of InboundTransfers sent from the specified FinancialAccount.
Parameters
- financial_
accountstringRequired Returns objects associated with this FinancialAccount.
- statusenum
Only return InboundTransfers that have the given status:
processing
,succeeded
,failed
orcanceled
.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
InboundTransfers, starting after InboundTransfer starting_
. Each entry in the array is a separate InboundTransfer object. If no more InboundTransfers are available, the resulting array is empty.
{ "object": "list", "url": "/v1/treasury/inbound_transfers", "has_more": false, "data": [ { "id": "ibt_1MtaDN2eZvKYlo2CxcxF1Qwi", "object": "treasury.inbound_transfer", "amount": 10000, "cancelable": true, "created": 1680716025, "currency": "usd", "description": "InboundTransfer from my bank account", "failure_details": null, "financial_account": "fa_1MtaDM2eZvKYlo2CvXrQknN4", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKPnhtqEGMgYYdf7K2aE6NpN7tVDs9F1hxjKU9i3In9yfJWRBNJycDGlZZ22xgY_IuRs_jih19J4q6c4yUsv0SimaA57pww", "linked_flows": { "received_debit": null }, "livemode": false, "metadata": {}, "origin_payment_method": "pm_1KMDdkGPnV27VyGeAgGz8bsi", "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": "AP24Iso0btGp4N10", "last4": "6789", "network": "ach", "routing_number": "110000000" } }, "returned": false, "statement_descriptor": "transfer", "status": "processing", "status_transitions": { "failed_at": null, "succeeded_at": null }, "transaction": "trxn_1MtaDM2eZvKYlo2CKxgPNzLa" } ]}
Cancels an InboundTransfer.
Parameters
No parameters.
Returns
Returns the InboundTransfer object if the cancellation succeeded. Returns an error if the InboundTransfer has already been canceled or cannot be canceled.
{ "id": "ibt_1MtaDN2eZvKYlo2CxcxF1Qwi", "object": "treasury.inbound_transfer", "amount": 10000, "cancelable": false, "created": 1680716025, "currency": "usd", "description": "InboundTransfer from my external bank account", "failure_details": null, "financial_account": "fa_1MtaDM2eZvKYlo2CvXrQknN4", "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKPnhtqEGMgZDF2WUT346NpP69bYKokqfNLTOb3qE8__DQL-vkc_p012AyYJYihh7UHvcsjvgXTDDkgEdUmHTimDXsAT0qA", "linked_flows": { "received_debit": null }, "livemode": false, "metadata": {}, "origin_payment_method": "pm_1MtaDN2eZvKYlo2CObQW5Wkv", "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": "AP24Iso0btGp4N10", "last4": "6789", "network": "ach", "routing_number": "110000000" } }, "returned": false, "statement_descriptor": "transfer", "status": "canceled", "status_transitions": { "posted_at": null, "failed_at": null, "canceled_at": 1680716025, "returned_at": null }, "transaction": "trxn_1MtaDM2eZvKYlo2CKxgPNzLa"}