refund_destination_details_card
{
"type": "object",
"title": "refund_destination_details_card",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"pending",
"refund",
"reversal"
],
"type": "string",
"description": "The type of refund. This can be `refund`, `reversal`, or `pending`."
},
"reference": {
"type": "string",
"maxLength": 5000,
"description": "Value of the reference number assigned to the refund."
},
"reference_type": {
"type": "string",
"maxLength": 5000,
"description": "Type of the reference number assigned to the refund."
},
"reference_status": {
"type": "string",
"maxLength": 5000,
"description": "Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_crypto
{
"type": "object",
"title": "refund_destination_details_crypto",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The transaction hash of the refund."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_eu_bank_transfer
{
"type": "object",
"title": "refund_destination_details_eu_bank_transfer",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_gb_bank_transfer
{
"type": "object",
"title": "refund_destination_details_gb_bank_transfer",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_jp_bank_transfer
{
"type": "object",
"title": "refund_destination_details_jp_bank_transfer",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_mb_way
{
"type": "object",
"title": "refund_destination_details_mb_way",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_multibanco
{
"type": "object",
"title": "refund_destination_details_multibanco",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_mx_bank_transfer
{
"type": "object",
"title": "refund_destination_details_mx_bank_transfer",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_p24
{
"type": "object",
"title": "refund_destination_details_p24",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_paypal
{
"type": "object",
"title": "refund_destination_details_paypal",
"properties": {
"network_decline_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_swish
{
"type": "object",
"title": "refund_destination_details_swish",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
},
"network_decline_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_th_bank_transfer
{
"type": "object",
"title": "refund_destination_details_th_bank_transfer",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_destination_details_us_bank_transfer
{
"type": "object",
"title": "refund_destination_details_us_bank_transfer",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The reference assigned to the refund."
},
"reference_status": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
}
},
"description": "",
"x-expandableFields": []
}
refund_next_action
{
"type": "object",
"title": "RefundNextAction",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "Type of the next action to perform."
},
"display_details": {
"$ref": "#/components/schemas/refund_next_action_display_details"
}
},
"description": "",
"x-expandableFields": [
"display_details"
]
}
refund_next_action_display_details
{
"type": "object",
"title": "RefundNextActionDisplayDetails",
"required": [
"email_sent",
"expires_at"
],
"properties": {
"email_sent": {
"$ref": "#/components/schemas/email_sent"
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"description": "The expiry timestamp."
}
},
"description": "",
"x-expandableFields": [
"email_sent"
]
}
reporting.report_run
{
"type": "object",
"title": "reporting_report_run",
"required": [
"created",
"id",
"livemode",
"object",
"parameters",
"report_type",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"error": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If something should go wrong during the run, a message about the failure (populated when\n `status=failed`)."
},
"object": {
"enum": [
"reporting.report_run"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"result": {
"anyOf": [
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The file object representing the result of the report run (populated when\n `status=succeeded`)."
},
"status": {
"type": "string",
"maxLength": 5000,
"description": "Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated."
},
"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": "`true` if the report is run on live mode data and `false` if it is run on test mode data."
},
"parameters": {
"$ref": "#/components/schemas/financial_reporting_finance_report_run_run_parameters"
},
"report_type": {
"type": "string",
"maxLength": 5000,
"description": "The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `\"balance.summary.1\"`."
},
"succeeded_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch."
}
},
"description": "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://docs.stripe.com/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes).",
"x-resourceId": "reporting.report_run",
"x-expandableFields": [
"parameters",
"result"
]
}
reporting.report_type
{
"type": "object",
"title": "reporting_report_type",
"required": [
"data_available_end",
"data_available_start",
"id",
"livemode",
"name",
"object",
"updated",
"version"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "Human-readable name of the Report Type"
},
"object": {
"enum": [
"reporting.report_type"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"updated": {
"type": "integer",
"format": "unix-time",
"description": "When this Report Type was latest updated. Measured in seconds since the Unix epoch."
},
"version": {
"type": "integer",
"description": "Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas."
},
"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`."
},
"default_columns": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)"
},
"data_available_end": {
"type": "integer",
"format": "unix-time",
"description": "Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch."
},
"data_available_start": {
"type": "integer",
"format": "unix-time",
"description": "Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch."
}
},
"description": "The Report Type resource corresponds to a particular type of report, such as\nthe \"Activity summary\" or \"Itemized payouts\" reports. These objects are\nidentified by an ID belonging to a set of enumerated values. See\n[API Access to Reports documentation](https://docs.stripe.com/reporting/statements/api)\nfor those Report Type IDs, along with required and optional parameters.\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes).",
"x-resourceId": "reporting.report_type",
"x-expandableFields": []
}
reserve_transaction
{
"type": "object",
"title": "ReserveTransaction",
"required": [
"amount",
"currency",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer"
},
"object": {
"enum": [
"reserve_transaction"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"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)."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
}
},
"description": "",
"x-expandableFields": []
}
review
{
"type": "object",
"title": "RadarReview",
"required": [
"created",
"id",
"livemode",
"object",
"open",
"opened_reason",
"reason"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"open": {
"type": "boolean",
"description": "If `true`, the review needs action."
},
"charge": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/charge"
}
],
"nullable": true,
"description": "The charge associated with this review.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
},
"object": {
"enum": [
"review"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"reason": {
"type": "string",
"maxLength": 5000,
"description": "The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/radar_review_resource_session"
}
],
"nullable": true,
"description": "Information related to the browsing session of the user who initiated the payment."
},
"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`."
},
"ip_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address where the payment originated."
},
"billing_zip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ZIP or postal code of the card used, if applicable."
},
"closed_reason": {
"enum": [
"acknowledged",
"approved",
"canceled",
"disputed",
"payment_never_settled",
"redacted",
"refunded",
"refunded_as_fraud"
],
"type": "string",
"nullable": true,
"description": "The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`."
},
"opened_reason": {
"enum": [
"manual",
"rule"
],
"type": "string",
"description": "The reason the review was opened. One of `rule` or `manual`."
},
"payment_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_intent"
}
],
"description": "The PaymentIntent ID associated with this review, if one exists.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_intent"
}
]
}
},
"ip_address_location": {
"anyOf": [
{
"$ref": "#/components/schemas/radar_review_resource_location"
}
],
"nullable": true,
"description": "Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address."
}
},
"description": "Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](https://docs.stripe.com/radar/reviews).",
"x-resourceId": "review",
"x-expandableFields": [
"charge",
"ip_address_location",
"payment_intent",
"session"
]
}
revolut_pay_underlying_payment_method_funding_details
{
"type": "object",
"title": "revolut_pay_underlying_payment_method_funding_details",
"properties": {
"card": {
"$ref": "#/components/schemas/payment_method_details_passthrough_card"
},
"type": {
"enum": [
"card"
],
"type": "string",
"nullable": true,
"description": "funding type of the underlying payment method."
}
},
"description": "",
"x-expandableFields": [
"card"
]
}
rule
{
"type": "object",
"title": "RadarRule",
"required": [
"action",
"id",
"predicate"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"action": {
"type": "string",
"maxLength": 5000,
"description": "The action taken on the payment."
},
"predicate": {
"type": "string",
"maxLength": 5000,
"description": "The predicate to evaluate the payment against."
}
},
"description": "",
"x-expandableFields": []
}
scheduled_query_run
{
"type": "object",
"title": "ScheduledQueryRun",
"required": [
"created",
"data_load_time",
"id",
"livemode",
"object",
"result_available_until",
"sql",
"status",
"title"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"sql": {
"type": "string",
"maxLength": 100000,
"description": "SQL for the query."
},
"file": {
"anyOf": [
{
"$ref": "#/components/schemas/file"
}
],
"nullable": true,
"description": "The file object representing the results of the query."
},
"error": {
"$ref": "#/components/schemas/sigma_scheduled_query_run_error"
},
"title": {
"type": "string",
"maxLength": 5000,
"description": "Title of the query."
},
"object": {
"enum": [
"scheduled_query_run"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"type": "string",
"maxLength": 5000,
"description": "The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise."
},
"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`."
},
"data_load_time": {
"type": "integer",
"format": "unix-time",
"description": "When the query was run, Sigma contained a snapshot of your Stripe data at this time."
},
"result_available_until": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the result expires and is no longer available for download."
}
},
"description": "If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results.",
"x-resourceId": "scheduled_query_run",
"x-expandableFields": [
"error",
"file"
]
}
schedules_phase_automatic_tax
{
"type": "object",
"title": "SchedulesPhaseAutomaticTax",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether Stripe automatically computes tax on invoices created during this phase."
},
"liability": {
"anyOf": [
{
"$ref": "#/components/schemas/connect_account_reference"
}
],
"nullable": true,
"description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
},
"disabled_reason": {
"enum": [
"requires_location_inputs"
],
"type": "string",
"nullable": true,
"description": "If Stripe disabled automatic tax, this enum describes why."
}
},
"description": "",
"x-expandableFields": [
"liability"
]
}
secret_service_resource_scope
{
"type": "object",
"title": "SecretServiceResourceScope",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"account",
"user"
],
"type": "string",
"description": "The secret scope type."
},
"user": {
"type": "string",
"maxLength": 5000,
"description": "The user ID, if type is set to \"user\""
}
},
"description": "",
"x-expandableFields": []
}
sepa_debit_generated_from
{
"type": "object",
"title": "sepa_debit_generated_from",
"properties": {
"charge": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/charge"
}
],
"nullable": true,
"description": "The ID of the Charge that generated this PaymentMethod, if any.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
},
"setup_attempt": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/setup_attempt"
}
],
"nullable": true,
"description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/setup_attempt"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"charge",
"setup_attempt"
]
}
setup_attempt
{
"type": "object",
"title": "PaymentFlowsSetupIntentSetupAttempt",
"required": [
"created",
"id",
"livemode",
"object",
"payment_method",
"payment_method_details",
"setup_intent",
"status",
"usage"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"usage": {
"type": "string",
"maxLength": 5000,
"description": "The value of [usage](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`."
},
"object": {
"enum": [
"setup_attempt"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"type": "string",
"maxLength": 5000,
"description": "Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
],
"nullable": true,
"description": "The value of [customer](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
]
}
},
"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`."
},
"application": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/application"
}
],
"nullable": true,
"description": "The value of [application](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application"
}
]
}
},
"setup_error": {
"anyOf": [
{
"$ref": "#/components/schemas/api_errors"
}
],
"nullable": true,
"description": "The error encountered during this attempt to confirm the SetupIntent, if any."
},
"on_behalf_of": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"nullable": true,
"description": "The value of [on_behalf_of](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
},
"setup_intent": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/setup_intent"
}
],
"description": "ID of the SetupIntent that this attempt belongs to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/setup_intent"
}
]
}
},
"attach_to_self": {
"type": "boolean",
"description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer."
},
"payment_method": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"description": "ID of the payment method used with this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"flow_directions": {
"type": "array",
"items": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"nullable": true,
"description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The value of [customer_account](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer_account) on the SetupIntent at the time of this confirmation."
},
"payment_method_details": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details"
}
},
"description": "A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation is successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent.",
"x-resourceId": "setup_attempt",
"x-expandableFields": [
"application",
"customer",
"on_behalf_of",
"payment_method",
"payment_method_details",
"setup_error",
"setup_intent"
]
}
setup_attempt_payment_method_details
{
"type": "object",
"title": "SetupAttemptPaymentMethodDetails",
"required": [
"type"
],
"properties": {
"pix": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_pix"
},
"upi": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_upi"
},
"card": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_card"
},
"link": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_link"
},
"type": {
"type": "string",
"maxLength": 5000,
"description": "The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method."
},
"ideal": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_ideal"
},
"payto": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_payto"
},
"twint": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_twint"
},
"boleto": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_boleto"
},
"klarna": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_klarna"
},
"paypal": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_paypal"
},
"sofort": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_sofort"
},
"cashapp": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_cashapp"
},
"kr_card": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_kr_card"
},
"satispay": {
"$ref": "#/components/schemas/payment_flows_private_payment_methods_satispay_setup_attempt_details"
},
"kakao_pay": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_kakao_pay"
},
"naver_pay": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_naver_pay"
},
"acss_debit": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_acss_debit"
},
"amazon_pay": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_amazon_pay"
},
"bacs_debit": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_bacs_debit"
},
"bancontact": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_bancontact"
},
"sepa_debit": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_sepa_debit"
},
"revolut_pay": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_revolut_pay"
},
"card_present": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_card_present"
},
"au_becs_debit": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_au_becs_debit"
},
"nz_bank_account": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_nz_bank_account"
},
"us_bank_account": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_us_bank_account"
}
},
"description": "",
"x-expandableFields": [
"acss_debit",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"boleto",
"card",
"card_present",
"cashapp",
"ideal",
"kakao_pay",
"klarna",
"kr_card",
"link",
"naver_pay",
"nz_bank_account",
"paypal",
"payto",
"pix",
"revolut_pay",
"satispay",
"sepa_debit",
"sofort",
"twint",
"upi",
"us_bank_account"
]
}
setup_attempt_payment_method_details_acss_debit
{
"type": "object",
"title": "setup_attempt_payment_method_details_acss_debit",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_amazon_pay
{
"type": "object",
"title": "setup_attempt_payment_method_details_amazon_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_au_becs_debit
{
"type": "object",
"title": "setup_attempt_payment_method_details_au_becs_debit",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_bacs_debit
{
"type": "object",
"title": "setup_attempt_payment_method_details_bacs_debit",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_bancontact
{
"type": "object",
"title": "setup_attempt_payment_method_details_bancontact",
"properties": {
"bic": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank Identifier Code of the bank associated with the bank account."
},
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank code of bank associated with the bank account."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"preferred_language": {
"enum": [
"de",
"en",
"fr",
"nl"
],
"type": "string",
"nullable": true,
"description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"
},
"generated_sepa_debit": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"generated_sepa_debit_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
}
setup_attempt_payment_method_details_boleto
{
"type": "object",
"title": "setup_attempt_payment_method_details_boleto",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_card
{
"type": "object",
"title": "setup_attempt_payment_method_details_card",
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"checks": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_attempt_payment_method_details_card_checks"
}
],
"nullable": true,
"description": "Check results by Card networks on Card address and CVC at the time of authorization"
},
"wallet": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_attempt_payment_method_details_card_wallet"
}
],
"nullable": true,
"description": "If this Card is part of a card wallet, this contains the details of the card wallet."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
},
"funding": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"network": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`."
},
"exp_year": {
"type": "integer",
"nullable": true,
"description": "Four-digit number representing the card's expiration year."
},
"exp_month": {
"type": "integer",
"nullable": true,
"description": "Two-digit number representing the card's expiration month."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
},
"three_d_secure": {
"anyOf": [
{
"$ref": "#/components/schemas/three_d_secure_details"
}
],
"nullable": true,
"description": "Populated if this authorization used 3D Secure authentication."
}
},
"description": "",
"x-expandableFields": [
"checks",
"three_d_secure",
"wallet"
]
}
setup_attempt_payment_method_details_card_checks
{
"type": "object",
"title": "setup_attempt_payment_method_details_card_checks",
"properties": {
"cvc_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
},
"address_line1_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
},
"address_postal_code_check": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
}
},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_card_present
{
"type": "object",
"title": "setup_attempt_payment_method_details_card_present",
"properties": {
"offline": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_present_offline"
}
],
"nullable": true,
"description": "Details about payments collected offline."
},
"generated_card": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the Card PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_card",
"offline"
]
}
setup_attempt_payment_method_details_card_wallet
{
"type": "object",
"title": "setup_attempt_payment_method_details_card_wallet",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"apple_pay",
"google_pay",
"link"
],
"type": "string",
"description": "The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."
},
"apple_pay": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
},
"google_pay": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
}
},
"description": "",
"x-expandableFields": [
"apple_pay",
"google_pay"
]
}
setup_attempt_payment_method_details_cashapp
{
"type": "object",
"title": "setup_attempt_payment_method_details_cashapp",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_ideal
{
"type": "object",
"title": "setup_attempt_payment_method_details_ideal",
"properties": {
"bic": {
"enum": [
"ABNANL2A",
"ADYBNL2A",
"ASNBNL21",
"BITSNL2A",
"BUNQNL2A",
"BUUTNL2A",
"FNOMNL22",
"FVLBNL22",
"HANDNL2A",
"INGBNL2A",
"KNABNL2H",
"MLLENL2A",
"MOYONL21",
"NNBANL2G",
"NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
"REVOLT21",
"SNSBNL2A",
"TRIONL2U"
],
"type": "string",
"nullable": true,
"description": "The Bank Identifier Code of the customer's bank."
},
"bank": {
"enum": [
"abn_amro",
"adyen",
"asn_bank",
"bunq",
"buut",
"finom",
"handelsbanken",
"ing",
"knab",
"mollie",
"moneyou",
"n26",
"nn",
"rabobank",
"regiobank",
"revolut",
"sns_bank",
"triodos_bank",
"van_lanschot",
"yoursafe"
],
"type": "string",
"nullable": true,
"description": "The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"generated_sepa_debit": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"generated_sepa_debit_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
}
setup_attempt_payment_method_details_kakao_pay
{
"type": "object",
"title": "setup_attempt_payment_method_details_kakao_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_klarna
{
"type": "object",
"title": "setup_attempt_payment_method_details_klarna",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_kr_card
{
"type": "object",
"title": "setup_attempt_payment_method_details_kr_card",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_link
{
"type": "object",
"title": "setup_attempt_payment_method_details_link",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_naver_pay
{
"type": "object",
"title": "setup_attempt_payment_method_details_naver_pay",
"properties": {
"buyer_id": {
"type": "string",
"maxLength": 5000,
"description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same."
}
},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_nz_bank_account
{
"type": "object",
"title": "setup_attempt_payment_method_details_nz_bank_account",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_paypal
{
"type": "object",
"title": "setup_attempt_payment_method_details_paypal",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_payto
{
"type": "object",
"title": "setup_attempt_payment_method_details_payto",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_pix
{
"type": "object",
"title": "setup_attempt_payment_method_details_pix",
"properties": {
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular Pix account. You can use this attribute to check whether two Pix accounts are the same."
}
},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_revolut_pay
{
"type": "object",
"title": "setup_attempt_payment_method_details_revolut_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_sepa_debit
{
"type": "object",
"title": "setup_attempt_payment_method_details_sepa_debit",
"properties": {},
"description": "",
"x-expandableFields": []
}