Skip to content

Stripe: Treasury schemas

60 Stripe schemas with complete fields and constraints.

← Treasury operations · All schemas

Cancel an Inbound Transfer — response body

FieldTypePresenceDescription and constraints
$objectRootUse [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://docs.stripe.com/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)
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cancelablebooleanRequired within parentReturns `true` if the InboundTransfer is able to be canceled.
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
descriptionJSONOptional
description (anyOf 1)stringAlternativeAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
description (anyOf 2)nullAlternative
failure_detailsJSONOptional
failure_details (anyOf 1)JSONAlternativeDetails about this InboundTransfer's failure. Will be set when `status=failed` or `returned=true`.
failure_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel an Inbound Transfer — response body — failure details value code
failure_details (anyOf 2)nullAlternative
financial_accountstringRequired within parentThe FinancialAccount that received the funds.
Maximum length: 5000
hosted_regulatory_receipt_urlJSONOptional
hosted_regulatory_receipt_url (anyOf 1)stringAlternativeA [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
Maximum length: 5000
hosted_regulatory_receipt_url (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
linked_flowsModelRequired within parentExpand Cancel an Inbound Transfer — response body — linked flows
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.inbound_transfer
origin_payment_methodJSONOptional
origin_payment_method (anyOf 1)stringAlternativeThe origin payment method to be debited for an InboundTransfer.
Maximum length: 5000
origin_payment_method (anyOf 2)nullAlternative
origin_payment_method_detailsJSONOptional
origin_payment_method_details (anyOf 1)JSONAlternativeDetails about the PaymentMethod for an InboundTransfer.
origin_payment_method_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account
origin_payment_method_details (anyOf 2)nullAlternative
returnedJSONOptional
returned (anyOf 1)booleanAlternativeReturns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.
returned (anyOf 2)nullAlternative
statement_descriptorstringRequired within parentStatement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.
Maximum length: 5000
statusstringRequired within parentStatus 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.
Known values: canceled, failed, processing, succeeded
status_transitionsModelRequired within parentExpand Cancel an Inbound Transfer — response body — status transitions
transactionJSONOptional
transaction (anyOf 1)JSONAlternativeThe Transaction associated with this object.
transaction (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body
transaction (anyOf 2)nullAlternative

Referenced models: Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account, Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Cancel an Inbound Transfer — response body — failure details value code, Cancel an Inbound Transfer — response body — linked flows, Cancel an Inbound Transfer — response body — status transitions

Cancel an Inbound Transfer — response body — failure details value code

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentReason for the failure.
Known values: account_closed, account_frozen, bank_account_restricted, bank_ownership_changed, debit_not_authorized, incorrect_account_holder_address, incorrect_account_holder_name, incorrect_account_holder_tax_id, insufficient_funds, invalid_account_number, invalid_currency, no_account, other

Cancel an Inbound Transfer — response body — linked flows

FieldTypePresenceDescription and constraints
$objectRoot
received_debitJSONOptional
received_debit (anyOf 1)stringAlternativeIf funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.
Maximum length: 5000
received_debit (anyOf 2)nullAlternative

Cancel an Inbound Transfer — response body — status transitions

FieldTypePresenceDescription and constraints
$objectRoot
canceled_atJSONOptional
canceled_at (anyOf 1)JSONAlternative
canceled_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an InboundTransfer changed status to `canceled`.
Format: unix-time
canceled_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canceled_at (anyOf 2)nullAlternative
failed_atJSONOptional
failed_at (anyOf 1)JSONAlternative
failed_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an InboundTransfer changed status to `failed`.
Format: unix-time
failed_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
failed_at (anyOf 2)nullAlternative
succeeded_atJSONOptional
succeeded_at (anyOf 1)JSONAlternative
succeeded_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an InboundTransfer changed status to `succeeded`.
Format: unix-time
succeeded_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
succeeded_at (anyOf 2)nullAlternative

Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account

FieldTypePresenceDescription and constraints
$objectRoot
billing_detailsModelRequired within parentExpand Retrieve a Received Debit — response body — initiating payment method details billing details
typestringRequired within parentThe type of the payment method used in the InboundTransfer.
Known values: us_bank_account
us_bank_accountModelOptionalExpand Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account us bank account

Referenced models: Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account us bank account, Retrieve a Received Debit — response body — initiating payment method details billing details

Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account us bank account

FieldTypePresenceDescription and constraints
$objectRoot
account_holder_typeJSONOptional
account_holder_type (anyOf 1)stringAlternativeAccount holder type: individual or company.
Known values: company, individual
account_holder_type (anyOf 2)nullAlternative
account_typeJSONOptional
account_type (anyOf 1)stringAlternativeAccount type: checkings or savings. Defaults to checking if omitted.
Known values: checking, savings
account_type (anyOf 2)nullAlternative
bank_nameJSONOptional
bank_name (anyOf 1)stringAlternativeName of the bank associated with the bank account.
Maximum length: 5000
bank_name (anyOf 2)nullAlternative
fingerprintJSONOptional
fingerprint (anyOf 1)stringAlternativeUniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Maximum length: 5000
fingerprint (anyOf 2)nullAlternative
last4JSONOptional
last4 (anyOf 1)stringAlternativeLast four digits of the bank account number.
Maximum length: 5000
last4 (anyOf 2)nullAlternative
mandateJSONOptionalID of the mandate used to make this payment.
mandate (anyOf 1)stringAlternativeMaximum length: 5000
mandate (anyOf 2)ModelAlternativeExpand Retrieve a Mandate — response body
networkstringRequired within parentThe network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
Known values: ach
routing_numberJSONOptional
routing_number (anyOf 1)stringAlternativeRouting number of the bank account.
Maximum length: 5000
routing_number (anyOf 2)nullAlternative

Referenced models: Retrieve a Mandate — response body

Cancel an Outbound Payment — response body

FieldTypePresenceDescription and constraints
$objectRootUse [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://docs.stripe.com/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://docs.stripe.com/api#outbound_transfers).

Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.

Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cancelablebooleanRequired within parentReturns `true` if the object can be canceled, and `false` otherwise.
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
customerJSONOptional
customer (anyOf 1)stringAlternativeID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent.
Maximum length: 5000
customer (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
description (anyOf 2)nullAlternative
destination_payment_methodJSONOptional
destination_payment_method (anyOf 1)stringAlternativeThe PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.
Maximum length: 5000
destination_payment_method (anyOf 2)nullAlternative
destination_payment_method_detailsJSONOptional
destination_payment_method_details (anyOf 1)JSONAlternativeDetails about the PaymentMethod for an OutboundPayment.
destination_payment_method_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel an OutboundPayment — response body — destination_payment_method_details / value / type: financial account, us bank account
destination_payment_method_details (anyOf 2)nullAlternative
end_user_detailsJSONOptional
end_user_details (anyOf 1)JSONAlternativeDetails about the end user.
end_user_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel an Outbound Payment — response body — end user details Details about the end user ip address, present
end_user_details (anyOf 2)nullAlternative
expected_arrival_dateJSONRequired within parent
expected_arrival_date (anyOf 1)integerAlternativeThe date when funds are expected to arrive in the destination account.
Format: unix-time
expected_arrival_date (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
financial_accountstringRequired within parentThe FinancialAccount that funds were pulled from.
Maximum length: 5000
hosted_regulatory_receipt_urlJSONOptional
hosted_regulatory_receipt_url (anyOf 1)stringAlternativeA [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
Maximum length: 5000
hosted_regulatory_receipt_url (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.outbound_payment
returned_detailsJSONOptional
returned_details (anyOf 1)JSONAlternativeDetails about a returned OutboundPayment. Only set when the status is `returned`.
returned_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel an Outbound Payment — response body — returned details value code, transaction
returned_details (anyOf 2)nullAlternative
statement_descriptorstringRequired within parentThe description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
Maximum length: 5000
statusstringRequired within parentCurrent status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.
Known values: canceled, failed, posted, processing, returned
status_transitionsModelRequired within parentExpand Cancel an Outbound Payment — response body — status transitions
tracking_detailsJSONOptional
tracking_details (anyOf 1)JSONAlternativeDetails about network-specific tracking information if available.
tracking_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire
tracking_details (anyOf 2)nullAlternative
transactionJSONRequired within parentThe Transaction associated with this object.
transaction (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Referenced models: Cancel an OutboundPayment — response body — destination_payment_method_details / value / type: financial account, us bank account, Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Cancel an Outbound Payment — response body — end user details Details about the end user ip address, present, Cancel an Outbound Payment — response body — status transitions, Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire, Cancel an Outbound Payment — response body — returned details value code, transaction

Cancel an Outbound Payment — response body — end user details Details about the end user ip address, present

FieldTypePresenceDescription and constraints
$objectRoot
ip_addressJSONOptional
ip_address (anyOf 1)stringAlternativeIP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.
Maximum length: 5000
ip_address (anyOf 2)nullAlternative
presentbooleanRequired within parent`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.

Cancel an Outbound Payment — response body — returned details value code, transaction

FieldTypePresenceDescription and constraints
$objectRoot
codestringRequired within parentReason for the return.
Known values: account_closed, account_frozen, bank_account_restricted, bank_ownership_changed, declined, incorrect_account_holder_name, invalid_account_number, invalid_currency, no_account, other
transactionJSONRequired within parentThe Transaction associated with this object.
transaction (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Referenced models: Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Cancel an Outbound Payment — response body — status transitions

FieldTypePresenceDescription and constraints
$objectRoot
canceled_atJSONOptional
canceled_at (anyOf 1)JSONAlternative
canceled_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an OutboundPayment changed status to `canceled`.
Format: unix-time
canceled_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canceled_at (anyOf 2)nullAlternative
failed_atJSONOptional
failed_at (anyOf 1)JSONAlternative
failed_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an OutboundPayment changed status to `failed`.
Format: unix-time
failed_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
failed_at (anyOf 2)nullAlternative
posted_atJSONOptional
posted_at (anyOf 1)JSONAlternative
posted_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an OutboundPayment changed status to `posted`.
Format: unix-time
posted_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
posted_at (anyOf 2)nullAlternative
returned_atJSONOptional
returned_at (anyOf 1)JSONAlternative
returned_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an OutboundPayment changed status to `returned`.
Format: unix-time
returned_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
returned_at (anyOf 2)nullAlternative

Cancel an Outbound Transfer — response body

FieldTypePresenceDescription and constraints
$objectRootUse [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://docs.stripe.com/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://docs.stripe.com/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)
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cancelablebooleanRequired within parentReturns `true` if the object can be canceled, and `false` otherwise.
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
descriptionJSONOptional
description (anyOf 1)stringAlternativeAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
description (anyOf 2)nullAlternative
destination_payment_methodJSONOptional
destination_payment_method (anyOf 1)stringAlternativeThe PaymentMethod used as the payment instrument for an OutboundTransfer.
Maximum length: 5000
destination_payment_method (anyOf 2)nullAlternative
destination_payment_method_detailsModelRequired within parentExpand Cancel an Outbound Transfer — response body — destination payment method details
expected_arrival_dateJSONRequired within parent
expected_arrival_date (anyOf 1)integerAlternativeThe date when funds are expected to arrive in the destination account.
Format: unix-time
expected_arrival_date (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
financial_accountstringRequired within parentThe FinancialAccount that funds were pulled from.
Maximum length: 5000
hosted_regulatory_receipt_urlJSONOptional
hosted_regulatory_receipt_url (anyOf 1)stringAlternativeA [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
Maximum length: 5000
hosted_regulatory_receipt_url (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.outbound_transfer
returned_detailsJSONOptional
returned_details (anyOf 1)JSONAlternativeDetails about a returned OutboundTransfer. Only set when the status is `returned`.
returned_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel an Outbound Payment — response body — returned details value code, transaction
returned_details (anyOf 2)nullAlternative
statement_descriptorstringRequired within parentInformation about the OutboundTransfer to be sent to the recipient account.
Maximum length: 5000
statusstringRequired within parentCurrent 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`.
Known values: canceled, failed, posted, processing, returned
status_transitionsModelRequired within parentExpand Cancel an Outbound Transfer — response body — status transitions
tracking_detailsJSONOptional
tracking_details (anyOf 1)JSONAlternativeDetails about network-specific tracking information if available.
tracking_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire
tracking_details (anyOf 2)nullAlternative
transactionJSONRequired within parentThe Transaction associated with this object.
transaction (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body

Referenced models: Cancel an Outbound Transfer — response body — destination payment method details, Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Cancel an Outbound Payment — response body — returned details value code, transaction, Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire, Cancel an Outbound Transfer — response body — status transitions

Cancel an Outbound Transfer — response body — destination payment method details

FieldTypePresenceDescription and constraints
$objectRoot
billing_detailsModelRequired within parentExpand Retrieve a Received Debit — response body — initiating payment method details billing details
financial_accountModelOptionalExpand Cancel an Outbound Transfer — response body — destination payment method details financial account
typestringRequired within parentThe type of the payment method used in the OutboundTransfer.
Known values: financial_account, us_bank_account
us_bank_accountModelOptionalExpand Cancel an Outbound Transfer — response body — destination payment method details us bank account

Referenced models: Cancel an Outbound Transfer — response body — destination payment method details financial account, Cancel an Outbound Transfer — response body — destination payment method details us bank account, Retrieve a Received Debit — response body — initiating payment method details billing details

Cancel an Outbound Transfer — response body — destination payment method details financial account

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentToken of the FinancialAccount.
Maximum length: 5000
networkstringRequired within parentThe rails used to send funds.
Known values: stripe

Cancel an Outbound Transfer — response body — destination payment method details us bank account

FieldTypePresenceDescription and constraints
$objectRoot
account_holder_typeJSONOptional
account_holder_type (anyOf 1)stringAlternativeAccount holder type: individual or company.
Known values: company, individual
account_holder_type (anyOf 2)nullAlternative
account_typeJSONOptional
account_type (anyOf 1)stringAlternativeAccount type: checkings or savings. Defaults to checking if omitted.
Known values: checking, savings
account_type (anyOf 2)nullAlternative
bank_nameJSONOptional
bank_name (anyOf 1)stringAlternativeName of the bank associated with the bank account.
Maximum length: 5000
bank_name (anyOf 2)nullAlternative
fingerprintJSONOptional
fingerprint (anyOf 1)stringAlternativeUniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Maximum length: 5000
fingerprint (anyOf 2)nullAlternative
last4JSONOptional
last4 (anyOf 1)stringAlternativeLast four digits of the bank account number.
Maximum length: 5000
last4 (anyOf 2)nullAlternative
mandateJSONOptionalID of the mandate used to make this payment.
mandate (anyOf 1)stringAlternativeMaximum length: 5000
mandate (anyOf 2)ModelAlternativeExpand Retrieve a Mandate — response body
networkstringRequired within parentThe network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
Known values: ach, us_domestic_wire
routing_numberJSONOptional
routing_number (anyOf 1)stringAlternativeRouting number of the bank account.
Maximum length: 5000
routing_number (anyOf 2)nullAlternative

Referenced models: Retrieve a Mandate — response body

Cancel an Outbound Transfer — response body — status transitions

FieldTypePresenceDescription and constraints
$objectRoot
canceled_atJSONOptional
canceled_at (anyOf 1)JSONAlternative
canceled_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an OutboundTransfer changed status to `canceled`
Format: unix-time
canceled_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
canceled_at (anyOf 2)nullAlternative
failed_atJSONOptional
failed_at (anyOf 1)JSONAlternative
failed_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an OutboundTransfer changed status to `failed`
Format: unix-time
failed_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
failed_at (anyOf 2)nullAlternative
posted_atJSONOptional
posted_at (anyOf 1)JSONAlternative
posted_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an OutboundTransfer changed status to `posted`
Format: unix-time
posted_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
posted_at (anyOf 2)nullAlternative
returned_atJSONOptional
returned_at (anyOf 1)JSONAlternative
returned_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when an OutboundTransfer changed status to `returned`
Format: unix-time
returned_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
returned_at (anyOf 2)nullAlternative

Cancel an OutboundPayment — response body — destination_payment_method_details / value / type: financial account, us bank account

FieldTypePresenceDescription and constraints
$objectRoot
billing_detailsModelRequired within parentExpand Retrieve a Received Debit — response body — initiating payment method details billing details
financial_accountModelOptionalExpand Cancel an Outbound Transfer — response body — destination payment method details financial account
typestringRequired within parentThe type of the payment method used in the OutboundPayment.
Known values: financial_account, us_bank_account
us_bank_accountModelOptionalExpand Cancel an Outbound Transfer — response body — destination payment method details us bank account

Referenced models: Cancel an Outbound Transfer — response body — destination payment method details financial account, Cancel an Outbound Transfer — response body — destination payment method details us bank account, Retrieve a Received Debit — response body — initiating payment method details billing details

Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire

FieldTypePresenceDescription and constraints
$objectRoot
achModelOptionalExpand Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire ach
typestringRequired within parentThe US bank account network used to send funds.
Known values: ach, us_domestic_wire
us_domestic_wireModelOptionalExpand Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire us domestic wire

Referenced models: Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire ach, Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire us domestic wire

Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire ach

FieldTypePresenceDescription and constraints
$objectRoot
trace_idstringRequired within parentACH trace ID of the OutboundPayment for payments sent over the `ach` network.
Maximum length: 5000

Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire us domestic wire

FieldTypePresenceDescription and constraints
$objectRoot
chipsJSONOptional
chips (anyOf 1)stringAlternativeCHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.
Maximum length: 5000
chips (anyOf 2)nullAlternative
imadJSONOptional
imad (anyOf 1)stringAlternativeIMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.
Maximum length: 5000
imad (anyOf 2)nullAlternative
omadJSONOptional
omad (anyOf 1)stringAlternativeOMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.
Maximum length: 5000
omad (anyOf 2)nullAlternative

Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire

FieldTypePresenceDescription and constraints
$objectRoot
achModelOptionalExpand Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire ach
typestringRequired within parentThe US bank account network used to send funds.
Known values: ach, us_domestic_wire
us_domestic_wireModelOptionalExpand Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire us domestic wire

Referenced models: Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire ach, Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire us domestic wire

Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire ach

FieldTypePresenceDescription and constraints
$objectRoot
trace_idstringRequired within parentACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.
Maximum length: 5000

Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire us domestic wire

FieldTypePresenceDescription and constraints
$objectRoot
chipsJSONOptional
chips (anyOf 1)stringAlternativeCHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
Maximum length: 5000
chips (anyOf 2)nullAlternative
imadJSONOptional
imad (anyOf 1)stringAlternativeIMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
Maximum length: 5000
imad (anyOf 2)nullAlternative
omadJSONOptional
omad (anyOf 1)stringAlternativeOMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.
Maximum length: 5000
omad (anyOf 2)nullAlternative

Close a Financial Account — response body

FieldTypePresenceDescription and constraints
$objectRootStripe Treasury for Platforms provides users with a container for money called a FinancialAccount that is separate from their Payments balance.
FinancialAccounts serve as the source and destination of Treasury for Platform’s money movement APIs.
active_featuresarrayOptionalThe array of paths to active Features in the Features hash.
active_features[]stringEach itemKnown values: card_issuing, deposit_insurance, financial_addresses.aba, financial_addresses.aba.forwarding, inbound_transfers.ach, intra_stripe_flows, outbound_payments.ach, outbound_payments.us_domestic_wire, outbound_transfers.ach, outbound_transfers.us_domestic_wire, remote_deposit_capture
balanceModelRequired within parentExpand Close a Financial Account — response body — balance
countrystringRequired within parentTwo-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Maximum length: 5000
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
featuresModelOptionalExpand Update Financial Account Features — response body
financial_addressesarrayRequired within parentThe set of credentials that resolve to a FinancialAccount.
financial_addresses[]ModelEach itemExpand Close a Financial Account — response body — financial addresses item
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
is_defaultbooleanOptional
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataJSONOptional
metadata (anyOf 1)objectAlternativeSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata (anyOf 1).*stringAdditional keysMaximum length: 500
metadata (anyOf 2)nullAlternative
nicknameJSONOptional
nickname (anyOf 1)stringAlternativeThe nickname for the FinancialAccount.
Maximum length: 5000
nickname (anyOf 2)nullAlternative
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.financial_account
pending_featuresarrayOptionalThe array of paths to pending Features in the Features hash.
pending_features[]stringEach itemKnown values: card_issuing, deposit_insurance, financial_addresses.aba, financial_addresses.aba.forwarding, inbound_transfers.ach, intra_stripe_flows, outbound_payments.ach, outbound_payments.us_domestic_wire, outbound_transfers.ach, outbound_transfers.us_domestic_wire, remote_deposit_capture
platform_restrictionsJSONOptional
platform_restrictions (anyOf 1)JSONAlternativeThe set of functionalities that the platform can restrict on the FinancialAccount.
platform_restrictions (anyOf 1) (anyOf 1)ModelAlternativeExpand Close a Financial Account — response body — platform restrictions value inbound flows, outbound flows
platform_restrictions (anyOf 2)nullAlternative
restricted_featuresarrayOptionalThe array of paths to restricted Features in the Features hash.
restricted_features[]stringEach itemKnown values: card_issuing, deposit_insurance, financial_addresses.aba, financial_addresses.aba.forwarding, inbound_transfers.ach, intra_stripe_flows, outbound_payments.ach, outbound_payments.us_domestic_wire, outbound_transfers.ach, outbound_transfers.us_domestic_wire, remote_deposit_capture
statusstringRequired within parentStatus of this FinancialAccount.
Known values: closed, open
status_detailsModelRequired within parentExpand Close a Financial Account — response body — status details
supported_currenciesarrayRequired within parentThe currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
supported_currencies[]stringEach item

Referenced models: Update Financial Account Features — response body, Close a Financial Account — response body — balance, Close a Financial Account — response body — financial addresses item, Close a Financial Account — response body — platform restrictions value inbound flows, outbound flows, Close a Financial Account — response body — status details

Close a Financial Account — response body — balance

FieldTypePresenceDescription and constraints
$objectRootBalance information for the FinancialAccount
cashobjectRequired within parentFunds the user can spend right now.
Additional keys: see wildcard field
cash.*JSONAdditional keys
cash.* (anyOf 1)integerAlternative
cash.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inbound_pendingobjectRequired within parentFunds not spendable yet, but will become available at a later time.
Additional keys: see wildcard field
inbound_pending.*JSONAdditional keys
inbound_pending.* (anyOf 1)integerAlternative
inbound_pending.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
outbound_pendingobjectRequired within parentFunds in the account, but not spendable because they are being held for pending outbound flows.
Additional keys: see wildcard field
outbound_pending.*JSONAdditional keys
outbound_pending.* (anyOf 1)integerAlternative
outbound_pending.* (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Close a Financial Account — response body — financial addresses item

FieldTypePresenceDescription and constraints
$objectRootFinancialAddresses contain identifying information that resolves to a FinancialAccount.
abaModelOptionalExpand Close a Financial Account — response body — financial addresses item aba
supported_networksarrayOptionalThe list of networks that the address supports
supported_networks[]stringEach itemKnown values: ach, rtp, us_domestic_wire
typestringRequired within parentThe type of financial address
Known values: aba

Referenced models: Close a Financial Account — response body — financial addresses item aba

Close a Financial Account — response body — financial addresses item aba

FieldTypePresenceDescription and constraints
$objectRootABA Records contain U.S. bank account details per the ABA format.
account_holder_namestringRequired within parentThe name of the person or business that owns the bank account.
Maximum length: 5000
account_numberJSONOptional
account_number (anyOf 1)stringAlternativeThe account number.
Maximum length: 5000
account_number (anyOf 2)nullAlternative
account_number_last4stringRequired within parentThe last four characters of the account number.
Maximum length: 5000
bank_namestringRequired within parentName of the bank.
Maximum length: 5000
routing_numberstringRequired within parentRouting number for the account.
Maximum length: 5000

Close a Financial Account — response body — platform restrictions value inbound flows, outbound flows

FieldTypePresenceDescription and constraints
$objectRootRestrictions that a Connect Platform has placed on this FinancialAccount.
inbound_flowsJSONOptional
inbound_flows (anyOf 1)stringAlternativeRestricts all inbound money movement.
Known values: restricted, unrestricted
inbound_flows (anyOf 2)nullAlternative
outbound_flowsJSONOptional
outbound_flows (anyOf 1)stringAlternativeRestricts all outbound money movement.
Known values: restricted, unrestricted
outbound_flows (anyOf 2)nullAlternative

Close a Financial Account — response body — status details

FieldTypePresenceDescription and constraints
$objectRoot
closedJSONOptional
closed (anyOf 1)JSONAlternativeDetails related to the closure of this FinancialAccount
closed (anyOf 1) (anyOf 1)ModelAlternativeExpand Close a Financial Account — response body — status details closed value reasons
closed (anyOf 2)nullAlternative

Referenced models: Close a Financial Account — response body — status details closed value reasons

Close a Financial Account — response body — status details closed value reasons

FieldTypePresenceDescription and constraints
$objectRoot
reasonsarrayRequired within parentThe array that contains reasons for a FinancialAccount closure.
reasons[]stringEach itemKnown values: account_rejected, closed_by_platform, other

Create a Credit Reversal — response body

FieldTypePresenceDescription and constraints
$objectRootYou can reverse some [ReceivedCredits](https://docs.stripe.com/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
financial_accountstringRequired within parentThe FinancialAccount to reverse funds from.
Maximum length: 5000
hosted_regulatory_receipt_urlJSONOptional
hosted_regulatory_receipt_url (anyOf 1)stringAlternativeA [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
Maximum length: 5000
hosted_regulatory_receipt_url (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
networkstringRequired within parentThe rails used to reverse the funds.
Known values: ach, stripe
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.credit_reversal
received_creditstringRequired within parentThe ReceivedCredit being reversed.
Maximum length: 5000
statusstringRequired within parentStatus of the CreditReversal
Known values: canceled, posted, processing
status_transitionsModelRequired within parentExpand Create a Credit Reversal — response body — status transitions
transactionJSONOptional
transaction (anyOf 1)JSONAlternativeThe Transaction associated with this object.
transaction (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body
transaction (anyOf 2)nullAlternative

Referenced models: Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Create a Credit Reversal — response body — status transitions

Create a Credit Reversal — response body — status transitions

FieldTypePresenceDescription and constraints
$objectRoot
posted_atJSONOptional
posted_at (anyOf 1)JSONAlternative
posted_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when the CreditReversal changed status to `posted`
Format: unix-time
posted_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
posted_at (anyOf 2)nullAlternative

Create a Debit Reversal — response body

FieldTypePresenceDescription and constraints
$objectRootYou can reverse some [ReceivedDebits](https://docs.stripe.com/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
financial_accountJSONOptional
financial_account (anyOf 1)stringAlternativeThe FinancialAccount to reverse funds from.
Maximum length: 5000
financial_account (anyOf 2)nullAlternative
hosted_regulatory_receipt_urlJSONOptional
hosted_regulatory_receipt_url (anyOf 1)stringAlternativeA [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
Maximum length: 5000
hosted_regulatory_receipt_url (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
linked_flowsJSONOptional
linked_flows (anyOf 1)JSONAlternativeOther flows linked to a DebitReversal.
linked_flows (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Debit Reversal — response body — linked flows Other flows linked to a Debit Reversal issuing dispute
linked_flows (anyOf 2)nullAlternative
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectRequired within parentSet of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Additional keys: see wildcard field
metadata.*stringAdditional keysMaximum length: 500
networkstringRequired within parentThe rails used to reverse the funds.
Known values: ach, card
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.debit_reversal
received_debitstringRequired within parentThe ReceivedDebit being reversed.
Maximum length: 5000
statusstringRequired within parentStatus of the DebitReversal
Known values: failed, processing, succeeded
status_transitionsModelRequired within parentExpand Create a Debit Reversal — response body — status transitions
transactionJSONOptional
transaction (anyOf 1)JSONAlternativeThe Transaction associated with this object.
transaction (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body
transaction (anyOf 2)nullAlternative

Referenced models: Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Create a Debit Reversal — response body — linked flows Other flows linked to a Debit Reversal issuing dispute, Create a Debit Reversal — response body — status transitions

Create a Debit Reversal — response body — linked flows Other flows linked to a Debit Reversal issuing dispute

FieldTypePresenceDescription and constraints
$objectRoot
issuing_disputeJSONOptional
issuing_dispute (anyOf 1)stringAlternativeSet if there is an Issuing dispute associated with the DebitReversal.
Maximum length: 5000
issuing_dispute (anyOf 2)nullAlternative

Create a Debit Reversal — response body — status transitions

FieldTypePresenceDescription and constraints
$objectRoot
completed_atJSONOptional
completed_at (anyOf 1)JSONAlternative
completed_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when the DebitReversal changed status to `completed`.
Format: unix-time
completed_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
completed_at (anyOf 2)nullAlternative

Retrieve a Received Credit — response body

FieldTypePresenceDescription and constraints
$objectRootReceivedCredits represent funds sent to a [FinancialAccount](https://docs.stripe.com/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
descriptionstringRequired within parentAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
failure_codeJSONOptional
failure_code (anyOf 1)stringAlternativeReason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
Known values: account_closed, account_frozen, international_transaction, other
failure_code (anyOf 2)nullAlternative
financial_accountJSONOptional
financial_account (anyOf 1)stringAlternativeThe FinancialAccount that received the funds.
Maximum length: 5000
financial_account (anyOf 2)nullAlternative
hosted_regulatory_receipt_urlJSONOptional
hosted_regulatory_receipt_url (anyOf 1)stringAlternativeA [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
Maximum length: 5000
hosted_regulatory_receipt_url (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
initiating_payment_method_detailsModelRequired within parentExpand Retrieve a Received Debit — response body — initiating payment method details
linked_flowsModelRequired within parentExpand Retrieve a Received Credit — response body — linked flows
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
networkstringRequired within parentThe rails used to send the funds.
Known values: ach, card, rtp, stripe, us_domestic_wire
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.received_credit
reversal_detailsJSONOptional
reversal_details (anyOf 1)JSONAlternativeDetails describing when a ReceivedCredit may be reversed.
reversal_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve a Received Credit — response body — reversal details value deadline, restricted reason
reversal_details (anyOf 2)nullAlternative
statusstringRequired within parentStatus of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
Known values: failed, succeeded
transactionJSONOptional
transaction (anyOf 1)JSONAlternativeThe Transaction associated with this object.
transaction (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body
transaction (anyOf 2)nullAlternative

Referenced models: Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Retrieve a Received Credit — response body — linked flows, Retrieve a Received Credit — response body — reversal details value deadline, restricted reason, Retrieve a Received Debit — response body — initiating payment method details

Retrieve a Received Credit — response body — linked flows

FieldTypePresenceDescription and constraints
$objectRoot
credit_reversalJSONOptional
credit_reversal (anyOf 1)stringAlternativeThe CreditReversal created as a result of this ReceivedCredit being reversed.
Maximum length: 5000
credit_reversal (anyOf 2)nullAlternative
issuing_authorizationJSONOptional
issuing_authorization (anyOf 1)stringAlternativeSet if the ReceivedCredit was created due to an [Issuing Authorization](https://docs.stripe.com/api#issuing_authorizations) object.
Maximum length: 5000
issuing_authorization (anyOf 2)nullAlternative
issuing_transactionJSONOptional
issuing_transaction (anyOf 1)stringAlternativeSet if the ReceivedCredit is also viewable as an [Issuing transaction](https://docs.stripe.com/api#issuing_transactions) object.
Maximum length: 5000
issuing_transaction (anyOf 2)nullAlternative
source_flowJSONOptional
source_flow (anyOf 1)stringAlternativeID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
Maximum length: 5000
source_flow (anyOf 2)nullAlternative
source_flow_detailsJSONOptional
source_flow_details (anyOf 1)JSONAlternativeThe expandable object of the source flow.
source_flow_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve a ReceivedCredit — response body — linked_flows / source_flow_details / The expandable object of the source flow / type: credit reversal, other, outbound payment, outbound transfer, payout
source_flow_details (anyOf 2)nullAlternative
source_flow_typeJSONOptional
source_flow_type (anyOf 1)stringAlternativeThe type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
Maximum length: 5000
source_flow_type (anyOf 2)nullAlternative

Referenced models: Retrieve a ReceivedCredit — response body — linked_flows / source_flow_details / The expandable object of the source flow / type: credit reversal, other, outbound payment, outbound transfer, payout

Retrieve a Received Credit — response body — reversal details value deadline, restricted reason

FieldTypePresenceDescription and constraints
$objectRoot
deadlineJSONOptional
deadline (anyOf 1)JSONAlternative
deadline (anyOf 1) (anyOf 1)integerAlternativeTime before which a ReceivedCredit can be reversed.
Format: unix-time
deadline (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deadline (anyOf 2)nullAlternative
restricted_reasonJSONOptional
restricted_reason (anyOf 1)stringAlternativeSet if a ReceivedCredit cannot be reversed.
Known values: already_reversed, deadline_passed, network_restricted, other, source_flow_restricted
restricted_reason (anyOf 2)nullAlternative

Retrieve a Received Debit — response body

FieldTypePresenceDescription and constraints
$objectRootReceivedDebits represent funds pulled from a [FinancialAccount](https://docs.stripe.com/api#financial_accounts). These are not initiated from the FinancialAccount.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
descriptionstringRequired within parentAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
failure_codeJSONOptional
failure_code (anyOf 1)stringAlternativeReason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.
Known values: account_closed, account_frozen, insufficient_funds, international_transaction, other
failure_code (anyOf 2)nullAlternative
financial_accountJSONOptional
financial_account (anyOf 1)stringAlternativeThe FinancialAccount that funds were pulled from.
Maximum length: 5000
financial_account (anyOf 2)nullAlternative
hosted_regulatory_receipt_urlJSONOptional
hosted_regulatory_receipt_url (anyOf 1)stringAlternativeA [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
Maximum length: 5000
hosted_regulatory_receipt_url (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
initiating_payment_method_detailsModelOptionalExpand Retrieve a Received Debit — response body — initiating payment method details
linked_flowsModelRequired within parentExpand Retrieve a Received Debit — response body — linked flows
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
networkstringRequired within parentThe network used for the ReceivedDebit.
Known values: ach, card, stripe
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.received_debit
reversal_detailsJSONOptional
reversal_details (anyOf 1)JSONAlternativeDetails describing when a ReceivedDebit might be reversed.
reversal_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve a Received Debit — response body — reversal details value deadline, restricted reason
reversal_details (anyOf 2)nullAlternative
statusstringRequired within parentStatus of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.
Known values: failed, succeeded
transactionJSONOptional
transaction (anyOf 1)JSONAlternativeThe Transaction associated with this object.
transaction (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body
transaction (anyOf 2)nullAlternative

Referenced models: Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Retrieve a Received Debit — response body — linked flows, Retrieve a Received Debit — response body — reversal details value deadline, restricted reason, Retrieve a Received Debit — response body — initiating payment method details

Retrieve a Received Debit — response body — initiating payment method details

FieldTypePresenceDescription and constraints
$objectRoot
balancestringOptionalSet when `type` is `balance`.
Known values: payments
billing_detailsModelRequired within parentExpand Retrieve a Received Debit — response body — initiating payment method details billing details
financial_accountModelOptionalExpand Retrieve a Received Debit — response body — initiating payment method details financial account
issuing_cardstringOptionalSet when `type` is `issuing_card`. This is an [Issuing Card](https://docs.stripe.com/api#issuing_cards) ID.
Maximum length: 5000
typestringRequired within parentPolymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
Known values: balance, financial_account, issuing_card, stripe, us_bank_account
us_bank_accountModelOptionalExpand Retrieve a Received Debit — response body — initiating payment method details us bank account

Referenced models: Retrieve a Received Debit — response body — initiating payment method details financial account, Retrieve a Received Debit — response body — initiating payment method details billing details, Retrieve a Received Debit — response body — initiating payment method details us bank account

Retrieve a Received Debit — response body — initiating payment method details billing details

FieldTypePresenceDescription and constraints
$objectRoot
addressModelRequired within parentExpand Create a Location — response body — address
emailJSONOptional
email (anyOf 1)stringAlternativeEmail address.
Maximum length: 5000
email (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeFull name.
Maximum length: 5000
name (anyOf 2)nullAlternative

Referenced models: Create a Location — response body — address

Retrieve a Received Debit — response body — initiating payment method details financial account

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe FinancialAccount ID.
Maximum length: 5000
networkstringRequired within parentThe rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
Known values: stripe

Retrieve a Received Debit — response body — initiating payment method details us bank account

FieldTypePresenceDescription and constraints
$objectRoot
bank_nameJSONOptional
bank_name (anyOf 1)stringAlternativeBank name.
Maximum length: 5000
bank_name (anyOf 2)nullAlternative
last4JSONOptional
last4 (anyOf 1)stringAlternativeThe last four digits of the bank account number.
Maximum length: 5000
last4 (anyOf 2)nullAlternative
routing_numberJSONOptional
routing_number (anyOf 1)stringAlternativeThe routing number for the bank account.
Maximum length: 5000
routing_number (anyOf 2)nullAlternative

Retrieve a Received Debit — response body — linked flows

FieldTypePresenceDescription and constraints
$objectRoot
debit_reversalJSONOptional
debit_reversal (anyOf 1)stringAlternativeThe DebitReversal created as a result of this ReceivedDebit being reversed.
Maximum length: 5000
debit_reversal (anyOf 2)nullAlternative
inbound_transferJSONOptional
inbound_transfer (anyOf 1)stringAlternativeSet if the ReceivedDebit is associated with an InboundTransfer's return of funds.
Maximum length: 5000
inbound_transfer (anyOf 2)nullAlternative
issuing_authorizationJSONOptional
issuing_authorization (anyOf 1)stringAlternativeSet if the ReceivedDebit was created due to an [Issuing Authorization](https://docs.stripe.com/api#issuing_authorizations) object.
Maximum length: 5000
issuing_authorization (anyOf 2)nullAlternative
issuing_transactionJSONOptional
issuing_transaction (anyOf 1)stringAlternativeSet if the ReceivedDebit is also viewable as an [Issuing Dispute](https://docs.stripe.com/api#issuing_disputes) object.
Maximum length: 5000
issuing_transaction (anyOf 2)nullAlternative
payoutJSONOptional
payout (anyOf 1)stringAlternativeSet if the ReceivedDebit was created due to a [Payout](https://docs.stripe.com/api#payouts) object.
Maximum length: 5000
payout (anyOf 2)nullAlternative
topupJSONOptional
topup (anyOf 1)stringAlternativeSet if the ReceivedDebit was created due to a [Topup](https://docs.stripe.com/api#topups) object.
Maximum length: 5000
topup (anyOf 2)nullAlternative

Retrieve a Received Debit — response body — reversal details value deadline, restricted reason

FieldTypePresenceDescription and constraints
$objectRoot
deadlineJSONOptional
deadline (anyOf 1)JSONAlternative
deadline (anyOf 1) (anyOf 1)integerAlternativeTime before which a ReceivedDebit can be reversed.
Format: unix-time
deadline (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deadline (anyOf 2)nullAlternative
restricted_reasonJSONOptional
restricted_reason (anyOf 1)stringAlternativeSet if a ReceivedDebit can't be reversed.
Known values: already_reversed, deadline_passed, network_restricted, other, source_flow_restricted
restricted_reason (anyOf 2)nullAlternative

Retrieve a ReceivedCredit — response body — linked_flows / source_flow_details / The expandable object of the source flow / type: credit reversal, other, outbound payment, outbound transfer, payout

FieldTypePresenceDescription and constraints
$objectRoot
credit_reversalModelOptionalExpand Create a Credit Reversal — response body
outbound_paymentModelOptionalExpand Cancel an Outbound Payment — response body
outbound_transferModelOptionalExpand Cancel an Outbound Transfer — response body
payoutModelOptionalExpand Cancel a payout — response body
typestringRequired within parentThe type of the source flow that originated the ReceivedCredit.
Known values: credit_reversal, other, outbound_payment, outbound_transfer, payout

Referenced models: Cancel a payout — response body, Create a Credit Reversal — response body, Cancel an Outbound Payment — response body, Cancel an Outbound Transfer — response body

Retrieve a Transaction Entry — response body

FieldTypePresenceDescription and constraints
$objectRootTransactionEntries represent individual units of money movements within a single [Transaction](https://docs.stripe.com/api#transactions).
balance_impactModelRequired within parentExpand Retrieve a Transaction Entry — response body — balance impact
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
effective_atJSONRequired within parent
effective_at (anyOf 1)integerAlternativeWhen the TransactionEntry will impact the FinancialAccount's balance.
Format: unix-time
effective_at (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
financial_accountstringRequired within parentThe FinancialAccount associated with this object.
Maximum length: 5000
flowJSONOptional
flow (anyOf 1)stringAlternativeToken of the flow associated with the TransactionEntry.
Maximum length: 5000
flow (anyOf 2)nullAlternative
flow_detailsJSONOptional
flow_details (anyOf 1)JSONAlternativeDetails of the flow associated with the TransactionEntry.
flow_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve a Transaction Entry — response body — flow details value credit reversal, debit reversal, inbound transfer, issuing authorization, outbound payment, outbound transfer, received credit, received debit, type
flow_details (anyOf 2)nullAlternative
flow_typestringRequired within parentType of the flow associated with the TransactionEntry.
Known values: credit_reversal, debit_reversal, inbound_transfer, issuing_authorization, other, outbound_payment, outbound_transfer, received_credit, received_debit
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.transaction_entry
transactionJSONRequired within parentThe Transaction associated with this object.
transaction (anyOf 1)stringAlternativeMaximum length: 5000
transaction (anyOf 2)ModelAlternativeExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body
typestringRequired within parentThe specific money movement that generated the TransactionEntry.
Known values: credit_reversal, credit_reversal_posting, debit_reversal, inbound_transfer, inbound_transfer_return, issuing_authorization_hold, issuing_authorization_release, other, outbound_payment, outbound_payment_cancellation, outbound_payment_failure, outbound_payment_posting, outbound_payment_return, outbound_transfer, outbound_transfer_cancellation, outbound_transfer_failure, outbound_transfer_posting, outbound_transfer_return, received_credit, received_debit

Referenced models: Retrieve a Transaction — treasury get Treasury Transactions Id — response body, Retrieve a Transaction Entry — response body — balance impact, Retrieve a Transaction Entry — response body — flow details value credit reversal, debit reversal, inbound transfer, issuing authorization, outbound payment, outbound transfer, received credit, received debit, type

Retrieve a Transaction Entry — response body — balance impact

FieldTypePresenceDescription and constraints
$objectRootChange to a FinancialAccount's balance
cashJSONRequired within parent
cash (anyOf 1)integerAlternativeThe change made to funds the user can spend right now.
cash (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inbound_pendingJSONRequired within parent
inbound_pending (anyOf 1)integerAlternativeThe change made to funds that are not spendable yet, but will become available at a later time.
inbound_pending (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
outbound_pendingJSONRequired within parent
outbound_pending (anyOf 1)integerAlternativeThe change made to funds in the account, but not spendable because they are being held for pending outbound flows.
outbound_pending (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a Transaction Entry — response body — flow details value credit reversal, debit reversal, inbound transfer, issuing authorization, outbound payment, outbound transfer, received credit, received debit, type

FieldTypePresenceDescription and constraints
$objectRoot
credit_reversalModelOptionalExpand Create a Credit Reversal — response body
debit_reversalModelOptionalExpand Create a Debit Reversal — response body
inbound_transferModelOptionalExpand Cancel an Inbound Transfer — response body
issuing_authorizationModelOptionalExpand Update an authorization — response body
outbound_paymentModelOptionalExpand Cancel an Outbound Payment — response body
outbound_transferModelOptionalExpand Cancel an Outbound Transfer — response body
received_creditModelOptionalExpand Retrieve a Received Credit — response body
received_debitModelOptionalExpand Retrieve a Received Debit — response body
typestringRequired within parentType of the flow that created the Transaction. Set to the same value as `flow_type`.
Known values: credit_reversal, debit_reversal, inbound_transfer, issuing_authorization, other, outbound_payment, outbound_transfer, received_credit, received_debit

Referenced models: Update an authorization — response body, Create a Credit Reversal — response body, Create a Debit Reversal — response body, Cancel an Inbound Transfer — response body, Cancel an Outbound Payment — response body, Cancel an Outbound Transfer — response body, Retrieve a Received Credit — response body, Retrieve a Received Debit — response body

Retrieve a Transaction — treasury get Treasury Transactions Id — response body

FieldTypePresenceDescription and constraints
$objectRootTransactions represent changes to a [FinancialAccount's](https://docs.stripe.com/api#financial_accounts) balance.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount (in cents) transferred.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balance_impactModelRequired within parentExpand Retrieve a Transaction Entry — response body — balance impact
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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).
Format: currency
descriptionstringRequired within parentAn arbitrary string attached to the object. Often useful for displaying to users.
Maximum length: 5000
entriesJSONOptional
entries (anyOf 1)objectAlternativeA list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
entries (anyOf 1).dataarrayRequired within parentDetails about each object.
entries (anyOf 1).data[]ModelEach itemExpand Retrieve a Transaction Entry — response body
entries (anyOf 1).has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
entries (anyOf 1).objectstringRequired within parentString representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Known values: list
entries (anyOf 1).urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000
Pattern: ^/v1/treasury/transaction_entries
entries (anyOf 2)nullAlternative
financial_accountstringRequired within parentThe FinancialAccount associated with this object.
Maximum length: 5000
flowJSONOptional
flow (anyOf 1)stringAlternativeID of the flow that created the Transaction.
Maximum length: 5000
flow (anyOf 2)nullAlternative
flow_detailsJSONOptional
flow_details (anyOf 1)JSONAlternativeDetails of the flow that created the Transaction.
flow_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve a Transaction Entry — response body — flow details value credit reversal, debit reversal, inbound transfer, issuing authorization, outbound payment, outbound transfer, received credit, received debit, type
flow_details (anyOf 2)nullAlternative
flow_typestringRequired within parentType of the flow that created the Transaction.
Known values: credit_reversal, debit_reversal, inbound_transfer, issuing_authorization, other, outbound_payment, outbound_transfer, received_credit, received_debit
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.transaction
statusstringRequired within parentStatus of the Transaction.
Known values: open, posted, void
status_transitionsModelRequired within parentExpand Retrieve a Transaction — treasury get Treasury Transactions Id — response body — status transitions

Referenced models: Retrieve a Transaction Entry — response body, Retrieve a Transaction — treasury get Treasury Transactions Id — response body — status transitions, Retrieve a Transaction Entry — response body — balance impact, Retrieve a Transaction Entry — response body — flow details value credit reversal, debit reversal, inbound transfer, issuing authorization, outbound payment, outbound transfer, received credit, received debit, type

Retrieve a Transaction — treasury get Treasury Transactions Id — response body — status transitions

FieldTypePresenceDescription and constraints
$objectRoot
posted_atJSONOptional
posted_at (anyOf 1)JSONAlternative
posted_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when the Transaction changed status to `posted`.
Format: unix-time
posted_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
posted_at (anyOf 2)nullAlternative
void_atJSONOptional
void_at (anyOf 1)JSONAlternative
void_at (anyOf 1) (anyOf 1)integerAlternativeTimestamp describing when the Transaction changed status to `void`.
Format: unix-time
void_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
void_at (anyOf 2)nullAlternative

Update Financial Account Features — response body

FieldTypePresenceDescription and constraints
$objectRootEncodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
Stripe or the platform can control Features via the requested field.
card_issuingModelOptionalExpand Update Financial Account Features — response body — card issuing
deposit_insuranceModelOptionalExpand Update Financial Account Features — response body — card issuing
financial_addressesModelOptionalExpand Update Financial Account Features — response body — financial addresses
inbound_transfersModelOptionalExpand Update Financial Account Features — response body — inbound transfers
intra_stripe_flowsModelOptionalExpand Update Financial Account Features — response body — card issuing
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: treasury.financial_account_features
outbound_paymentsModelOptionalExpand Update Financial Account Features — response body — outbound payments
outbound_transfersModelOptionalExpand Update Financial Account Features — response body — outbound transfers

Referenced models: Update Financial Account Features — response body — financial addresses, Update Financial Account Features — response body — inbound transfers, Update Financial Account Features — response body — outbound payments, Update Financial Account Features — response body — outbound transfers, Update Financial Account Features — response body — card issuing

Update Financial Account Features — response body — card issuing

FieldTypePresenceDescription and constraints
$objectRootToggle settings for enabling/disabling a feature
requestedbooleanRequired within parentWhether the FinancialAccount should have the Feature.
statusstringRequired within parentWhether the Feature is operational.
Known values: active, pending, restricted
status_detailsarrayRequired within parentAdditional details; includes at least one entry when the status is not `active`.
status_details[]ModelEach itemExpand Update Financial Account Features — response body — card issuing status details item

Referenced models: Update Financial Account Features — response body — card issuing status details item

Update Financial Account Features — response body — card issuing status details item

FieldTypePresenceDescription and constraints
$objectRootAdditional details on the FinancialAccount Features information.
codestringRequired within parentRepresents the reason why the status is `pending` or `restricted`.
Known values: activating, capability_not_requested, financial_account_closed, rejected_other, rejected_unsupported_business, requirements_past_due, requirements_pending_verification, restricted_by_platform, restricted_other
resolutionJSONOptional
resolution (anyOf 1)stringAlternativeRepresents what the user should do, if anything, to activate the Feature.
Known values: contact_stripe, provide_information, remove_restriction
resolution (anyOf 2)nullAlternative
restrictionstringOptionalThe `platform_restrictions` that are restricting this Feature.
Known values: inbound_flows, outbound_flows

Update Financial Account Features — response body — financial addresses

FieldTypePresenceDescription and constraints
$objectRootSettings related to Financial Addresses features on a Financial Account
abaModelOptionalExpand Update Financial Account Features — response body — financial addresses aba

Referenced models: Update Financial Account Features — response body — financial addresses aba

Update Financial Account Features — response body — financial addresses aba

FieldTypePresenceDescription and constraints
$objectRootToggle settings for enabling/disabling the ABA address feature
requestedbooleanRequired within parentWhether the FinancialAccount should have the Feature.
statusstringRequired within parentWhether the Feature is operational.
Known values: active, pending, restricted
status_detailsarrayRequired within parentAdditional details; includes at least one entry when the status is not `active`.
status_details[]ModelEach itemExpand Update Financial Account Features — response body — card issuing status details item

Referenced models: Update Financial Account Features — response body — card issuing status details item

Update Financial Account Features — response body — inbound transfers

FieldTypePresenceDescription and constraints
$objectRootInboundTransfers contains inbound transfers features for a FinancialAccount.
achModelOptionalExpand Update Financial Account Features — response body — inbound transfers ach

Referenced models: Update Financial Account Features — response body — inbound transfers ach

Update Financial Account Features — response body — inbound transfers ach

FieldTypePresenceDescription and constraints
$objectRootToggle settings for enabling/disabling an inbound ACH specific feature
requestedbooleanRequired within parentWhether the FinancialAccount should have the Feature.
statusstringRequired within parentWhether the Feature is operational.
Known values: active, pending, restricted
status_detailsarrayRequired within parentAdditional details; includes at least one entry when the status is not `active`.
status_details[]ModelEach itemExpand Update Financial Account Features — response body — card issuing status details item

Referenced models: Update Financial Account Features — response body — card issuing status details item

Update Financial Account Features — response body — outbound payments

FieldTypePresenceDescription and constraints
$objectRootSettings related to Outbound Payments features on a Financial Account
achModelOptionalExpand Update Financial Account Features — response body — outbound payments ach
us_domestic_wireModelOptionalExpand Update Financial Account Features — response body — card issuing

Referenced models: Update Financial Account Features — response body — outbound payments ach, Update Financial Account Features — response body — card issuing

Update Financial Account Features — response body — outbound payments ach

FieldTypePresenceDescription and constraints
$objectRootToggle settings for enabling/disabling an outbound ACH specific feature
requestedbooleanRequired within parentWhether the FinancialAccount should have the Feature.
statusstringRequired within parentWhether the Feature is operational.
Known values: active, pending, restricted
status_detailsarrayRequired within parentAdditional details; includes at least one entry when the status is not `active`.
status_details[]ModelEach itemExpand Update Financial Account Features — response body — card issuing status details item

Referenced models: Update Financial Account Features — response body — card issuing status details item

Update Financial Account Features — response body — outbound transfers

FieldTypePresenceDescription and constraints
$objectRootOutboundTransfers contains outbound transfers features for a FinancialAccount.
achModelOptionalExpand Update Financial Account Features — response body — outbound payments ach
us_domestic_wireModelOptionalExpand Update Financial Account Features — response body — card issuing

Referenced models: Update Financial Account Features — response body — outbound payments ach, Update Financial Account Features — response body — card issuing

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.