Stripe: Treasury schemas
60 Stripe schemas with complete fields and constraints.
← Treasury operations · All schemas
Cancel an Inbound Transfer — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Use [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) |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount (in cents) transferred. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cancelable | boolean | Required within parent | Returns `true` if the InboundTransfer is able to be canceled. |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
failure_details | JSON | Optional | |
failure_details (anyOf 1) | JSON | Alternative | Details about this InboundTransfer's failure. Will be set when `status=failed` or `returned=true`. |
failure_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel an Inbound Transfer — response body — failure details value code |
failure_details (anyOf 2) | null | Alternative | |
financial_account | string | Required within parent | The FinancialAccount that received the funds. Maximum length: 5000 |
hosted_regulatory_receipt_url | JSON | Optional | |
hosted_regulatory_receipt_url (anyOf 1) | string | Alternative | A [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) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
linked_flows | Model | Required within parent | Expand Cancel an Inbound Transfer — response body — linked flows |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set 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.* | string | Additional keys | Maximum length: 500 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.inbound_transfer |
origin_payment_method | JSON | Optional | |
origin_payment_method (anyOf 1) | string | Alternative | The origin payment method to be debited for an InboundTransfer. Maximum length: 5000 |
origin_payment_method (anyOf 2) | null | Alternative | |
origin_payment_method_details | JSON | Optional | |
origin_payment_method_details (anyOf 1) | JSON | Alternative | Details about the PaymentMethod for an InboundTransfer. |
origin_payment_method_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account |
origin_payment_method_details (anyOf 2) | null | Alternative | |
returned | JSON | Optional | |
returned (anyOf 1) | boolean | Alternative | Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. |
returned (anyOf 2) | null | Alternative | |
statement_descriptor | string | Required within parent | Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`. Maximum length: 5000 |
status | string | Required within parent | Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails. Known values: canceled, failed, processing, succeeded |
status_transitions | Model | Required within parent | Expand Cancel an Inbound Transfer — response body — status transitions |
transaction | JSON | Optional | |
transaction (anyOf 1) | JSON | Alternative | The Transaction associated with this object. |
transaction (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body |
transaction (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Reason 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
received_debit | JSON | Optional | |
received_debit (anyOf 1) | string | Alternative | If 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) | null | Alternative |
Cancel an Inbound Transfer — response body — status transitions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
canceled_at | JSON | Optional | |
canceled_at (anyOf 1) | JSON | Alternative | |
canceled_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an InboundTransfer changed status to `canceled`. Format: unix-time |
canceled_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
canceled_at (anyOf 2) | null | Alternative | |
failed_at | JSON | Optional | |
failed_at (anyOf 1) | JSON | Alternative | |
failed_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an InboundTransfer changed status to `failed`. Format: unix-time |
failed_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
failed_at (anyOf 2) | null | Alternative | |
succeeded_at | JSON | Optional | |
succeeded_at (anyOf 1) | JSON | Alternative | |
succeeded_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an InboundTransfer changed status to `succeeded`. Format: unix-time |
succeeded_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
succeeded_at (anyOf 2) | null | Alternative |
Cancel an InboundTransfer — response body — origin_payment_method_details / value / type: us bank account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billing_details | Model | Required within parent | Expand Retrieve a Received Debit — response body — initiating payment method details billing details |
type | string | Required within parent | The type of the payment method used in the InboundTransfer. Known values: us_bank_account |
us_bank_account | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_holder_type | JSON | Optional | |
account_holder_type (anyOf 1) | string | Alternative | Account holder type: individual or company. Known values: company, individual |
account_holder_type (anyOf 2) | null | Alternative | |
account_type | JSON | Optional | |
account_type (anyOf 1) | string | Alternative | Account type: checkings or savings. Defaults to checking if omitted. Known values: checking, savings |
account_type (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely 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) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
mandate | JSON | Optional | ID of the mandate used to make this payment. |
mandate (anyOf 1) | string | Alternative | Maximum length: 5000 |
mandate (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
network | string | Required within parent | The 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_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | Routing number of the bank account. Maximum length: 5000 |
routing_number (anyOf 2) | null | Alternative |
Referenced models: Retrieve a Mandate — response body
Cancel an Outbound Payment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Use [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) |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount (in cents) transferred. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cancelable | boolean | Required within parent | Returns `true` if the object can be canceled, and `false` otherwise. |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
customer | JSON | Optional | |
customer (anyOf 1) | string | Alternative | ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent. Maximum length: 5000 |
customer (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
destination_payment_method | JSON | Optional | |
destination_payment_method (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
destination_payment_method_details | JSON | Optional | |
destination_payment_method_details (anyOf 1) | JSON | Alternative | Details about the PaymentMethod for an OutboundPayment. |
destination_payment_method_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel an OutboundPayment — response body — destination_payment_method_details / value / type: financial account, us bank account |
destination_payment_method_details (anyOf 2) | null | Alternative | |
end_user_details | JSON | Optional | |
end_user_details (anyOf 1) | JSON | Alternative | Details about the end user. |
end_user_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel an Outbound Payment — response body — end user details Details about the end user ip address, present |
end_user_details (anyOf 2) | null | Alternative | |
expected_arrival_date | JSON | Required within parent | |
expected_arrival_date (anyOf 1) | integer | Alternative | The date when funds are expected to arrive in the destination account. Format: unix-time |
expected_arrival_date (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
financial_account | string | Required within parent | The FinancialAccount that funds were pulled from. Maximum length: 5000 |
hosted_regulatory_receipt_url | JSON | Optional | |
hosted_regulatory_receipt_url (anyOf 1) | string | Alternative | A [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) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set 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.* | string | Additional keys | Maximum length: 500 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.outbound_payment |
returned_details | JSON | Optional | |
returned_details (anyOf 1) | JSON | Alternative | Details about a returned OutboundPayment. Only set when the status is `returned`. |
returned_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel an Outbound Payment — response body — returned details value code, transaction |
returned_details (anyOf 2) | null | Alternative | |
statement_descriptor | string | Required within parent | The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). Maximum length: 5000 |
status | string | Required within parent | Current 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_transitions | Model | Required within parent | Expand Cancel an Outbound Payment — response body — status transitions |
tracking_details | JSON | Optional | |
tracking_details (anyOf 1) | JSON | Alternative | Details about network-specific tracking information if available. |
tracking_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire |
tracking_details (anyOf 2) | null | Alternative | |
transaction | JSON | Required within parent | The Transaction associated with this object. |
transaction (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ip_address | JSON | Optional | |
ip_address (anyOf 1) | string | Alternative | IP 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) | null | Alternative | |
present | boolean | Required 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | string | Required within parent | Reason 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 |
transaction | JSON | Required within parent | The Transaction associated with this object. |
transaction (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
canceled_at | JSON | Optional | |
canceled_at (anyOf 1) | JSON | Alternative | |
canceled_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an OutboundPayment changed status to `canceled`. Format: unix-time |
canceled_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
canceled_at (anyOf 2) | null | Alternative | |
failed_at | JSON | Optional | |
failed_at (anyOf 1) | JSON | Alternative | |
failed_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an OutboundPayment changed status to `failed`. Format: unix-time |
failed_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
failed_at (anyOf 2) | null | Alternative | |
posted_at | JSON | Optional | |
posted_at (anyOf 1) | JSON | Alternative | |
posted_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an OutboundPayment changed status to `posted`. Format: unix-time |
posted_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
posted_at (anyOf 2) | null | Alternative | |
returned_at | JSON | Optional | |
returned_at (anyOf 1) | JSON | Alternative | |
returned_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an OutboundPayment changed status to `returned`. Format: unix-time |
returned_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
returned_at (anyOf 2) | null | Alternative |
Cancel an Outbound Transfer — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Use [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) |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount (in cents) transferred. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cancelable | boolean | Required within parent | Returns `true` if the object can be canceled, and `false` otherwise. |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
destination_payment_method | JSON | Optional | |
destination_payment_method (anyOf 1) | string | Alternative | The PaymentMethod used as the payment instrument for an OutboundTransfer. Maximum length: 5000 |
destination_payment_method (anyOf 2) | null | Alternative | |
destination_payment_method_details | Model | Required within parent | Expand Cancel an Outbound Transfer — response body — destination payment method details |
expected_arrival_date | JSON | Required within parent | |
expected_arrival_date (anyOf 1) | integer | Alternative | The date when funds are expected to arrive in the destination account. Format: unix-time |
expected_arrival_date (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
financial_account | string | Required within parent | The FinancialAccount that funds were pulled from. Maximum length: 5000 |
hosted_regulatory_receipt_url | JSON | Optional | |
hosted_regulatory_receipt_url (anyOf 1) | string | Alternative | A [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) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set 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.* | string | Additional keys | Maximum length: 500 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.outbound_transfer |
returned_details | JSON | Optional | |
returned_details (anyOf 1) | JSON | Alternative | Details about a returned OutboundTransfer. Only set when the status is `returned`. |
returned_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel an Outbound Payment — response body — returned details value code, transaction |
returned_details (anyOf 2) | null | Alternative | |
statement_descriptor | string | Required within parent | Information about the OutboundTransfer to be sent to the recipient account. Maximum length: 5000 |
status | string | Required within parent | Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`. Known values: canceled, failed, posted, processing, returned |
status_transitions | Model | Required within parent | Expand Cancel an Outbound Transfer — response body — status transitions |
tracking_details | JSON | Optional | |
tracking_details (anyOf 1) | JSON | Alternative | Details about network-specific tracking information if available. |
tracking_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire |
tracking_details (anyOf 2) | null | Alternative | |
transaction | JSON | Required within parent | The Transaction associated with this object. |
transaction (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billing_details | Model | Required within parent | Expand Retrieve a Received Debit — response body — initiating payment method details billing details |
financial_account | Model | Optional | Expand Cancel an Outbound Transfer — response body — destination payment method details financial account |
type | string | Required within parent | The type of the payment method used in the OutboundTransfer. Known values: financial_account, us_bank_account |
us_bank_account | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Token of the FinancialAccount. Maximum length: 5000 |
network | string | Required within parent | The rails used to send funds. Known values: stripe |
Cancel an Outbound Transfer — response body — destination payment method details us bank account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_holder_type | JSON | Optional | |
account_holder_type (anyOf 1) | string | Alternative | Account holder type: individual or company. Known values: company, individual |
account_holder_type (anyOf 2) | null | Alternative | |
account_type | JSON | Optional | |
account_type (anyOf 1) | string | Alternative | Account type: checkings or savings. Defaults to checking if omitted. Known values: checking, savings |
account_type (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely 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) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
mandate | JSON | Optional | ID of the mandate used to make this payment. |
mandate (anyOf 1) | string | Alternative | Maximum length: 5000 |
mandate (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
network | string | Required within parent | The 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_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | Routing number of the bank account. Maximum length: 5000 |
routing_number (anyOf 2) | null | Alternative |
Referenced models: Retrieve a Mandate — response body
Cancel an Outbound Transfer — response body — status transitions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
canceled_at | JSON | Optional | |
canceled_at (anyOf 1) | JSON | Alternative | |
canceled_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an OutboundTransfer changed status to `canceled` Format: unix-time |
canceled_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
canceled_at (anyOf 2) | null | Alternative | |
failed_at | JSON | Optional | |
failed_at (anyOf 1) | JSON | Alternative | |
failed_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an OutboundTransfer changed status to `failed` Format: unix-time |
failed_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
failed_at (anyOf 2) | null | Alternative | |
posted_at | JSON | Optional | |
posted_at (anyOf 1) | JSON | Alternative | |
posted_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an OutboundTransfer changed status to `posted` Format: unix-time |
posted_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
posted_at (anyOf 2) | null | Alternative | |
returned_at | JSON | Optional | |
returned_at (anyOf 1) | JSON | Alternative | |
returned_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when an OutboundTransfer changed status to `returned` Format: unix-time |
returned_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
returned_at (anyOf 2) | null | Alternative |
Cancel an OutboundPayment — response body — destination_payment_method_details / value / type: financial account, us bank account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billing_details | Model | Required within parent | Expand Retrieve a Received Debit — response body — initiating payment method details billing details |
financial_account | Model | Optional | Expand Cancel an Outbound Transfer — response body — destination payment method details financial account |
type | string | Required within parent | The type of the payment method used in the OutboundPayment. Known values: financial_account, us_bank_account |
us_bank_account | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ach | Model | Optional | Expand Cancel an OutboundPayment — response body — tracking_details / value / type: ach, us domestic wire ach |
type | string | Required within parent | The US bank account network used to send funds. Known values: ach, us_domestic_wire |
us_domestic_wire | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
trace_id | string | Required within parent | ACH 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
chips | JSON | Optional | |
chips (anyOf 1) | string | Alternative | CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network. Maximum length: 5000 |
chips (anyOf 2) | null | Alternative | |
imad | JSON | Optional | |
imad (anyOf 1) | string | Alternative | IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. Maximum length: 5000 |
imad (anyOf 2) | null | Alternative | |
omad | JSON | Optional | |
omad (anyOf 1) | string | Alternative | OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. Maximum length: 5000 |
omad (anyOf 2) | null | Alternative |
Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ach | Model | Optional | Expand Cancel an OutboundTransfer — response body — tracking_details / value / type: ach, us domestic wire ach |
type | string | Required within parent | The US bank account network used to send funds. Known values: ach, us_domestic_wire |
us_domestic_wire | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
trace_id | string | Required within parent | ACH 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
chips | JSON | Optional | |
chips (anyOf 1) | string | Alternative | CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. Maximum length: 5000 |
chips (anyOf 2) | null | Alternative | |
imad | JSON | Optional | |
imad (anyOf 1) | string | Alternative | IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. Maximum length: 5000 |
imad (anyOf 2) | null | Alternative | |
omad | JSON | Optional | |
omad (anyOf 1) | string | Alternative | OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. Maximum length: 5000 |
omad (anyOf 2) | null | Alternative |
Close a Financial Account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Stripe 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_features | array | Optional | The array of paths to active Features in the Features hash. |
active_features[] | string | Each item | Known 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 |
balance | Model | Required within parent | Expand Close a Financial Account — response body — balance |
country | string | Required within parent | Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000 |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
features | Model | Optional | Expand Update Financial Account Features — response body |
financial_addresses | array | Required within parent | The set of credentials that resolve to a FinancialAccount. |
financial_addresses[] | Model | Each item | Expand Close a Financial Account — response body — financial addresses item |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
is_default | boolean | Optional | |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Set 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).* | string | Additional keys | Maximum length: 500 |
metadata (anyOf 2) | null | Alternative | |
nickname | JSON | Optional | |
nickname (anyOf 1) | string | Alternative | The nickname for the FinancialAccount. Maximum length: 5000 |
nickname (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.financial_account |
pending_features | array | Optional | The array of paths to pending Features in the Features hash. |
pending_features[] | string | Each item | Known 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_restrictions | JSON | Optional | |
platform_restrictions (anyOf 1) | JSON | Alternative | The set of functionalities that the platform can restrict on the FinancialAccount. |
platform_restrictions (anyOf 1) (anyOf 1) | Model | Alternative | Expand Close a Financial Account — response body — platform restrictions value inbound flows, outbound flows |
platform_restrictions (anyOf 2) | null | Alternative | |
restricted_features | array | Optional | The array of paths to restricted Features in the Features hash. |
restricted_features[] | string | Each item | Known 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 |
status | string | Required within parent | Status of this FinancialAccount. Known values: closed, open |
status_details | Model | Required within parent | Expand Close a Financial Account — response body — status details |
supported_currencies | array | Required within parent | The 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[] | string | Each 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Balance information for the FinancialAccount |
cash | object | Required within parent | Funds the user can spend right now. Additional keys: see wildcard field |
cash.* | JSON | Additional keys | |
cash.* (anyOf 1) | integer | Alternative | |
cash.* (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
inbound_pending | object | Required within parent | Funds not spendable yet, but will become available at a later time. Additional keys: see wildcard field |
inbound_pending.* | JSON | Additional keys | |
inbound_pending.* (anyOf 1) | integer | Alternative | |
inbound_pending.* (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
outbound_pending | object | Required within parent | Funds in the account, but not spendable because they are being held for pending outbound flows. Additional keys: see wildcard field |
outbound_pending.* | JSON | Additional keys | |
outbound_pending.* (anyOf 1) | integer | Alternative | |
outbound_pending.* (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Close a Financial Account — response body — financial addresses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | FinancialAddresses contain identifying information that resolves to a FinancialAccount. |
aba | Model | Optional | Expand Close a Financial Account — response body — financial addresses item aba |
supported_networks | array | Optional | The list of networks that the address supports |
supported_networks[] | string | Each item | Known values: ach, rtp, us_domestic_wire |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | ABA Records contain U.S. bank account details per the ABA format. |
account_holder_name | string | Required within parent | The name of the person or business that owns the bank account. Maximum length: 5000 |
account_number | JSON | Optional | |
account_number (anyOf 1) | string | Alternative | The account number. Maximum length: 5000 |
account_number (anyOf 2) | null | Alternative | |
account_number_last4 | string | Required within parent | The last four characters of the account number. Maximum length: 5000 |
bank_name | string | Required within parent | Name of the bank. Maximum length: 5000 |
routing_number | string | Required within parent | Routing number for the account. Maximum length: 5000 |
Close a Financial Account — response body — platform restrictions value inbound flows, outbound flows
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Restrictions that a Connect Platform has placed on this FinancialAccount. |
inbound_flows | JSON | Optional | |
inbound_flows (anyOf 1) | string | Alternative | Restricts all inbound money movement. Known values: restricted, unrestricted |
inbound_flows (anyOf 2) | null | Alternative | |
outbound_flows | JSON | Optional | |
outbound_flows (anyOf 1) | string | Alternative | Restricts all outbound money movement. Known values: restricted, unrestricted |
outbound_flows (anyOf 2) | null | Alternative |
Close a Financial Account — response body — status details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
closed | JSON | Optional | |
closed (anyOf 1) | JSON | Alternative | Details related to the closure of this FinancialAccount |
closed (anyOf 1) (anyOf 1) | Model | Alternative | Expand Close a Financial Account — response body — status details closed value reasons |
closed (anyOf 2) | null | Alternative |
Referenced models: Close a Financial Account — response body — status details closed value reasons
Close a Financial Account — response body — status details closed value reasons
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reasons | array | Required within parent | The array that contains reasons for a FinancialAccount closure. |
reasons[] | string | Each item | Known values: account_rejected, closed_by_platform, other |
Create a Credit Reversal — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | You 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. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount (in cents) transferred. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
financial_account | string | Required within parent | The FinancialAccount to reverse funds from. Maximum length: 5000 |
hosted_regulatory_receipt_url | JSON | Optional | |
hosted_regulatory_receipt_url (anyOf 1) | string | Alternative | A [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) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set 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.* | string | Additional keys | Maximum length: 500 |
network | string | Required within parent | The rails used to reverse the funds. Known values: ach, stripe |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.credit_reversal |
received_credit | string | Required within parent | The ReceivedCredit being reversed. Maximum length: 5000 |
status | string | Required within parent | Status of the CreditReversal Known values: canceled, posted, processing |
status_transitions | Model | Required within parent | Expand Create a Credit Reversal — response body — status transitions |
transaction | JSON | Optional | |
transaction (anyOf 1) | JSON | Alternative | The Transaction associated with this object. |
transaction (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body |
transaction (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
posted_at | JSON | Optional | |
posted_at (anyOf 1) | JSON | Alternative | |
posted_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when the CreditReversal changed status to `posted` Format: unix-time |
posted_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
posted_at (anyOf 2) | null | Alternative |
Create a Debit Reversal — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | You 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. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount (in cents) transferred. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
financial_account | JSON | Optional | |
financial_account (anyOf 1) | string | Alternative | The FinancialAccount to reverse funds from. Maximum length: 5000 |
financial_account (anyOf 2) | null | Alternative | |
hosted_regulatory_receipt_url | JSON | Optional | |
hosted_regulatory_receipt_url (anyOf 1) | string | Alternative | A [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) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
linked_flows | JSON | Optional | |
linked_flows (anyOf 1) | JSON | Alternative | Other flows linked to a DebitReversal. |
linked_flows (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Debit Reversal — response body — linked flows Other flows linked to a Debit Reversal issuing dispute |
linked_flows (anyOf 2) | null | Alternative | |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set 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.* | string | Additional keys | Maximum length: 500 |
network | string | Required within parent | The rails used to reverse the funds. Known values: ach, card |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.debit_reversal |
received_debit | string | Required within parent | The ReceivedDebit being reversed. Maximum length: 5000 |
status | string | Required within parent | Status of the DebitReversal Known values: failed, processing, succeeded |
status_transitions | Model | Required within parent | Expand Create a Debit Reversal — response body — status transitions |
transaction | JSON | Optional | |
transaction (anyOf 1) | JSON | Alternative | The Transaction associated with this object. |
transaction (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body |
transaction (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
issuing_dispute | JSON | Optional | |
issuing_dispute (anyOf 1) | string | Alternative | Set if there is an Issuing dispute associated with the DebitReversal. Maximum length: 5000 |
issuing_dispute (anyOf 2) | null | Alternative |
Create a Debit Reversal — response body — status transitions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed_at | JSON | Optional | |
completed_at (anyOf 1) | JSON | Alternative | |
completed_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when the DebitReversal changed status to `completed`. Format: unix-time |
completed_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
completed_at (anyOf 2) | null | Alternative |
Retrieve a Received Credit — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | ReceivedCredits 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. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount (in cents) transferred. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
description | string | Required within parent | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
failure_code | JSON | Optional | |
failure_code (anyOf 1) | string | Alternative | Reason 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) | null | Alternative | |
financial_account | JSON | Optional | |
financial_account (anyOf 1) | string | Alternative | The FinancialAccount that received the funds. Maximum length: 5000 |
financial_account (anyOf 2) | null | Alternative | |
hosted_regulatory_receipt_url | JSON | Optional | |
hosted_regulatory_receipt_url (anyOf 1) | string | Alternative | A [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) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
initiating_payment_method_details | Model | Required within parent | Expand Retrieve a Received Debit — response body — initiating payment method details |
linked_flows | Model | Required within parent | Expand Retrieve a Received Credit — response body — linked flows |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
network | string | Required within parent | The rails used to send the funds. Known values: ach, card, rtp, stripe, us_domestic_wire |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.received_credit |
reversal_details | JSON | Optional | |
reversal_details (anyOf 1) | JSON | Alternative | Details describing when a ReceivedCredit may be reversed. |
reversal_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Retrieve a Received Credit — response body — reversal details value deadline, restricted reason |
reversal_details (anyOf 2) | null | Alternative | |
status | string | Required within parent | Status 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 |
transaction | JSON | Optional | |
transaction (anyOf 1) | JSON | Alternative | The Transaction associated with this object. |
transaction (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body |
transaction (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
credit_reversal | JSON | Optional | |
credit_reversal (anyOf 1) | string | Alternative | The CreditReversal created as a result of this ReceivedCredit being reversed. Maximum length: 5000 |
credit_reversal (anyOf 2) | null | Alternative | |
issuing_authorization | JSON | Optional | |
issuing_authorization (anyOf 1) | string | Alternative | Set 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) | null | Alternative | |
issuing_transaction | JSON | Optional | |
issuing_transaction (anyOf 1) | string | Alternative | Set 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) | null | Alternative | |
source_flow | JSON | Optional | |
source_flow (anyOf 1) | string | Alternative | ID 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) | null | Alternative | |
source_flow_details | JSON | Optional | |
source_flow_details (anyOf 1) | JSON | Alternative | The expandable object of the source flow. |
source_flow_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
source_flow_type | JSON | Optional | |
source_flow_type (anyOf 1) | string | Alternative | The type of flow that originated the ReceivedCredit (for example, `outbound_payment`). Maximum length: 5000 |
source_flow_type (anyOf 2) | null | Alternative |
Retrieve a Received Credit — response body — reversal details value deadline, restricted reason
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deadline | JSON | Optional | |
deadline (anyOf 1) | JSON | Alternative | |
deadline (anyOf 1) (anyOf 1) | integer | Alternative | Time before which a ReceivedCredit can be reversed. Format: unix-time |
deadline (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
deadline (anyOf 2) | null | Alternative | |
restricted_reason | JSON | Optional | |
restricted_reason (anyOf 1) | string | Alternative | Set if a ReceivedCredit cannot be reversed. Known values: already_reversed, deadline_passed, network_restricted, other, source_flow_restricted |
restricted_reason (anyOf 2) | null | Alternative |
Retrieve a Received Debit — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | ReceivedDebits represent funds pulled from a [FinancialAccount](https://docs.stripe.com/api#financial_accounts). These are not initiated from the FinancialAccount. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount (in cents) transferred. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
description | string | Required within parent | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
failure_code | JSON | Optional | |
failure_code (anyOf 1) | string | Alternative | Reason 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) | null | Alternative | |
financial_account | JSON | Optional | |
financial_account (anyOf 1) | string | Alternative | The FinancialAccount that funds were pulled from. Maximum length: 5000 |
financial_account (anyOf 2) | null | Alternative | |
hosted_regulatory_receipt_url | JSON | Optional | |
hosted_regulatory_receipt_url (anyOf 1) | string | Alternative | A [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) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
initiating_payment_method_details | Model | Optional | Expand Retrieve a Received Debit — response body — initiating payment method details |
linked_flows | Model | Required within parent | Expand Retrieve a Received Debit — response body — linked flows |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
network | string | Required within parent | The network used for the ReceivedDebit. Known values: ach, card, stripe |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.received_debit |
reversal_details | JSON | Optional | |
reversal_details (anyOf 1) | JSON | Alternative | Details describing when a ReceivedDebit might be reversed. |
reversal_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Retrieve a Received Debit — response body — reversal details value deadline, restricted reason |
reversal_details (anyOf 2) | null | Alternative | |
status | string | Required within parent | Status 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 |
transaction | JSON | Optional | |
transaction (anyOf 1) | JSON | Alternative | The Transaction associated with this object. |
transaction (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body |
transaction (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
balance | string | Optional | Set when `type` is `balance`. Known values: payments |
billing_details | Model | Required within parent | Expand Retrieve a Received Debit — response body — initiating payment method details billing details |
financial_account | Model | Optional | Expand Retrieve a Received Debit — response body — initiating payment method details financial account |
issuing_card | string | Optional | Set when `type` is `issuing_card`. This is an [Issuing Card](https://docs.stripe.com/api#issuing_cards) ID. Maximum length: 5000 |
type | string | Required within parent | Polymorphic 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_account | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand Create a Location — response body — address |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email address. Maximum length: 5000 |
email (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Full name. Maximum length: 5000 |
name (anyOf 2) | null | Alternative |
Referenced models: Create a Location — response body — address
Retrieve a Received Debit — response body — initiating payment method details financial account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The FinancialAccount ID. Maximum length: 5000 |
network | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Bank name. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | The last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
routing_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | The routing number for the bank account. Maximum length: 5000 |
routing_number (anyOf 2) | null | Alternative |
Retrieve a Received Debit — response body — linked flows
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
debit_reversal | JSON | Optional | |
debit_reversal (anyOf 1) | string | Alternative | The DebitReversal created as a result of this ReceivedDebit being reversed. Maximum length: 5000 |
debit_reversal (anyOf 2) | null | Alternative | |
inbound_transfer | JSON | Optional | |
inbound_transfer (anyOf 1) | string | Alternative | Set if the ReceivedDebit is associated with an InboundTransfer's return of funds. Maximum length: 5000 |
inbound_transfer (anyOf 2) | null | Alternative | |
issuing_authorization | JSON | Optional | |
issuing_authorization (anyOf 1) | string | Alternative | Set 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) | null | Alternative | |
issuing_transaction | JSON | Optional | |
issuing_transaction (anyOf 1) | string | Alternative | Set 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) | null | Alternative | |
payout | JSON | Optional | |
payout (anyOf 1) | string | Alternative | Set if the ReceivedDebit was created due to a [Payout](https://docs.stripe.com/api#payouts) object. Maximum length: 5000 |
payout (anyOf 2) | null | Alternative | |
topup | JSON | Optional | |
topup (anyOf 1) | string | Alternative | Set if the ReceivedDebit was created due to a [Topup](https://docs.stripe.com/api#topups) object. Maximum length: 5000 |
topup (anyOf 2) | null | Alternative |
Retrieve a Received Debit — response body — reversal details value deadline, restricted reason
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deadline | JSON | Optional | |
deadline (anyOf 1) | JSON | Alternative | |
deadline (anyOf 1) (anyOf 1) | integer | Alternative | Time before which a ReceivedDebit can be reversed. Format: unix-time |
deadline (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
deadline (anyOf 2) | null | Alternative | |
restricted_reason | JSON | Optional | |
restricted_reason (anyOf 1) | string | Alternative | Set if a ReceivedDebit can't be reversed. Known values: already_reversed, deadline_passed, network_restricted, other, source_flow_restricted |
restricted_reason (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
credit_reversal | Model | Optional | Expand Create a Credit Reversal — response body |
outbound_payment | Model | Optional | Expand Cancel an Outbound Payment — response body |
outbound_transfer | Model | Optional | Expand Cancel an Outbound Transfer — response body |
payout | Model | Optional | Expand Cancel a payout — response body |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | TransactionEntries represent individual units of money movements within a single [Transaction](https://docs.stripe.com/api#transactions). |
balance_impact | Model | Required within parent | Expand Retrieve a Transaction Entry — response body — balance impact |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
effective_at | JSON | Required within parent | |
effective_at (anyOf 1) | integer | Alternative | When the TransactionEntry will impact the FinancialAccount's balance. Format: unix-time |
effective_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
financial_account | string | Required within parent | The FinancialAccount associated with this object. Maximum length: 5000 |
flow | JSON | Optional | |
flow (anyOf 1) | string | Alternative | Token of the flow associated with the TransactionEntry. Maximum length: 5000 |
flow (anyOf 2) | null | Alternative | |
flow_details | JSON | Optional | |
flow_details (anyOf 1) | JSON | Alternative | Details of the flow associated with the TransactionEntry. |
flow_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
flow_type | string | Required within parent | Type 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 |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.transaction_entry |
transaction | JSON | Required within parent | The Transaction associated with this object. |
transaction (anyOf 1) | string | Alternative | Maximum length: 5000 |
transaction (anyOf 2) | Model | Alternative | Expand Retrieve a Transaction — treasury get Treasury Transactions Id — response body |
type | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Change to a FinancialAccount's balance |
cash | JSON | Required within parent | |
cash (anyOf 1) | integer | Alternative | The change made to funds the user can spend right now. |
cash (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
inbound_pending | JSON | Required within parent | |
inbound_pending (anyOf 1) | integer | Alternative | The change made to funds that are not spendable yet, but will become available at a later time. |
inbound_pending (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
outbound_pending | JSON | Required within parent | |
outbound_pending (anyOf 1) | integer | Alternative | The change made to funds in the account, but not spendable because they are being held for pending outbound flows. |
outbound_pending (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
credit_reversal | Model | Optional | Expand Create a Credit Reversal — response body |
debit_reversal | Model | Optional | Expand Create a Debit Reversal — response body |
inbound_transfer | Model | Optional | Expand Cancel an Inbound Transfer — response body |
issuing_authorization | Model | Optional | Expand Update an authorization — response body |
outbound_payment | Model | Optional | Expand Cancel an Outbound Payment — response body |
outbound_transfer | Model | Optional | Expand Cancel an Outbound Transfer — response body |
received_credit | Model | Optional | Expand Retrieve a Received Credit — response body |
received_debit | Model | Optional | Expand Retrieve a Received Debit — response body |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Transactions represent changes to a [FinancialAccount's](https://docs.stripe.com/api#financial_accounts) balance. |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount (in cents) transferred. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_impact | Model | Required within parent | Expand Retrieve a Transaction Entry — response body — balance impact |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
description | string | Required within parent | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
entries | JSON | Optional | |
entries (anyOf 1) | object | Alternative | A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. |
entries (anyOf 1).data | array | Required within parent | Details about each object. |
entries (anyOf 1).data[] | Model | Each item | Expand Retrieve a Transaction Entry — response body |
entries (anyOf 1).has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
entries (anyOf 1).object | string | Required within parent | String 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).url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/treasury/transaction_entries |
entries (anyOf 2) | null | Alternative | |
financial_account | string | Required within parent | The FinancialAccount associated with this object. Maximum length: 5000 |
flow | JSON | Optional | |
flow (anyOf 1) | string | Alternative | ID of the flow that created the Transaction. Maximum length: 5000 |
flow (anyOf 2) | null | Alternative | |
flow_details | JSON | Optional | |
flow_details (anyOf 1) | JSON | Alternative | Details of the flow that created the Transaction. |
flow_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
flow_type | string | Required within parent | Type 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 |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.transaction |
status | string | Required within parent | Status of the Transaction. Known values: open, posted, void |
status_transitions | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
posted_at | JSON | Optional | |
posted_at (anyOf 1) | JSON | Alternative | |
posted_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when the Transaction changed status to `posted`. Format: unix-time |
posted_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
posted_at (anyOf 2) | null | Alternative | |
void_at | JSON | Optional | |
void_at (anyOf 1) | JSON | Alternative | |
void_at (anyOf 1) (anyOf 1) | integer | Alternative | Timestamp describing when the Transaction changed status to `void`. Format: unix-time |
void_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
void_at (anyOf 2) | null | Alternative |
Update Financial Account Features — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Encodes 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_issuing | Model | Optional | Expand Update Financial Account Features — response body — card issuing |
deposit_insurance | Model | Optional | Expand Update Financial Account Features — response body — card issuing |
financial_addresses | Model | Optional | Expand Update Financial Account Features — response body — financial addresses |
inbound_transfers | Model | Optional | Expand Update Financial Account Features — response body — inbound transfers |
intra_stripe_flows | Model | Optional | Expand Update Financial Account Features — response body — card issuing |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: treasury.financial_account_features |
outbound_payments | Model | Optional | Expand Update Financial Account Features — response body — outbound payments |
outbound_transfers | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Toggle settings for enabling/disabling a feature |
requested | boolean | Required within parent | Whether the FinancialAccount should have the Feature. |
status | string | Required within parent | Whether the Feature is operational. Known values: active, pending, restricted |
status_details | array | Required within parent | Additional details; includes at least one entry when the status is not `active`. |
status_details[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional details on the FinancialAccount Features information. |
code | string | Required within parent | Represents 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 |
resolution | JSON | Optional | |
resolution (anyOf 1) | string | Alternative | Represents what the user should do, if anything, to activate the Feature. Known values: contact_stripe, provide_information, remove_restriction |
resolution (anyOf 2) | null | Alternative | |
restriction | string | Optional | The `platform_restrictions` that are restricting this Feature. Known values: inbound_flows, outbound_flows |
Update Financial Account Features — response body — financial addresses
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Settings related to Financial Addresses features on a Financial Account |
aba | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Toggle settings for enabling/disabling the ABA address feature |
requested | boolean | Required within parent | Whether the FinancialAccount should have the Feature. |
status | string | Required within parent | Whether the Feature is operational. Known values: active, pending, restricted |
status_details | array | Required within parent | Additional details; includes at least one entry when the status is not `active`. |
status_details[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | InboundTransfers contains inbound transfers features for a FinancialAccount. |
ach | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Toggle settings for enabling/disabling an inbound ACH specific feature |
requested | boolean | Required within parent | Whether the FinancialAccount should have the Feature. |
status | string | Required within parent | Whether the Feature is operational. Known values: active, pending, restricted |
status_details | array | Required within parent | Additional details; includes at least one entry when the status is not `active`. |
status_details[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Settings related to Outbound Payments features on a Financial Account |
ach | Model | Optional | Expand Update Financial Account Features — response body — outbound payments ach |
us_domestic_wire | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Toggle settings for enabling/disabling an outbound ACH specific feature |
requested | boolean | Required within parent | Whether the FinancialAccount should have the Feature. |
status | string | Required within parent | Whether the Feature is operational. Known values: active, pending, restricted |
status_details | array | Required within parent | Additional details; includes at least one entry when the status is not `active`. |
status_details[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | OutboundTransfers contains outbound transfers features for a FinancialAccount. |
ach | Model | Optional | Expand Update Financial Account Features — response body — outbound payments ach |
us_domestic_wire | Model | Optional | Expand 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