terminal_reader_reader_resource_process_config
{
"type": "object",
"title": "TerminalReaderReaderResourceProcessConfig",
"properties": {
"tipping": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_tipping_config"
},
"return_url": {
"type": "string",
"maxLength": 5000,
"description": "If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion."
},
"skip_tipping": {
"type": "boolean",
"description": "Override showing a tipping selection screen on this transaction."
},
"enable_customer_cancellation": {
"type": "boolean",
"description": "Enable customer-initiated cancellation when processing this payment."
}
},
"description": "Represents a per-transaction override of a reader configuration",
"x-expandableFields": [
"tipping"
]
}
terminal_reader_reader_resource_process_payment_intent_action
{
"type": "object",
"title": "TerminalReaderReaderResourceProcessPaymentIntentAction",
"required": [
"payment_intent"
],
"properties": {
"payment_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_intent"
}
],
"description": "Most recent PaymentIntent processed by the reader.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_intent"
}
]
}
},
"process_config": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_process_config"
}
},
"description": "Represents a reader action to process a payment intent",
"x-expandableFields": [
"payment_intent",
"process_config"
]
}
terminal_reader_reader_resource_process_setup_config
{
"type": "object",
"title": "TerminalReaderReaderResourceProcessSetupConfig",
"properties": {
"enable_customer_cancellation": {
"type": "boolean",
"description": "Enable customer-initiated cancellation when processing this SetupIntent."
}
},
"description": "Represents a per-setup override of a reader configuration",
"x-expandableFields": []
}
terminal_reader_reader_resource_process_setup_intent_action
{
"type": "object",
"title": "TerminalReaderReaderResourceProcessSetupIntentAction",
"required": [
"setup_intent"
],
"properties": {
"setup_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/setup_intent"
}
],
"description": "Most recent SetupIntent processed by the reader.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/setup_intent"
}
]
}
},
"generated_card": {
"type": "string",
"maxLength": 5000,
"description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod."
},
"process_config": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_config"
}
},
"description": "Represents a reader action to process a setup intent",
"x-expandableFields": [
"process_config",
"setup_intent"
]
}
terminal_reader_reader_resource_reader_action
{
"type": "object",
"title": "TerminalReaderReaderResourceReaderAction",
"required": [
"status",
"type"
],
"properties": {
"type": {
"enum": [
"collect_inputs",
"collect_payment_method",
"confirm_payment_intent",
"process_payment_intent",
"process_setup_intent",
"refund_payment",
"set_reader_display"
],
"type": "string",
"description": "Type of action performed by the reader.",
"x-stripeBypassValidation": true
},
"status": {
"enum": [
"failed",
"in_progress",
"succeeded"
],
"type": "string",
"description": "Status of the action performed by the reader."
},
"failure_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Failure code, only set if status is `failed`."
},
"collect_inputs": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_collect_inputs_action"
},
"refund_payment": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_action"
},
"failure_message": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Detailed failure message, only set if status is `failed`."
},
"set_reader_display": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_set_reader_display_action"
},
"process_setup_intent": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_intent_action"
},
"collect_payment_method": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_collect_payment_method_action"
},
"confirm_payment_intent": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_confirm_payment_intent_action"
},
"process_payment_intent": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_process_payment_intent_action"
}
},
"description": "Represents an action performed by the reader",
"x-expandableFields": [
"collect_inputs",
"collect_payment_method",
"confirm_payment_intent",
"process_payment_intent",
"process_setup_intent",
"refund_payment",
"set_reader_display"
]
}
terminal_reader_reader_resource_refund_payment_action
{
"type": "object",
"title": "TerminalReaderReaderResourceRefundPaymentAction",
"properties": {
"amount": {
"type": "integer",
"description": "The amount being refunded."
},
"charge": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/charge"
}
],
"description": "Charge that is being refunded.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
},
"reason": {
"enum": [
"duplicate",
"fraudulent",
"requested_by_customer"
],
"type": "string",
"description": "The reason for the refund."
},
"refund": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/refund"
}
],
"description": "Unique identifier for the refund object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/refund"
}
]
}
},
"metadata": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"payment_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_intent"
}
],
"description": "Payment intent that is being refunded.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_intent"
}
]
}
},
"reverse_transfer": {
"type": "boolean",
"description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge."
},
"refund_payment_config": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_config"
},
"refund_application_fee": {
"type": "boolean",
"description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge."
}
},
"description": "Represents a reader action to refund a payment",
"x-expandableFields": [
"charge",
"payment_intent",
"refund",
"refund_payment_config"
]
}
terminal_reader_reader_resource_refund_payment_config
{
"type": "object",
"title": "TerminalReaderReaderResourceRefundPaymentConfig",
"properties": {
"enable_customer_cancellation": {
"type": "boolean",
"description": "Enable customer-initiated cancellation when refunding this payment."
}
},
"description": "Represents a per-transaction override of a reader configuration",
"x-expandableFields": []
}
terminal_reader_reader_resource_selection
{
"type": "object",
"title": "TerminalReaderReaderResourceSelection",
"required": [
"choices"
],
"properties": {
"id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The id of the selected choice"
},
"text": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The text of the selected choice"
},
"choices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/terminal_reader_reader_resource_choice"
},
"description": "List of possible choices to be selected"
}
},
"description": "Information about a selection being collected using a reader",
"x-expandableFields": [
"choices"
]
}
terminal_reader_reader_resource_set_reader_display_action
{
"type": "object",
"title": "TerminalReaderReaderResourceSetReaderDisplayAction",
"required": [
"type"
],
"properties": {
"cart": {
"anyOf": [
{
"$ref": "#/components/schemas/terminal_reader_reader_resource_cart"
}
],
"nullable": true,
"description": "Cart object to be displayed by the reader, including line items, amounts, and currency."
},
"type": {
"enum": [
"cart"
],
"type": "string",
"description": "Type of information to be displayed by the reader. Only `cart` is currently supported."
}
},
"description": "Represents a reader action to set the reader display",
"x-expandableFields": [
"cart"
]
}
terminal_reader_reader_resource_signature
{
"type": "object",
"title": "TerminalReaderReaderResourceSignature",
"properties": {
"value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The File ID of a collected signature image"
}
},
"description": "Information about a signature being collected using a reader",
"x-expandableFields": []
}
terminal_reader_reader_resource_text
{
"type": "object",
"title": "TerminalReaderReaderResourceText",
"properties": {
"value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The collected text value"
}
},
"description": "Information about text being collected using a reader",
"x-expandableFields": []
}
terminal_reader_reader_resource_tipping_config
{
"type": "object",
"title": "TerminalReaderReaderResourceTippingConfig",
"properties": {
"amount_eligible": {
"type": "integer",
"description": "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency)."
}
},
"description": "Represents a per-transaction tipping configuration",
"x-expandableFields": []
}
terminal_reader_reader_resource_toggle
{
"type": "object",
"title": "TerminalReaderReaderResourceToggle",
"properties": {
"title": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The toggle's title text. Maximum 50 characters."
},
"value": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "The toggle's collected value. Can be `enabled` or `disabled`."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The toggle's description text. Maximum 50 characters."
},
"default_value": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "The toggle's default value. Can be `enabled` or `disabled`."
}
},
"description": "Information about an input's toggle",
"x-expandableFields": []
}
test_helpers.test_clock
{
"type": "object",
"title": "TestClock",
"required": [
"created",
"deletes_after",
"frozen_time",
"id",
"livemode",
"object",
"status",
"status_details"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The custom name supplied at creation."
},
"object": {
"enum": [
"test_helpers.test_clock"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"advancing",
"internal_failure",
"ready"
],
"type": "string",
"description": "The status of the Test Clock."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"frozen_time": {
"type": "integer",
"format": "unix-time",
"description": "Time at which all objects belonging to this clock are frozen."
},
"deletes_after": {
"type": "integer",
"format": "unix-time",
"description": "Time at which this clock is scheduled to auto delete."
},
"status_details": {
"$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details"
}
},
"description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.",
"x-resourceId": "test_helpers.test_clock",
"x-expandableFields": [
"status_details"
]
}
three_d_secure_details
{
"type": "object",
"title": "three_d_secure_details",
"properties": {
"result": {
"enum": [
"attempt_acknowledged",
"authenticated",
"exempted",
"failed",
"not_supported",
"processing_error"
],
"type": "string",
"nullable": true,
"description": "Indicates the outcome of 3D Secure authentication."
},
"version": {
"enum": [
"1.0.2",
"2.1.0",
"2.2.0",
"2.3.0",
"2.3.1"
],
"type": "string",
"nullable": true,
"description": "The version of 3D Secure that was used.",
"x-stripeBypassValidation": true
},
"result_reason": {
"enum": [
"abandoned",
"bypassed",
"canceled",
"card_not_enrolled",
"network_not_supported",
"protocol_error",
"rejected"
],
"type": "string",
"nullable": true,
"description": "Additional information about why 3D Secure succeeded or failed based\non the `result`."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment."
},
"authentication_flow": {
"enum": [
"challenge",
"frictionless"
],
"type": "string",
"nullable": true,
"description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank."
},
"electronic_commerce_indicator": {
"enum": [
"01",
"02",
"05",
"06",
"07"
],
"type": "string",
"nullable": true,
"description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
three_d_secure_details_charge
{
"type": "object",
"title": "three_d_secure_details_charge",
"properties": {
"result": {
"enum": [
"attempt_acknowledged",
"authenticated",
"exempted",
"failed",
"not_supported",
"processing_error"
],
"type": "string",
"nullable": true,
"description": "Indicates the outcome of 3D Secure authentication."
},
"version": {
"enum": [
"1.0.2",
"2.1.0",
"2.2.0",
"2.3.0",
"2.3.1"
],
"type": "string",
"nullable": true,
"description": "The version of 3D Secure that was used.",
"x-stripeBypassValidation": true
},
"result_reason": {
"enum": [
"abandoned",
"bypassed",
"canceled",
"card_not_enrolled",
"network_not_supported",
"protocol_error",
"rejected"
],
"type": "string",
"nullable": true,
"description": "Additional information about why 3D Secure succeeded or failed based\non the `result`."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment."
},
"authentication_flow": {
"enum": [
"challenge",
"frictionless"
],
"type": "string",
"nullable": true,
"description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank."
},
"exemption_indicator": {
"enum": [
"low_risk",
"none"
],
"type": "string",
"nullable": true,
"description": "The exemption requested via 3DS and accepted by the issuer at authentication time."
},
"exemption_indicator_applied": {
"type": "boolean",
"description": "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on\nthe outcome of Stripe's internal risk assessment."
},
"electronic_commerce_indicator": {
"enum": [
"01",
"02",
"05",
"06",
"07"
],
"type": "string",
"nullable": true,
"description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
three_d_secure_usage
{
"type": "object",
"title": "three_d_secure_usage",
"required": [
"supported"
],
"properties": {
"supported": {
"type": "boolean",
"description": "Whether 3D Secure is supported on this card."
}
},
"description": "",
"x-expandableFields": []
}
thresholds_resource_usage_alert_filter
{
"type": "object",
"title": "ThresholdsResourceUsageAlertFilter",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"customer"
],
"type": "string"
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
}
],
"nullable": true,
"description": "Limit the scope of the alert to this customer ID",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"customer"
]
}
thresholds_resource_usage_threshold_config
{
"type": "object",
"title": "ThresholdsResourceUsageThresholdConfig",
"required": [
"gte",
"meter",
"recurrence"
],
"properties": {
"gte": {
"type": "integer",
"description": "The value at which this alert will trigger."
},
"meter": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/billing.meter"
}
],
"description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/billing.meter"
}
]
}
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/thresholds_resource_usage_alert_filter"
},
"nullable": true,
"description": "The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time."
},
"recurrence": {
"enum": [
"one_time"
],
"type": "string",
"description": "Defines how the alert will behave.",
"x-stripeBypassValidation": true
}
},
"description": "The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.",
"x-expandableFields": [
"filters",
"meter"
]
}
token
{
"type": "object",
"title": "Token",
"required": [
"created",
"id",
"livemode",
"object",
"type",
"used"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"card": {
"$ref": "#/components/schemas/card"
},
"type": {
"type": "string",
"maxLength": 5000,
"description": "Type of the token: `account`, `bank_account`, `card`, or `pii`."
},
"used": {
"type": "boolean",
"description": "Determines if you have already used this token (you can only use tokens once)."
},
"object": {
"enum": [
"token"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"client_ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "IP address of the client that generates the token."
},
"bank_account": {
"$ref": "#/components/schemas/bank_account"
}
},
"description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://docs.stripe.com/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://docs.stripe.com/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.",
"x-resourceId": "token",
"x-expandableFields": [
"bank_account",
"card"
]
}
token_card_networks
{
"type": "object",
"title": "token_card_networks",
"properties": {
"preferred": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card."
}
},
"description": "",
"x-expandableFields": []
}
topup
{
"type": "object",
"title": "Topup",
"required": [
"amount",
"created",
"currency",
"id",
"livemode",
"metadata",
"object",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount transferred."
},
"object": {
"enum": [
"topup"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/source"
}
],
"nullable": true,
"description": "The source field is deprecated. It might not always be present in the API response."
},
"status": {
"enum": [
"canceled",
"failed",
"pending",
"reversed",
"succeeded"
],
"type": "string",
"description": "The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"maxLength": 5000,
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"failure_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Error code explaining reason for top-up failure if available (see [the errors section](/api/errors) for a list of codes)."
},
"transfer_group": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string that identifies this top-up as part of a group."
},
"failure_message": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Message to user further explaining reason for top-up failure if available."
},
"balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"nullable": true,
"description": "ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
},
"statement_descriptor": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter."
},
"expected_availability_date": {
"type": "integer",
"nullable": true,
"description": "Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up."
}
},
"description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups)",
"x-resourceId": "topup",
"x-expandableFields": [
"balance_transaction",
"source"
]
}
transfer
{
"type": "object",
"title": "Transfer",
"required": [
"amount",
"amount_reversed",
"created",
"currency",
"id",
"livemode",
"metadata",
"object",
"reversals",
"reversed"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount in cents (or local equivalent) to be transferred."
},
"object": {
"enum": [
"transfer"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time that this record of the transfer was first created."
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"reversed": {
"type": "boolean",
"description": "Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false."
},
"reversals": {
"type": "object",
"title": "TransferReversalList",
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/transfer_reversal"
},
"description": "Details about each object."
},
"object": {
"enum": [
"list"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
},
"has_more": {
"type": "boolean",
"description": "True if this list has another page of items after this one that can be fetched."
}
},
"description": "A list of reversals that have been applied to the transfer.",
"x-expandableFields": [
"data"
]
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"destination": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"nullable": true,
"description": "ID of the Stripe account the transfer was sent to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
},
"source_type": {
"type": "string",
"maxLength": 5000,
"description": "The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`."
},
"transfer_group": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details."
},
"amount_reversed": {
"type": "integer",
"description": "Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued)."
},
"source_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/charge"
}
],
"nullable": true,
"description": "ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
},
"balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"nullable": true,
"description": "Balance transaction that describes the impact of this transfer on your account balance.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
},
"destination_payment": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/charge"
}
],
"description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
}
},
"description": "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://docs.stripe.com/transfer-payout-split).\n\nRelated guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers)",
"x-resourceId": "transfer",
"x-expandableFields": [
"balance_transaction",
"destination",
"destination_payment",
"reversals",
"source_transaction"
]
}
transfer_data
{
"type": "object",
"title": "transfer_data",
"required": [
"destination"
],
"properties": {
"amount": {
"type": "integer",
"description": "The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.\n The amount must be less than or equal to the [amount](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer\n representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00)."
},
"destination": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"description": "The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"destination"
]
}
transfer_reversal
{
"type": "object",
"title": "TransferReversal",
"required": [
"amount",
"created",
"currency",
"id",
"object",
"transfer"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount, in cents (or local equivalent)."
},
"object": {
"enum": [
"transfer_reversal"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"transfer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/transfer"
}
],
"description": "ID of the transfer that was reversed.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/transfer"
}
]
}
},
"source_refund": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/refund"
}
],
"nullable": true,
"description": "ID of the refund responsible for the transfer reversal.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/refund"
}
]
}
},
"balance_transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/balance_transaction"
}
],
"nullable": true,
"description": "Balance transaction that describes the impact on your account balance.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/balance_transaction"
}
]
}
},
"destination_payment_refund": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/refund"
}
],
"nullable": true,
"description": "Linked payment refund for the transfer reversal.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/refund"
}
]
}
}
},
"description": "[Stripe Connect](https://docs.stripe.com/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers)",
"x-resourceId": "transfer_reversal",
"x-expandableFields": [
"balance_transaction",
"destination_payment_refund",
"source_refund",
"transfer"
]
}
transfer_schedule
{
"type": "object",
"title": "TransferSchedule",
"required": [
"delay_days",
"interval"
],
"properties": {
"interval": {
"type": "string",
"maxLength": 5000,
"description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`."
},
"delay_days": {
"type": "integer",
"description": "The number of days charges for the account will be held before being paid out."
},
"weekly_anchor": {
"type": "string",
"maxLength": 5000,
"description": "The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly."
},
"monthly_anchor": {
"type": "integer",
"description": "The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months."
},
"weekly_payout_days": {
"type": "array",
"items": {
"enum": [
"friday",
"monday",
"thursday",
"tuesday",
"wednesday"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly."
},
"monthly_payout_days": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months."
}
},
"description": "",
"x-expandableFields": []
}
transform_quantity
{
"type": "object",
"title": "TransformQuantity",
"required": [
"divide_by",
"round"
],
"properties": {
"round": {
"enum": [
"down",
"up"
],
"type": "string",
"description": "After division, either round the result `up` or `down`."
},
"divide_by": {
"type": "integer",
"description": "Divide usage by this number."
}
},
"description": "",
"x-expandableFields": []
}
transform_usage
{
"type": "object",
"title": "TransformUsage",
"required": [
"divide_by",
"round"
],
"properties": {
"round": {
"enum": [
"down",
"up"
],
"type": "string",
"description": "After division, either round the result `up` or `down`."
},
"divide_by": {
"type": "integer",
"description": "Divide usage by this number."
}
},
"description": "",
"x-expandableFields": []
}
treasury.credit_reversal
{
"type": "object",
"title": "TreasuryReceivedCreditsResourceCreditReversal",
"required": [
"amount",
"created",
"currency",
"financial_account",
"id",
"livemode",
"metadata",
"network",
"object",
"received_credit",
"status",
"status_transitions"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount (in cents) transferred."
},
"object": {
"enum": [
"treasury.credit_reversal"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"canceled",
"posted",
"processing"
],
"type": "string",
"description": "Status of the CreditReversal"
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"network": {
"enum": [
"ach",
"stripe"
],
"type": "string",
"description": "The rails used to reverse the funds."
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/treasury.transaction"
}
],
"nullable": true,
"description": "The Transaction associated with this object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/treasury.transaction"
}
]
}
},
"received_credit": {
"type": "string",
"maxLength": 5000,
"description": "The ReceivedCredit being reversed."
},
"financial_account": {
"type": "string",
"maxLength": 5000,
"description": "The FinancialAccount to reverse funds from."
},
"status_transitions": {
"$ref": "#/components/schemas/treasury_received_credits_resource_status_transitions"
},
"hosted_regulatory_receipt_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
}
},
"description": "You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.",
"x-resourceId": "treasury.credit_reversal",
"x-expandableFields": [
"status_transitions",
"transaction"
]
}
treasury.debit_reversal
{
"type": "object",
"title": "TreasuryReceivedDebitsResourceDebitReversal",
"required": [
"amount",
"created",
"currency",
"id",
"livemode",
"metadata",
"network",
"object",
"received_debit",
"status",
"status_transitions"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount (in cents) transferred."
},
"object": {
"enum": [
"treasury.debit_reversal"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"failed",
"processing",
"succeeded"
],
"type": "string",
"description": "Status of the DebitReversal"
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"network": {
"enum": [
"ach",
"card"
],
"type": "string",
"description": "The rails used to reverse the funds."
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/treasury.transaction"
}
],
"nullable": true,
"description": "The Transaction associated with this object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/treasury.transaction"
}
]
}
},
"linked_flows": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_received_debits_resource_debit_reversal_linked_flows"
}
],
"nullable": true,
"description": "Other flows linked to a DebitReversal."
},
"received_debit": {
"type": "string",
"maxLength": 5000,
"description": "The ReceivedDebit being reversed."
},
"financial_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The FinancialAccount to reverse funds from."
},
"status_transitions": {
"$ref": "#/components/schemas/treasury_received_debits_resource_status_transitions"
},
"hosted_regulatory_receipt_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
}
},
"description": "You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.",
"x-resourceId": "treasury.debit_reversal",
"x-expandableFields": [
"linked_flows",
"status_transitions",
"transaction"
]
}
treasury.financial_account
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceFinancialAccount",
"required": [
"balance",
"country",
"created",
"financial_addresses",
"id",
"livemode",
"object",
"status",
"status_details",
"supported_currencies"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"treasury.financial_account"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"closed",
"open"
],
"type": "string",
"description": "Status of this FinancialAccount.",
"x-stripeBypassValidation": true
},
"balance": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_balance"
},
"country": {
"type": "string",
"maxLength": 5000,
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"features": {
"$ref": "#/components/schemas/treasury.financial_account_features"
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"nickname": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The nickname for the FinancialAccount."
},
"is_default": {
"type": "boolean"
},
"status_details": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_status_details"
},
"active_features": {
"type": "array",
"items": {
"enum": [
"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"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "The array of paths to active Features in the Features hash."
},
"pending_features": {
"type": "array",
"items": {
"enum": [
"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"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "The array of paths to pending Features in the Features hash."
},
"financial_addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_address"
},
"description": "The set of credentials that resolve to a FinancialAccount."
},
"restricted_features": {
"type": "array",
"items": {
"enum": [
"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"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "The array of paths to restricted Features in the Features hash."
},
"supported_currencies": {
"type": "array",
"items": {
"type": "string"
},
"description": "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."
},
"platform_restrictions": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_financial_accounts_resource_platform_restrictions"
}
],
"nullable": true,
"description": "The set of functionalities that the platform can restrict on the FinancialAccount."
}
},
"description": "Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.\nFinancialAccounts serve as the source and destination of Treasury’s money movement APIs.",
"x-resourceId": "treasury.financial_account",
"x-expandableFields": [
"balance",
"features",
"financial_addresses",
"platform_restrictions",
"status_details"
]
}
treasury.financial_account_features
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceFinancialAccountFeatures",
"required": [
"object"
],
"properties": {
"object": {
"enum": [
"treasury.financial_account_features"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"card_issuing": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
},
"deposit_insurance": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
},
"inbound_transfers": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_transfers"
},
"outbound_payments": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_payments"
},
"intra_stripe_flows": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
},
"outbound_transfers": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_transfers"
},
"financial_addresses": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_addresses_features"
}
},
"description": "Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.\nStripe or the platform can control Features via the requested field.",
"x-resourceId": "treasury.financial_account_features",
"x-expandableFields": [
"card_issuing",
"deposit_insurance",
"financial_addresses",
"inbound_transfers",
"intra_stripe_flows",
"outbound_payments",
"outbound_transfers"
]
}
treasury.inbound_transfer
{
"type": "object",
"title": "TreasuryInboundTransfersResourceInboundTransfer",
"required": [
"amount",
"cancelable",
"created",
"currency",
"financial_account",
"id",
"linked_flows",
"livemode",
"metadata",
"object",
"statement_descriptor",
"status",
"status_transitions"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount (in cents) transferred."
},
"object": {
"enum": [
"treasury.inbound_transfer"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"canceled",
"failed",
"processing",
"succeeded"
],
"type": "string",
"description": "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.",
"x-stripeBypassValidation": true
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"returned": {
"type": "boolean",
"nullable": true,
"description": "Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state."
},
"cancelable": {
"type": "boolean",
"description": "Returns `true` if the InboundTransfer is able to be canceled."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/treasury.transaction"
}
],
"nullable": true,
"description": "The Transaction associated with this object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/treasury.transaction"
}
]
}
},
"linked_flows": {
"$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows"
},
"failure_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_inbound_transfers_resource_failure_details"
}
],
"nullable": true,
"description": "Details about this InboundTransfer's failure. Only set when status is `failed`."
},
"financial_account": {
"type": "string",
"maxLength": 5000,
"description": "The FinancialAccount that received the funds."
},
"status_transitions": {
"$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions"
},
"statement_descriptor": {
"type": "string",
"maxLength": 5000,
"description": "Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`."
},
"origin_payment_method": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The origin payment method to be debited for an InboundTransfer."
},
"hosted_regulatory_receipt_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"origin_payment_method_details": {
"anyOf": [
{
"$ref": "#/components/schemas/inbound_transfers"
}
],
"nullable": true,
"description": "Details about the PaymentMethod for an InboundTransfer."
}
},
"description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)",
"x-resourceId": "treasury.inbound_transfer",
"x-expandableFields": [
"failure_details",
"linked_flows",
"origin_payment_method_details",
"status_transitions",
"transaction"
]
}
treasury.outbound_payment
{
"type": "object",
"title": "TreasuryOutboundPaymentsResourceOutboundPayment",
"required": [
"amount",
"cancelable",
"created",
"currency",
"expected_arrival_date",
"financial_account",
"id",
"livemode",
"metadata",
"object",
"statement_descriptor",
"status",
"status_transitions",
"transaction"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount (in cents) transferred."
},
"object": {
"enum": [
"treasury.outbound_payment"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"canceled",
"failed",
"posted",
"processing",
"returned"
],
"type": "string",
"description": "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`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"customer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"cancelable": {
"type": "boolean",
"description": "Returns `true` if the object can be canceled, and `false` otherwise."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/treasury.transaction"
}
],
"description": "The Transaction associated with this object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/treasury.transaction"
}
]
}
},
"end_user_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_end_user_details"
}
],
"nullable": true,
"description": "Details about the end user."
},
"returned_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_outbound_payments_resource_returned_status"
}
],
"nullable": true,
"description": "Details about a returned OutboundPayment. Only set when the status is `returned`."
},
"tracking_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details"
}
],
"nullable": true,
"description": "Details about network-specific tracking information if available."
},
"financial_account": {
"type": "string",
"maxLength": 5000,
"description": "The FinancialAccount that funds were pulled from."
},
"status_transitions": {
"$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions"
},
"statement_descriptor": {
"type": "string",
"maxLength": 5000,
"description": "The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer)."
},
"expected_arrival_date": {
"type": "integer",
"format": "unix-time",
"description": "The date when funds are expected to arrive in the destination account."
},
"destination_payment_method": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`."
},
"hosted_regulatory_receipt_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"destination_payment_method_details": {
"anyOf": [
{
"$ref": "#/components/schemas/outbound_payments_payment_method_details"
}
],
"nullable": true,
"description": "Details about the PaymentMethod for an OutboundPayment."
}
},
"description": "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://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)",
"x-resourceId": "treasury.outbound_payment",
"x-expandableFields": [
"destination_payment_method_details",
"end_user_details",
"returned_details",
"status_transitions",
"tracking_details",
"transaction"
]
}
treasury.outbound_transfer
{
"type": "object",
"title": "TreasuryOutboundTransfersResourceOutboundTransfer",
"required": [
"amount",
"cancelable",
"created",
"currency",
"destination_payment_method_details",
"expected_arrival_date",
"financial_account",
"id",
"livemode",
"metadata",
"object",
"statement_descriptor",
"status",
"status_transitions",
"transaction"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount (in cents) transferred."
},
"object": {
"enum": [
"treasury.outbound_transfer"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"canceled",
"failed",
"posted",
"processing",
"returned"
],
"type": "string",
"description": "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`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "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.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"cancelable": {
"type": "boolean",
"description": "Returns `true` if the object can be canceled, and `false` otherwise."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/treasury.transaction"
}
],
"description": "The Transaction associated with this object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/treasury.transaction"
}
]
}
},
"returned_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_outbound_transfers_resource_returned_details"
}
],
"nullable": true,
"description": "Details about a returned OutboundTransfer. Only set when the status is `returned`."
},
"tracking_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details"
}
],
"nullable": true,
"description": "Details about network-specific tracking information if available."
},
"financial_account": {
"type": "string",
"maxLength": 5000,
"description": "The FinancialAccount that funds were pulled from."
},
"status_transitions": {
"$ref": "#/components/schemas/treasury_outbound_transfers_resource_status_transitions"
},
"statement_descriptor": {
"type": "string",
"maxLength": 5000,
"description": "Information about the OutboundTransfer to be sent to the recipient account."
},
"expected_arrival_date": {
"type": "integer",
"format": "unix-time",
"description": "The date when funds are expected to arrive in the destination account."
},
"destination_payment_method": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The PaymentMethod used as the payment instrument for an OutboundTransfer."
},
"hosted_regulatory_receipt_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"destination_payment_method_details": {
"$ref": "#/components/schemas/outbound_transfers_payment_method_details"
}
},
"description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)",
"x-resourceId": "treasury.outbound_transfer",
"x-expandableFields": [
"destination_payment_method_details",
"returned_details",
"status_transitions",
"tracking_details",
"transaction"
]
}
treasury.received_credit
{
"type": "object",
"title": "TreasuryReceivedCreditsResourceReceivedCredit",
"required": [
"amount",
"created",
"currency",
"description",
"id",
"initiating_payment_method_details",
"linked_flows",
"livemode",
"network",
"object",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount (in cents) transferred."
},
"object": {
"enum": [
"treasury.received_credit"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"failed",
"succeeded"
],
"type": "string",
"description": "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.",
"x-stripeBypassValidation": true
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"network": {
"enum": [
"ach",
"card",
"stripe",
"us_domestic_wire"
],
"type": "string",
"description": "The rails used to send the funds.",
"x-stripeBypassValidation": true
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/treasury.transaction"
}
],
"nullable": true,
"description": "The Transaction associated with this object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/treasury.transaction"
}
]
}
},
"failure_code": {
"enum": [
"account_closed",
"account_frozen",
"international_transaction",
"other"
],
"type": "string",
"nullable": true,
"description": "Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.",
"x-stripeBypassValidation": true
},
"linked_flows": {
"$ref": "#/components/schemas/treasury_received_credits_resource_linked_flows"
},
"reversal_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_received_credits_resource_reversal_details"
}
],
"nullable": true,
"description": "Details describing when a ReceivedCredit may be reversed."
},
"financial_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The FinancialAccount that received the funds."
},
"hosted_regulatory_receipt_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"initiating_payment_method_details": {
"$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
}
},
"description": "ReceivedCredits represent funds sent to a [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.",
"x-resourceId": "treasury.received_credit",
"x-expandableFields": [
"initiating_payment_method_details",
"linked_flows",
"reversal_details",
"transaction"
]
}
treasury.received_debit
{
"type": "object",
"title": "TreasuryReceivedDebitsResourceReceivedDebit",
"required": [
"amount",
"created",
"currency",
"description",
"id",
"linked_flows",
"livemode",
"network",
"object",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "Amount (in cents) transferred."
},
"object": {
"enum": [
"treasury.received_debit"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"failed",
"succeeded"
],
"type": "string",
"description": "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`.",
"x-stripeBypassValidation": true
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"network": {
"enum": [
"ach",
"card",
"stripe"
],
"type": "string",
"description": "The network used for the ReceivedDebit.",
"x-stripeBypassValidation": true
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/treasury.transaction"
}
],
"nullable": true,
"description": "The Transaction associated with this object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/treasury.transaction"
}
]
}
},
"failure_code": {
"enum": [
"account_closed",
"account_frozen",
"insufficient_funds",
"international_transaction",
"other"
],
"type": "string",
"nullable": true,
"description": "Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen."
},
"linked_flows": {
"$ref": "#/components/schemas/treasury_received_debits_resource_linked_flows"
},
"reversal_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_received_debits_resource_reversal_details"
}
],
"nullable": true,
"description": "Details describing when a ReceivedDebit might be reversed."
},
"financial_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The FinancialAccount that funds were pulled from."
},
"hosted_regulatory_receipt_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"initiating_payment_method_details": {
"$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
}
},
"description": "ReceivedDebits represent funds pulled from a [FinancialAccount](https://api.stripe.com#financial_accounts). These are not initiated from the FinancialAccount.",
"x-resourceId": "treasury.received_debit",
"x-expandableFields": [
"initiating_payment_method_details",
"linked_flows",
"reversal_details",
"transaction"
]
}
treasury.transaction
{
"type": "object",
"title": "TreasuryTransactionsResourceTransaction",
"required": [
"amount",
"balance_impact",
"created",
"currency",
"description",
"financial_account",
"flow_type",
"id",
"livemode",
"object",
"status",
"status_transitions"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"flow": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the flow that created the Transaction."
},
"amount": {
"type": "integer",
"description": "Amount (in cents) transferred."
},
"object": {
"enum": [
"treasury.transaction"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"open",
"posted",
"void"
],
"type": "string",
"description": "Status of the Transaction."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"entries": {
"type": "object",
"title": "TreasuryTransactionsResourceTransactionEntryList",
"nullable": true,
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"pattern": "^/v1/treasury/transaction_entries",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/treasury.transaction_entry"
},
"description": "Details about each object."
},
"object": {
"enum": [
"list"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
},
"has_more": {
"type": "boolean",
"description": "True if this list has another page of items after this one that can be fetched."
}
},
"description": "A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.",
"x-expandableFields": [
"data"
]
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"flow_type": {
"enum": [
"credit_reversal",
"debit_reversal",
"inbound_transfer",
"issuing_authorization",
"other",
"outbound_payment",
"outbound_transfer",
"received_credit",
"received_debit"
],
"type": "string",
"description": "Type of the flow that created the Transaction.",
"x-stripeBypassValidation": true
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"flow_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_transactions_resource_flow_details"
}
],
"nullable": true,
"description": "Details of the flow that created the Transaction."
},
"balance_impact": {
"$ref": "#/components/schemas/treasury_transactions_resource_balance_impact"
},
"financial_account": {
"type": "string",
"maxLength": 5000,
"description": "The FinancialAccount associated with this object."
},
"status_transitions": {
"$ref": "#/components/schemas/treasury_transactions_resource_abstract_transaction_resource_status_transitions"
}
},
"description": "Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance.",
"x-resourceId": "treasury.transaction",
"x-expandableFields": [
"balance_impact",
"entries",
"flow_details",
"status_transitions"
]
}
treasury.transaction_entry
{
"type": "object",
"title": "TreasuryTransactionsResourceTransactionEntry",
"required": [
"balance_impact",
"created",
"currency",
"effective_at",
"financial_account",
"flow_type",
"id",
"livemode",
"object",
"transaction",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"flow": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Token of the flow associated with the TransactionEntry."
},
"type": {
"enum": [
"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"
],
"type": "string",
"description": "The specific money movement that generated the TransactionEntry."
},
"object": {
"enum": [
"treasury.transaction_entry"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "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)."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"flow_type": {
"enum": [
"credit_reversal",
"debit_reversal",
"inbound_transfer",
"issuing_authorization",
"other",
"outbound_payment",
"outbound_transfer",
"received_credit",
"received_debit"
],
"type": "string",
"description": "Type of the flow associated with the TransactionEntry.",
"x-stripeBypassValidation": true
},
"transaction": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/treasury.transaction"
}
],
"description": "The Transaction associated with this object.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/treasury.transaction"
}
]
}
},
"effective_at": {
"type": "integer",
"format": "unix-time",
"description": "When the TransactionEntry will impact the FinancialAccount's balance."
},
"flow_details": {
"anyOf": [
{
"$ref": "#/components/schemas/treasury_transactions_resource_flow_details"
}
],
"nullable": true,
"description": "Details of the flow associated with the TransactionEntry."
},
"balance_impact": {
"$ref": "#/components/schemas/treasury_transactions_resource_balance_impact"
},
"financial_account": {
"type": "string",
"maxLength": 5000,
"description": "The FinancialAccount associated with this object."
}
},
"description": "TransactionEntries represent individual units of money movements within a single [Transaction](https://api.stripe.com#transactions).",
"x-resourceId": "treasury.transaction_entry",
"x-expandableFields": [
"balance_impact",
"flow_details",
"transaction"
]
}
treasury_financial_accounts_resource_aba_record
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceABARecord",
"required": [
"account_holder_name",
"account_number_last4",
"bank_name",
"routing_number"
],
"properties": {
"bank_name": {
"type": "string",
"maxLength": 5000,
"description": "Name of the bank."
},
"account_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The account number."
},
"routing_number": {
"type": "string",
"maxLength": 5000,
"description": "Routing number for the account."
},
"account_holder_name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the person or business that owns the bank account."
},
"account_number_last4": {
"type": "string",
"maxLength": 5000,
"description": "The last four characters of the account number."
}
},
"description": "ABA Records contain U.S. bank account details per the ABA format.",
"x-expandableFields": []
}
treasury_financial_accounts_resource_aba_toggle_settings
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceAbaToggleSettings",
"required": [
"requested",
"status",
"status_details"
],
"properties": {
"status": {
"enum": [
"active",
"pending",
"restricted"
],
"type": "string",
"description": "Whether the Feature is operational."
},
"requested": {
"type": "boolean",
"description": "Whether the FinancialAccount should have the Feature."
},
"status_details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
},
"description": "Additional details; includes at least one entry when the status is not `active`."
}
},
"description": "Toggle settings for enabling/disabling the ABA address feature",
"x-expandableFields": [
"status_details"
]
}
treasury_financial_accounts_resource_balance
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceBalance",
"required": [
"cash",
"inbound_pending",
"outbound_pending"
],
"properties": {
"cash": {
"type": "object",
"description": "Funds the user can spend right now.",
"additionalProperties": {
"type": "integer"
}
},
"inbound_pending": {
"type": "object",
"description": "Funds not spendable yet, but will become available at a later time.",
"additionalProperties": {
"type": "integer"
}
},
"outbound_pending": {
"type": "object",
"description": "Funds in the account, but not spendable because they are being held for pending outbound flows.",
"additionalProperties": {
"type": "integer"
}
}
},
"description": "Balance information for the FinancialAccount",
"x-expandableFields": []
}
treasury_financial_accounts_resource_closed_status_details
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceClosedStatusDetails",
"required": [
"reasons"
],
"properties": {
"reasons": {
"type": "array",
"items": {
"enum": [
"account_rejected",
"closed_by_platform",
"other"
],
"type": "string"
},
"description": "The array that contains reasons for a FinancialAccount closure."
}
},
"description": "",
"x-expandableFields": []
}
treasury_financial_accounts_resource_financial_address
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceFinancialAddress",
"required": [
"type"
],
"properties": {
"aba": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_record"
},
"type": {
"enum": [
"aba"
],
"type": "string",
"description": "The type of financial address",
"x-stripeBypassValidation": true
},
"supported_networks": {
"type": "array",
"items": {
"enum": [
"ach",
"us_domestic_wire"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "The list of networks that the address supports"
}
},
"description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.",
"x-expandableFields": [
"aba"
]
}
treasury_financial_accounts_resource_financial_addresses_features
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceFinancialAddressesFeatures",
"properties": {
"aba": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_toggle_settings"
}
},
"description": "Settings related to Financial Addresses features on a Financial Account",
"x-expandableFields": [
"aba"
]
}
treasury_financial_accounts_resource_inbound_ach_toggle_settings
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceInboundAchToggleSettings",
"required": [
"requested",
"status",
"status_details"
],
"properties": {
"status": {
"enum": [
"active",
"pending",
"restricted"
],
"type": "string",
"description": "Whether the Feature is operational."
},
"requested": {
"type": "boolean",
"description": "Whether the FinancialAccount should have the Feature."
},
"status_details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
},
"description": "Additional details; includes at least one entry when the status is not `active`."
}
},
"description": "Toggle settings for enabling/disabling an inbound ACH specific feature",
"x-expandableFields": [
"status_details"
]
}
treasury_financial_accounts_resource_inbound_transfers
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceInboundTransfers",
"properties": {
"ach": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_ach_toggle_settings"
}
},
"description": "InboundTransfers contains inbound transfers features for a FinancialAccount.",
"x-expandableFields": [
"ach"
]
}
treasury_financial_accounts_resource_outbound_ach_toggle_settings
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceOutboundAchToggleSettings",
"required": [
"requested",
"status",
"status_details"
],
"properties": {
"status": {
"enum": [
"active",
"pending",
"restricted"
],
"type": "string",
"description": "Whether the Feature is operational."
},
"requested": {
"type": "boolean",
"description": "Whether the FinancialAccount should have the Feature."
},
"status_details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
},
"description": "Additional details; includes at least one entry when the status is not `active`."
}
},
"description": "Toggle settings for enabling/disabling an outbound ACH specific feature",
"x-expandableFields": [
"status_details"
]
}
treasury_financial_accounts_resource_outbound_payments
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceOutboundPayments",
"properties": {
"ach": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings"
},
"us_domestic_wire": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
}
},
"description": "Settings related to Outbound Payments features on a Financial Account",
"x-expandableFields": [
"ach",
"us_domestic_wire"
]
}
treasury_financial_accounts_resource_outbound_transfers
{
"type": "object",
"title": "TreasuryFinancialAccountsResourceOutboundTransfers",
"properties": {
"ach": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings"
},
"us_domestic_wire": {
"$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
}
},
"description": "OutboundTransfers contains outbound transfers features for a FinancialAccount.",
"x-expandableFields": [
"ach",
"us_domestic_wire"
]
}