dispute_visa_compelling_evidence3_prior_undisputed_transaction
{
"type": "object",
"title": "DisputeVisaCompellingEvidence3PriorUndisputedTransaction",
"required": [
"charge"
],
"properties": {
"charge": {
"type": "string",
"maxLength": 5000,
"description": "Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge."
},
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/dispute_transaction_shipping_address"
}
],
"nullable": true,
"description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission."
},
"customer_device_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters."
},
"customer_account_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "User Account ID used to log into business platform. Must be recognizable by the user."
},
"product_description": {
"type": "string",
"nullable": true,
"maxLength": 150000,
"description": "A description of the product or service that was sold."
},
"customer_purchase_ip": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The IP address that the customer used when making the purchase."
},
"customer_email_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The email address of the customer."
},
"customer_device_fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters."
}
},
"description": "",
"x-expandableFields": [
"shipping_address"
]
}
email_sent
{
"type": "object",
"title": "EmailSent",
"required": [
"email_sent_at",
"email_sent_to"
],
"properties": {
"email_sent_at": {
"type": "integer",
"format": "unix-time",
"description": "The timestamp when the email was sent."
},
"email_sent_to": {
"type": "string",
"maxLength": 5000,
"description": "The recipient's email address."
}
},
"description": "",
"x-expandableFields": []
}
entitlements.active_entitlement
{
"type": "object",
"title": "ActiveEntitlement",
"required": [
"feature",
"id",
"livemode",
"lookup_key",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"entitlements.active_entitlement"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"feature": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/entitlements.feature"
}
],
"description": "The [Feature](https://docs.stripe.com/api/entitlements/feature) that the customer is entitled to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/entitlements.feature"
}
]
}
},
"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`."
},
"lookup_key": {
"type": "string",
"maxLength": 5000,
"description": "A unique key you provide as your own system identifier. This may be up to 80 characters."
}
},
"description": "An active entitlement describes access to a feature for a customer.",
"x-resourceId": "entitlements.active_entitlement",
"x-expandableFields": [
"feature"
]
}
entitlements.feature
{
"type": "object",
"title": "Feature",
"required": [
"active",
"id",
"livemode",
"lookup_key",
"metadata",
"name",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"maxLength": 80,
"description": "The feature's name, for your own purpose, not meant to be displayable to the customer."
},
"active": {
"type": "boolean",
"description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint."
},
"object": {
"enum": [
"entitlements.feature"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"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 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
}
},
"lookup_key": {
"type": "string",
"maxLength": 5000,
"description": "A unique key you provide as your own system identifier. This may be up to 80 characters."
}
},
"description": "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.",
"x-resourceId": "entitlements.feature",
"x-expandableFields": []
}
ephemeral_key
{
"type": "object",
"title": "EphemeralKey",
"required": [
"created",
"expires",
"id",
"livemode",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"ephemeral_key"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"secret": {
"type": "string",
"maxLength": 5000,
"description": "The key's secret. You can use this value to make authorized requests to the Stripe API."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"expires": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the key will expire. 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`."
}
},
"description": "",
"x-resourceId": "ephemeral_key",
"x-expandableFields": []
}
error
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"$ref": "#/components/schemas/api_errors"
}
},
"description": "An error response from the Stripe API"
}
event
{
"type": "object",
"title": "NotificationEvent",
"required": [
"created",
"data",
"id",
"livemode",
"object",
"pending_webhooks",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"data": {
"$ref": "#/components/schemas/notification_event_data"
},
"type": {
"type": "string",
"maxLength": 5000,
"description": "Description of the event (for example, `invoice.created` or `charge.refunded`)."
},
"object": {
"enum": [
"event"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"account": {
"type": "string",
"maxLength": 5000,
"description": "The connected account that originates the event."
},
"context": {
"type": "string",
"maxLength": 5000,
"description": "Authentication context needed to fetch the event or related object."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"request": {
"anyOf": [
{
"$ref": "#/components/schemas/notification_event_request"
}
],
"nullable": true,
"description": "Information on the API request that triggers the event."
},
"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`."
},
"api_version": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014."
},
"pending_webhooks": {
"type": "integer",
"description": "Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify."
}
},
"description": "Snapshot events allow you to track and react to activity in your Stripe integration. When\nthe state of another API resource changes, Stripe creates an `Event` object that contains\nall the relevant information associated with that action, including the affected API\nresource. For example, a successful payment triggers a `charge.succeeded` event, which\ncontains the `Charge` in the event's data property. Some actions trigger multiple events.\nFor example, if you create a new subscription for a customer, it triggers both a\n`customer.subscription.created` event and a `charge.succeeded` event.\n\nConfigure an event destination in your account to listen for events that represent actions\nyour integration needs to respond to. Additionally, you can retrieve an individual event or\na list of events from the API.\n\n[Connect](https://docs.stripe.com/connect) platforms can also receive event notifications\nthat occur in their connected accounts. These events include an account attribute that\nidentifies the relevant connected account.\n\nYou can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)\nfor 30 days.",
"x-resourceId": "event",
"x-expandableFields": [
"data",
"request"
]
}
exchange_rate
{
"type": "object",
"title": "ExchangeRate",
"required": [
"id",
"object",
"rates"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase."
},
"rates": {
"type": "object",
"description": "Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.",
"additionalProperties": {
"type": "number"
}
},
"object": {
"enum": [
"exchange_rate"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
}
},
"description": "[Deprecated] The `ExchangeRate` APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.\n\n`ExchangeRate` objects allow you to determine the rates that Stripe is currently\nusing to convert from one currency to another. Since this number is variable\nthroughout the day, there are various reasons why you might want to know the current\nrate (for example, to dynamically price an item for a user with a default\npayment in a foreign currency).\n\nPlease refer to our [Exchange Rates API](https://docs.stripe.com/fx-rates) guide for more details.\n\n*[Note: this integration path is supported but no longer recommended]* Additionally,\nyou can guarantee that a charge is made with an exchange rate that you expect is\ncurrent. To do so, you must pass in the exchange_rate to charges endpoints. If the\nvalue is no longer up to date, the charge won't go through. Please refer to our\n[Using with charges](https://docs.stripe.com/exchange-rates) guide for more details.\n\n-----\n\n \n\n*This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*\n\n- *localize prices for processing payments on Stripe*\n- *reconcile Stripe transactions*\n- *determine how much money to send to a connected account*\n- *determine app fees to charge a connected account*\n\n*Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*",
"x-resourceId": "exchange_rate",
"x-expandableFields": []
}
external_account
{
"anyOf": [
{
"$ref": "#/components/schemas/bank_account"
},
{
"$ref": "#/components/schemas/card"
}
],
"title": "Polymorphic",
"x-resourceId": "external_account",
"x-stripeBypassValidation": true
}
external_account_requirements
{
"type": "object",
"title": "ExternalAccountRequirements",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/account_requirements_error"
},
"nullable": true,
"description": "Details about validation and verification failures for `due` requirements that must be resolved."
},
"past_due": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account."
},
"currently_due": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled."
},
"pending_verification": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
}
},
"description": "",
"x-expandableFields": [
"errors"
]
}
fee
{
"type": "object",
"title": "Fee",
"required": [
"amount",
"currency",
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee`, `tax`, or `withheld_tax`."
},
"amount": {
"type": "integer",
"description": "Amount of the fee, in cents."
},
"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)."
},
"application": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the Connect application that earned the fee."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
}
},
"description": "",
"x-expandableFields": []
}
fee_refund
{
"type": "object",
"title": "FeeRefund",
"required": [
"amount",
"created",
"currency",
"fee",
"id",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"fee": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/application_fee"
}
],
"description": "ID of the application fee that was refunded.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application_fee"
}
]
}
},
"amount": {
"type": "integer",
"description": "Amount, in cents (or local equivalent)."
},
"object": {
"enum": [
"fee_refund"
],
"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
}
},
"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"
}
]
}
}
},
"description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee)",
"x-resourceId": "fee_refund",
"x-expandableFields": [
"balance_transaction",
"fee"
]
}
file
{
"type": "object",
"title": "File",
"required": [
"created",
"id",
"object",
"purpose",
"size"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Use your live secret API key to download the file from this URL."
},
"size": {
"type": "integer",
"description": "The size of the file object in bytes."
},
"type": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`)."
},
"links": {
"type": "object",
"title": "FileResourceFileLinkList",
"nullable": true,
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"pattern": "^/v1/file_links",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/file_link"
},
"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 [file links](https://api.stripe.com#file_links) that point at this file.",
"x-expandableFields": [
"data"
]
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A suitable title for the document."
},
"object": {
"enum": [
"file"
],
"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."
},
"purpose": {
"enum": [
"account_requirement",
"additional_verification",
"business_icon",
"business_logo",
"customer_signature",
"dispute_evidence",
"document_provider_identity_document",
"finance_report_run",
"financial_account_statement",
"identity_document",
"identity_document_downloadable",
"issuing_regulatory_reporting",
"pci_document",
"platform_terms_of_service",
"selfie",
"sigma_scheduled_query",
"tax_document_user_upload",
"terminal_android_apk",
"terminal_reader_splashscreen",
"terminal_wifi_certificate",
"terminal_wifi_private_key"
],
"type": "string",
"description": "The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file.",
"x-stripeBypassValidation": true
},
"filename": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The suitable name for saving the file to a filesystem."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The file expires and isn't available at this time in epoch seconds."
}
},
"description": "This object represents files hosted on Stripe's servers. You can upload\nfiles with the [create file](https://api.stripe.com#create_file) request\n(for example, when uploading dispute evidence). Stripe also\ncreates files independently (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://docs.stripe.com/file-upload)",
"x-resourceId": "file",
"x-expandableFields": [
"links"
]
}
file_link
{
"type": "object",
"title": "FileLink",
"required": [
"created",
"expired",
"file",
"id",
"livemode",
"metadata",
"object"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The publicly accessible URL to download the file."
},
"file": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "The file object this link points to.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"object": {
"enum": [
"file_link"
],
"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."
},
"expired": {
"type": "boolean",
"description": "Returns if the link is already expired."
},
"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
}
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Time that the link expires."
}
},
"description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that you can use to\nretrieve the contents of the file without authentication.",
"x-resourceId": "file_link",
"x-expandableFields": [
"file"
]
}
financial_connections.account
{
"type": "object",
"title": "BankConnectionsResourceLinkedAccount",
"required": [
"category",
"created",
"id",
"institution_name",
"livemode",
"object",
"status",
"subcategory",
"supported_payment_method_types"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last 4 digits of the account number. If present, this will be 4 numeric characters."
},
"object": {
"enum": [
"financial_connections.account"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"active",
"disconnected",
"inactive"
],
"type": "string",
"description": "The status of the link to the account."
},
"balance": {
"anyOf": [
{
"$ref": "#/components/schemas/bank_connections_resource_balance"
}
],
"nullable": true,
"description": "The most recent information about the account's balance."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"category": {
"enum": [
"cash",
"credit",
"investment",
"other"
],
"type": "string",
"description": "The type of the account. Account category is further divided in `subcategory`."
},
"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`."
},
"ownership": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/financial_connections.account_ownership"
}
],
"nullable": true,
"description": "The most recent information about the account's owners.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/financial_connections.account_ownership"
}
]
}
},
"permissions": {
"type": "array",
"items": {
"enum": [
"balances",
"ownership",
"payment_method",
"transactions"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "The list of permissions granted by this account."
},
"subcategory": {
"enum": [
"checking",
"credit_card",
"line_of_credit",
"mortgage",
"other",
"savings"
],
"type": "string",
"description": "If `category` is `cash`, one of:\n\n - `checking`\n - `savings`\n - `other`\n\nIf `category` is `credit`, one of:\n\n - `mortgage`\n - `line_of_credit`\n - `credit_card`\n - `other`\n\nIf `category` is `investment` or `other`, this will be `other`."
},
"display_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable name that has been assigned to this account, either by the account holder or by the institution."
},
"subscriptions": {
"type": "array",
"items": {
"enum": [
"transactions"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "The list of data refresh subscriptions requested on this account."
},
"account_holder": {
"anyOf": [
{
"$ref": "#/components/schemas/bank_connections_resource_accountholder"
}
],
"nullable": true,
"description": "The account holder that this account belongs to."
},
"account_numbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/bank_connections_resource_account_number_details"
},
"nullable": true,
"description": "Details about the account numbers."
},
"balance_refresh": {
"anyOf": [
{
"$ref": "#/components/schemas/bank_connections_resource_balance_refresh"
}
],
"nullable": true,
"description": "The state of the most recent attempt to refresh the account balance."
},
"institution_name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the institution that holds this account."
},
"ownership_refresh": {
"anyOf": [
{
"$ref": "#/components/schemas/bank_connections_resource_ownership_refresh"
}
],
"nullable": true,
"description": "The state of the most recent attempt to refresh the account owners."
},
"transaction_refresh": {
"anyOf": [
{
"$ref": "#/components/schemas/bank_connections_resource_transaction_refresh"
}
],
"nullable": true,
"description": "The state of the most recent attempt to refresh the account transactions."
},
"supported_payment_method_types": {
"type": "array",
"items": {
"enum": [
"link",
"us_bank_account"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account."
}
},
"description": "A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.",
"x-resourceId": "financial_connections.account",
"x-expandableFields": [
"account_holder",
"account_numbers",
"balance",
"balance_refresh",
"ownership",
"ownership_refresh",
"transaction_refresh"
]
}
financial_connections.account_owner
{
"type": "object",
"title": "BankConnectionsResourceOwner",
"required": [
"id",
"name",
"object",
"ownership"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "The full name of the owner."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The email address of the owner."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The raw phone number of the owner."
},
"object": {
"enum": [
"financial_connections.account_owner"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"ownership": {
"type": "string",
"maxLength": 5000,
"description": "The ownership object that this owner belongs to."
},
"raw_address": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The raw physical address of the owner."
},
"refreshed_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The timestamp of the refresh that updated this owner."
}
},
"description": "Describes an owner of an account.",
"x-resourceId": "financial_connections.account_owner",
"x-expandableFields": []
}
financial_connections.account_ownership
{
"type": "object",
"title": "BankConnectionsResourceOwnership",
"required": [
"created",
"id",
"object",
"owners"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"financial_connections.account_ownership"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"owners": {
"type": "object",
"title": "BankConnectionsResourceOwnerList",
"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/financial_connections.account_owner"
},
"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 paginated list of owners for this account.",
"x-expandableFields": [
"data"
]
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
}
},
"description": "Describes a snapshot of the owners of an account at a particular point in time.",
"x-expandableFields": [
"owners"
]
}
financial_connections.session
{
"type": "object",
"title": "BankConnectionsResourceLinkAccountSession",
"required": [
"accounts",
"id",
"livemode",
"object",
"permissions"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"object": {
"enum": [
"financial_connections.session"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"filters": {
"$ref": "#/components/schemas/bank_connections_resource_link_account_session_filters"
},
"accounts": {
"type": "object",
"title": "BankConnectionsResourceLinkedAccountList",
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"pattern": "^/v1/financial_connections/accounts",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/financial_connections.account"
},
"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": "The accounts that were collected as part of this Session.",
"x-expandableFields": [
"data"
]
},
"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`."
},
"prefetch": {
"type": "array",
"items": {
"enum": [
"balances",
"ownership",
"transactions"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "Data features requested to be retrieved upon account creation."
},
"return_url": {
"type": "string",
"maxLength": 5000,
"description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app."
},
"permissions": {
"type": "array",
"items": {
"enum": [
"balances",
"ownership",
"payment_method",
"transactions"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "Permissions requested for accounts collected during this session."
},
"client_secret": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A value that will be passed to the client to launch the authentication flow."
},
"account_holder": {
"anyOf": [
{
"$ref": "#/components/schemas/bank_connections_resource_accountholder"
}
],
"nullable": true,
"description": "The account holder for whom accounts are collected in this session."
}
},
"description": "A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.",
"x-resourceId": "financial_connections.session",
"x-expandableFields": [
"account_holder",
"accounts",
"filters"
]
}
financial_connections.transaction
{
"type": "object",
"title": "BankConnectionsResourceTransaction",
"required": [
"account",
"amount",
"currency",
"description",
"id",
"livemode",
"object",
"status",
"status_transitions",
"transacted_at",
"transaction_refresh",
"updated"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"type": "integer",
"description": "The amount of this transaction, in cents (or local equivalent)."
},
"object": {
"enum": [
"financial_connections.transaction"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"pending",
"posted",
"void"
],
"type": "string",
"description": "The status of the transaction."
},
"account": {
"type": "string",
"maxLength": 5000,
"description": "The ID of the Financial Connections Account this transaction belongs to."
},
"updated": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was last updated. 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`."
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "The description of this transaction."
},
"transacted_at": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the transaction was transacted. Measured in seconds since the Unix epoch."
},
"status_transitions": {
"$ref": "#/components/schemas/bank_connections_resource_transaction_resource_status_transitions"
},
"transaction_refresh": {
"type": "string",
"maxLength": 5000,
"description": "The token of the transaction refresh that last updated or created this transaction."
}
},
"description": "A Transaction represents a real transaction that affects a Financial Connections Account balance.",
"x-resourceId": "financial_connections.transaction",
"x-expandableFields": [
"status_transitions"
]
}
financial_reporting_finance_report_run_run_parameters
{
"type": "object",
"title": "FinancialReportingFinanceReportRunRunParameters",
"properties": {
"payout": {
"type": "string",
"maxLength": 5000,
"description": "Payout ID by which to filter the report run."
},
"columns": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "The set of output columns requested for inclusion in the report run."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Currency of objects to be included in the report run."
},
"timezone": {
"type": "string",
"maxLength": 5000,
"description": "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`."
},
"interval_end": {
"type": "integer",
"format": "unix-time",
"description": "Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value."
},
"interval_start": {
"type": "integer",
"format": "unix-time",
"description": "Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value."
},
"connected_account": {
"type": "string",
"maxLength": 5000,
"description": "Connected account ID by which to filter the report run."
},
"reporting_category": {
"type": "string",
"maxLength": 5000,
"description": "Category of balance transactions to be included in the report run."
}
},
"description": "",
"x-expandableFields": []
}
forwarded_request_context
{
"type": "object",
"title": "ForwardedRequestContext",
"required": [
"destination_duration",
"destination_ip_address"
],
"properties": {
"destination_duration": {
"type": "integer",
"description": "The time it took in milliseconds for the destination endpoint to respond."
},
"destination_ip_address": {
"type": "string",
"maxLength": 5000,
"description": "The IP address of the destination."
}
},
"description": "Metadata about the forwarded request.",
"x-expandableFields": []
}
forwarded_request_details
{
"type": "object",
"title": "ForwardedRequestDetails",
"required": [
"body",
"headers",
"http_method"
],
"properties": {
"body": {
"type": "string",
"maxLength": 5000,
"description": "The body payload to send to the destination endpoint."
},
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/forwarded_request_header"
},
"description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included."
},
"http_method": {
"enum": [
"POST"
],
"type": "string",
"description": "The HTTP method used to call the destination endpoint."
}
},
"description": "Details about the request forwarded to the destination endpoint.",
"x-expandableFields": [
"headers"
]
}
forwarded_request_header
{
"type": "object",
"title": "ForwardedRequestHeader",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"maxLength": 5000,
"description": "The header name."
},
"value": {
"type": "string",
"maxLength": 5000,
"description": "The header value."
}
},
"description": "Header data.",
"x-expandableFields": []
}
forwarded_response_details
{
"type": "object",
"title": "ForwardedResponseDetails",
"required": [
"body",
"headers",
"status"
],
"properties": {
"body": {
"type": "string",
"maxLength": 5000,
"description": "The response body from the destination endpoint to Stripe."
},
"status": {
"type": "integer",
"description": "The HTTP status code that the destination endpoint returned."
},
"headers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/forwarded_request_header"
},
"description": "HTTP headers that the destination endpoint returned."
}
},
"description": "Details about the response from the destination endpoint.",
"x-expandableFields": [
"headers"
]
}
forwarding.request
{
"type": "object",
"title": "ForwardingRequest",
"required": [
"created",
"id",
"livemode",
"object",
"payment_method",
"replacements"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The destination URL for the forwarded request. Must be supported by the config."
},
"object": {
"enum": [
"forwarding.request"
],
"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`."
},
"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
}
},
"replacements": {
"type": "array",
"items": {
"enum": [
"card_cvc",
"card_expiry",
"card_number",
"cardholder_name",
"request_signature"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "The field kinds to be replaced in the forwarded request."
},
"payment_method": {
"type": "string",
"maxLength": 5000,
"description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed."
},
"request_context": {
"anyOf": [
{
"$ref": "#/components/schemas/forwarded_request_context"
}
],
"nullable": true,
"description": "Context about the request from Stripe's servers to the destination endpoint."
},
"request_details": {
"anyOf": [
{
"$ref": "#/components/schemas/forwarded_request_details"
}
],
"nullable": true,
"description": "The request that was sent to the destination endpoint. We redact any sensitive fields."
},
"response_details": {
"anyOf": [
{
"$ref": "#/components/schemas/forwarded_response_details"
}
],
"nullable": true,
"description": "The response that the destination endpoint returned to us. We redact any sensitive fields."
}
},
"description": "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).",
"x-resourceId": "forwarding.request",
"x-expandableFields": [
"request_context",
"request_details",
"response_details"
]
}
funding_instructions
{
"type": "object",
"title": "CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions",
"required": [
"bank_transfer",
"currency",
"funding_type",
"livemode",
"object"
],
"properties": {
"object": {
"enum": [
"funding_instructions"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"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`."
},
"funding_type": {
"enum": [
"bank_transfer"
],
"type": "string",
"description": "The `funding_type` of the returned instructions"
},
"bank_transfer": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer"
}
},
"description": "Each customer has a [`balance`](https://docs.stripe.com/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://docs.stripe.com/payments/customer-balance/funding-instructions)",
"x-resourceId": "funding_instructions",
"x-expandableFields": [
"bank_transfer"
]
}
funding_instructions_bank_transfer
{
"type": "object",
"title": "FundingInstructionsBankTransfer",
"required": [
"country",
"financial_addresses",
"type"
],
"properties": {
"type": {
"enum": [
"eu_bank_transfer",
"jp_bank_transfer"
],
"type": "string",
"description": "The bank_transfer type",
"x-stripeBypassValidation": true
},
"country": {
"type": "string",
"maxLength": 5000,
"description": "The country of the bank account to fund"
},
"financial_addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address"
},
"description": "A list of financial addresses that can be used to fund a particular balance"
}
},
"description": "",
"x-expandableFields": [
"financial_addresses"
]
}
funding_instructions_bank_transfer_aba_record
{
"type": "object",
"title": "FundingInstructionsBankTransferABARecord",
"required": [
"account_holder_address",
"account_holder_name",
"account_number",
"account_type",
"bank_address",
"bank_name",
"routing_number"
],
"properties": {
"bank_name": {
"type": "string",
"maxLength": 5000,
"description": "The bank name"
},
"account_type": {
"type": "string",
"maxLength": 5000,
"description": "The account type"
},
"bank_address": {
"$ref": "#/components/schemas/address"
},
"account_number": {
"type": "string",
"maxLength": 5000,
"description": "The ABA account number"
},
"routing_number": {
"type": "string",
"maxLength": 5000,
"description": "The ABA routing number"
},
"account_holder_name": {
"type": "string",
"maxLength": 5000,
"description": "The account holder name"
},
"account_holder_address": {
"$ref": "#/components/schemas/address"
}
},
"description": "ABA Records contain U.S. bank account details per the ABA format.",
"x-expandableFields": [
"account_holder_address",
"bank_address"
]
}
funding_instructions_bank_transfer_financial_address
{
"type": "object",
"title": "FundingInstructionsBankTransferFinancialAddress",
"required": [
"type"
],
"properties": {
"aba": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_aba_record"
},
"iban": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_iban_record"
},
"spei": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_spei_record"
},
"type": {
"enum": [
"aba",
"iban",
"sort_code",
"spei",
"swift",
"zengin"
],
"type": "string",
"description": "The type of financial address",
"x-stripeBypassValidation": true
},
"swift": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_swift_record"
},
"zengin": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_zengin_record"
},
"sort_code": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_sort_code_record"
},
"supported_networks": {
"type": "array",
"items": {
"enum": [
"ach",
"bacs",
"domestic_wire_us",
"fps",
"sepa",
"spei",
"swift",
"zengin"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "The payment networks supported by this FinancialAddress"
}
},
"description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.",
"x-expandableFields": [
"aba",
"iban",
"sort_code",
"spei",
"swift",
"zengin"
]
}
funding_instructions_bank_transfer_iban_record
{
"type": "object",
"title": "FundingInstructionsBankTransferIbanRecord",
"required": [
"account_holder_address",
"account_holder_name",
"bank_address",
"bic",
"country",
"iban"
],
"properties": {
"bic": {
"type": "string",
"maxLength": 5000,
"description": "The BIC/SWIFT code of the account."
},
"iban": {
"type": "string",
"maxLength": 5000,
"description": "The IBAN of the account."
},
"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))."
},
"bank_address": {
"$ref": "#/components/schemas/address"
},
"account_holder_name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the person or business that owns the bank account"
},
"account_holder_address": {
"$ref": "#/components/schemas/address"
}
},
"description": "Iban Records contain E.U. bank account details per the SEPA format.",
"x-expandableFields": [
"account_holder_address",
"bank_address"
]
}
funding_instructions_bank_transfer_sort_code_record
{
"type": "object",
"title": "FundingInstructionsBankTransferSortCodeRecord",
"required": [
"account_holder_address",
"account_holder_name",
"account_number",
"bank_address",
"sort_code"
],
"properties": {
"sort_code": {
"type": "string",
"maxLength": 5000,
"description": "The six-digit sort code"
},
"bank_address": {
"$ref": "#/components/schemas/address"
},
"account_number": {
"type": "string",
"maxLength": 5000,
"description": "The account number"
},
"account_holder_name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the person or business that owns the bank account"
},
"account_holder_address": {
"$ref": "#/components/schemas/address"
}
},
"description": "Sort Code Records contain U.K. bank account details per the sort code format.",
"x-expandableFields": [
"account_holder_address",
"bank_address"
]
}
funding_instructions_bank_transfer_spei_record
{
"type": "object",
"title": "FundingInstructionsBankTransferSpeiRecord",
"required": [
"account_holder_address",
"account_holder_name",
"bank_address",
"bank_code",
"bank_name",
"clabe"
],
"properties": {
"clabe": {
"type": "string",
"maxLength": 5000,
"description": "The CLABE number"
},
"bank_code": {
"type": "string",
"maxLength": 5000,
"description": "The three-digit bank code"
},
"bank_name": {
"type": "string",
"maxLength": 5000,
"description": "The short banking institution name"
},
"bank_address": {
"$ref": "#/components/schemas/address"
},
"account_holder_name": {
"type": "string",
"maxLength": 5000,
"description": "The account holder name"
},
"account_holder_address": {
"$ref": "#/components/schemas/address"
}
},
"description": "SPEI Records contain Mexico bank account details per the SPEI format.",
"x-expandableFields": [
"account_holder_address",
"bank_address"
]
}
funding_instructions_bank_transfer_swift_record
{
"type": "object",
"title": "FundingInstructionsBankTransferSwiftRecord",
"required": [
"account_holder_address",
"account_holder_name",
"account_number",
"account_type",
"bank_address",
"bank_name",
"swift_code"
],
"properties": {
"bank_name": {
"type": "string",
"maxLength": 5000,
"description": "The bank name"
},
"swift_code": {
"type": "string",
"maxLength": 5000,
"description": "The SWIFT code"
},
"account_type": {
"type": "string",
"maxLength": 5000,
"description": "The account type"
},
"bank_address": {
"$ref": "#/components/schemas/address"
},
"account_number": {
"type": "string",
"maxLength": 5000,
"description": "The account number"
},
"account_holder_name": {
"type": "string",
"maxLength": 5000,
"description": "The account holder name"
},
"account_holder_address": {
"$ref": "#/components/schemas/address"
}
},
"description": "SWIFT Records contain U.S. bank account details per the SWIFT format.",
"x-expandableFields": [
"account_holder_address",
"bank_address"
]
}
funding_instructions_bank_transfer_zengin_record
{
"type": "object",
"title": "FundingInstructionsBankTransferZenginRecord",
"required": [
"account_holder_address",
"bank_address"
],
"properties": {
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The bank code of the account"
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The bank name of the account"
},
"branch_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The branch code of the account"
},
"branch_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The branch name of the account"
},
"account_type": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The bank account type. In Japan, this can only be `futsu` or `toza`."
},
"bank_address": {
"$ref": "#/components/schemas/address"
},
"account_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The account number"
},
"account_holder_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The account holder name"
},
"account_holder_address": {
"$ref": "#/components/schemas/address"
}
},
"description": "Zengin Records contain Japan bank account details per the Zengin format.",
"x-expandableFields": [
"account_holder_address",
"bank_address"
]
}
gelato_data_document_report_date_of_birth
{
"type": "object",
"title": "GelatoDataDocumentReportDateOfBirth",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "Numerical day between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year."
},
"month": {
"type": "integer",
"nullable": true,
"description": "Numerical month between 1 and 12."
}
},
"description": "Point in Time",
"x-expandableFields": []
}
gelato_data_document_report_expiration_date
{
"type": "object",
"title": "GelatoDataDocumentReportExpirationDate",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "Numerical day between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year."
},
"month": {
"type": "integer",
"nullable": true,
"description": "Numerical month between 1 and 12."
}
},
"description": "Point in Time",
"x-expandableFields": []
}
gelato_data_document_report_issued_date
{
"type": "object",
"title": "GelatoDataDocumentReportIssuedDate",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "Numerical day between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year."
},
"month": {
"type": "integer",
"nullable": true,
"description": "Numerical month between 1 and 12."
}
},
"description": "Point in Time",
"x-expandableFields": []
}
gelato_data_id_number_report_date
{
"type": "object",
"title": "GelatoDataIdNumberReportDate",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "Numerical day between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year."
},
"month": {
"type": "integer",
"nullable": true,
"description": "Numerical month between 1 and 12."
}
},
"description": "Point in Time",
"x-expandableFields": []
}
gelato_data_verified_outputs_date
{
"type": "object",
"title": "GelatoDataVerifiedOutputsDate",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "Numerical day between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year."
},
"month": {
"type": "integer",
"nullable": true,
"description": "Numerical month between 1 and 12."
}
},
"description": "Point in Time",
"x-expandableFields": []
}
gelato_document_report
{
"type": "object",
"title": "GelatoDocumentReport",
"required": [
"status"
],
"properties": {
"dob": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_data_document_report_date_of_birth"
}
],
"nullable": true,
"description": "Date of birth as it appears in the document."
},
"sex": {
"enum": [
"[redacted]",
"female",
"male",
"unknown"
],
"type": "string",
"nullable": true,
"description": "Sex of the person in the document."
},
"type": {
"enum": [
"driving_license",
"id_card",
"passport"
],
"type": "string",
"nullable": true,
"description": "Type of the document."
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_document_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"files": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "Array of [File](https://docs.stripe.com/api/files) ids containing images for this document."
},
"number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Document ID number."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `document` check.",
"x-stripeBypassValidation": true
},
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "Address as it appears in the document."
},
"last_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last name as it appears in the document."
},
"first_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "First name as it appears in the document."
},
"issued_date": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_data_document_report_issued_date"
}
],
"nullable": true,
"description": "Issued date of the document."
},
"unparsed_sex": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Sex as it appears in the document."
},
"expiration_date": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_data_document_report_expiration_date"
}
],
"nullable": true,
"description": "Expiration date of the document."
},
"issuing_country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Issuing country of the document."
},
"unparsed_place_of_birth": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Place of birth as it appears in the document."
}
},
"description": "Result from a document check",
"x-expandableFields": [
"address",
"dob",
"error",
"expiration_date",
"issued_date"
]
}
gelato_document_report_error
{
"type": "object",
"title": "GelatoDocumentReportError",
"properties": {
"code": {
"enum": [
"document_expired",
"document_type_not_supported",
"document_unverified_other"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure.",
"x-stripeBypassValidation": true
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_email_report
{
"type": "object",
"title": "GelatoEmailReport",
"required": [
"status"
],
"properties": {
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Email to be verified."
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_email_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `email` check.",
"x-stripeBypassValidation": true
}
},
"description": "Result from a email check",
"x-expandableFields": [
"error"
]
}
gelato_email_report_error
{
"type": "object",
"title": "GelatoEmailReportError",
"properties": {
"code": {
"enum": [
"email_unverified_other",
"email_verification_declined"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure."
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_id_number_report
{
"type": "object",
"title": "GelatoIdNumberReport",
"required": [
"status"
],
"properties": {
"dob": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_data_id_number_report_date"
}
],
"nullable": true,
"description": "Date of birth."
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_id_number_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `id_number` check.",
"x-stripeBypassValidation": true
},
"id_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present."
},
"last_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last name."
},
"first_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "First name."
},
"id_number_type": {
"enum": [
"br_cpf",
"sg_nric",
"us_ssn"
],
"type": "string",
"nullable": true,
"description": "Type of ID number."
}
},
"description": "Result from an id_number check",
"x-expandableFields": [
"dob",
"error"
]
}
gelato_id_number_report_error
{
"type": "object",
"title": "GelatoIdNumberReportError",
"properties": {
"code": {
"enum": [
"id_number_insufficient_document_data",
"id_number_mismatch",
"id_number_unverified_other"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure."
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_phone_report
{
"type": "object",
"title": "GelatoPhoneReport",
"required": [
"status"
],
"properties": {
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/gelato_phone_report_error"
}
],
"nullable": true,
"description": "Details on the verification error. Present when status is `unverified`."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Phone to be verified."
},
"status": {
"enum": [
"unverified",
"verified"
],
"type": "string",
"description": "Status of this `phone` check.",
"x-stripeBypassValidation": true
}
},
"description": "Result from a phone check",
"x-expandableFields": [
"error"
]
}
gelato_phone_report_error
{
"type": "object",
"title": "GelatoPhoneReportError",
"properties": {
"code": {
"enum": [
"phone_unverified_other",
"phone_verification_declined"
],
"type": "string",
"nullable": true,
"description": "A short machine-readable string giving the reason for the verification failure."
},
"reason": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
}
},
"description": "",
"x-expandableFields": []
}
gelato_provided_details
{
"type": "object",
"title": "GelatoProvidedDetails",
"properties": {
"email": {
"type": "string",
"maxLength": 5000,
"description": "Email of user being verified"
},
"phone": {
"type": "string",
"maxLength": 5000,
"description": "Phone number of user being verified"
}
},
"description": "",
"x-expandableFields": []
}
gelato_related_person
{
"type": "object",
"title": "GelatoRelatedPerson",
"required": [
"account",
"person"
],
"properties": {
"person": {
"type": "string",
"maxLength": 5000,
"description": "Token referencing the related Person resource."
},
"account": {
"type": "string",
"maxLength": 5000,
"description": "Token referencing the associated Account of the related Person resource."
}
},
"description": "",
"x-expandableFields": []
}
gelato_report_document_options
{
"type": "object",
"title": "GelatoReportDocumentOptions",
"properties": {
"allowed_types": {
"type": "array",
"items": {
"enum": [
"driving_license",
"id_card",
"passport"
],
"type": "string"
},
"description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code."
},
"require_id_number": {
"type": "boolean",
"description": "Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."
},
"require_live_capture": {
"type": "boolean",
"description": "Disable image uploads, identity document images have to be captured using the device’s camera."
},
"require_matching_selfie": {
"type": "boolean",
"description": "Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie)."
}
},
"description": "",
"x-expandableFields": []
}