openapi: 3.0.0
info:
title: Stripe Accounts Account Verify API
description: This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
contact:
email: dev-platform@stripe.com
name: Stripe Dev Platform Team
url: https://stripe.com
termsOfService: https://stripe.com/us/terms/
version: '2023-10-16'
x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Verify
paths:
/v1/customers/{customer}/bank_accounts/{id}/verify:
post:
description: <p>Verify a specified bank account for a given customer.</p>
operationId: postCustomersCustomerBankAccountsIdVerify
parameters:
- in: path
name: customer
required: true
schema:
maxLength: 5000
type: string
style: simple
- in: path
name: id
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
amounts:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostCustomersCustomerBankAccountsIdVerifyRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/bank_account'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Customers Customer Bank Accounts Id Verify
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
ChooseTags: true
tags:
- Verify
/v1/customers/{customer}/sources/{id}/verify:
post:
description: <p>Verify a specified bank account for a given customer.</p>
operationId: postCustomersCustomerSourcesIdVerify
parameters:
- in: path
name: customer
required: true
schema:
maxLength: 5000
type: string
style: simple
- in: path
name: id
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
amounts:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostCustomersCustomerSourcesIdVerifyRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/bank_account'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Customers Customer Sources Id Verify
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
ChooseTags: true
tags:
- Verify
/v1/payment_intents/{intent}/verify_microdeposits:
post:
description: <p>Verifies microdeposits on a PaymentIntent object.</p>
operationId: postPaymentIntentsIntentVerifyMicrodeposits
parameters:
- in: path
name: intent
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
amounts:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
$ref: '#/components/schemas/PostPaymentIntentsIntentVerifyMicrodepositsRequest'
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/payment_intent'
description: Successful response.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
description: Error response.
summary: Stripe Post Payment Intents Verify Microdeposits
x-api-evangelist-processing:
GenerateOperationSummariesFromPath: true
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
ChooseTags: true
tags:
- Verify
components:
schemas:
subscription:
description: 'Subscriptions allow you to charge a customer on a recurring basis.
Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)'
properties:
application:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/application'
- $ref: '#/components/schemas/deleted_application'
description: ID of the Connect Application that created the subscription.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/application'
- $ref: '#/components/schemas/deleted_application'
application_fee_percent:
description: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
nullable: true
type: number
automatic_tax:
$ref: '#/components/schemas/subscription_automatic_tax'
billing_cycle_anchor:
description: Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
format: unix-time
type: integer
billing_thresholds:
anyOf:
- $ref: '#/components/schemas/subscription_billing_thresholds'
description: Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
nullable: true
cancel_at:
description: A date in the future at which the subscription will automatically get canceled
format: unix-time
nullable: true
type: integer
cancel_at_period_end:
description: If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
type: boolean
canceled_at:
description: If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
format: unix-time
nullable: true
type: integer
cancellation_details:
anyOf:
- $ref: '#/components/schemas/cancellation_details'
description: Details about why this subscription was cancelled
nullable: true
collection_method:
description: Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
enum:
- charge_automatically
- send_invoice
type: string
created:
description: Time at which the object was created. Measured in seconds since the Unix epoch.
format: unix-time
type: integer
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).
type: string
current_period_end:
description: End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
format: unix-time
type: integer
current_period_start:
description: Start of the current period that the subscription has been invoiced for.
format: unix-time
type: integer
customer:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/customer'
- $ref: '#/components/schemas/deleted_customer'
description: ID of the customer who owns the subscription.
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/customer'
- $ref: '#/components/schemas/deleted_customer'
days_until_due:
description: Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
nullable: true
type: integer
default_payment_method:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/payment_method'
description: ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/payment_method'
default_source:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/bank_account'
- $ref: '#/components/schemas/card'
- $ref: '#/components/schemas/source'
description: ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/bank_account'
- $ref: '#/components/schemas/card'
- $ref: '#/components/schemas/source'
x-stripeBypassValidation: true
default_tax_rates:
description: The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
items:
$ref: '#/components/schemas/tax_rate'
nullable: true
type: array
description:
description: The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
maxLength: 500
nullable: true
type: string
discount:
anyOf:
- $ref: '#/components/schemas/discount'
description: Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
nullable: true
ended_at:
description: If the subscription has ended, the date the subscription ended.
format: unix-time
nullable: true
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
items:
description: List of subscription items, each with an attached price.
properties:
data:
description: Details about each object.
items:
$ref: '#/components/schemas/subscription_item'
type: array
has_more:
description: True if this list has another page of items after this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: SubscriptionItemList
type: object
x-expandableFields:
- data
latest_invoice:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/invoice'
description: The most recent invoice this subscription has generated.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/invoice'
livemode:
description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
type: object
next_pending_invoice_item_invoice:
description: Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
format: unix-time
nullable: true
type: integer
object:
description: String representing the object's type. Objects of the same type share the same value.
enum:
- subscription
type: string
on_behalf_of:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/account'
description: The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/account'
pause_collection:
anyOf:
- $ref: '#/components/schemas/subscriptions_resource_pause_collection'
description: If specified, payment collection for this subscription will be paused.
nullable: true
payment_settings:
anyOf:
- $ref: '#/components/schemas/subscriptions_resource_payment_settings'
description: Payment settings passed on to invoices created by the subscription.
nullable: true
pending_invoice_item_interval:
anyOf:
- $ref: '#/components/schemas/subscription_pending_invoice_item_interval'
description: Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
nullable: true
pending_setup_intent:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/setup_intent'
description: You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/setup_intent'
pending_update:
anyOf:
- $ref: '#/components/schemas/subscriptions_resource_pending_update'
description: If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
nullable: true
schedule:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/subscription_schedule'
description: The schedule attached to the subscription
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/subscription_schedule'
start_date:
description: Date when the subscription was first created. The date might differ from the `created` date due to backdating.
format: unix-time
type: integer
status:
description: "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices."
enum:
- active
- canceled
- incomplete
- incomplete_expired
- past_due
- paused
- trialing
- unpaid
type: string
test_clock:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/test_helpers.test_clock'
description: ID of the test clock this subscription belongs to.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/test_helpers.test_clock'
transfer_data:
anyOf:
- $ref: '#/components/schemas/subscription_transfer_data'
description: The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
nullable: true
trial_end:
description: If the subscription has a trial, the end of that trial.
format: unix-time
nullable: true
type: integer
trial_settings:
anyOf:
- $ref: '#/components/schemas/subscriptions_trials_resource_trial_settings'
description: Settings related to subscription trials.
nullable: true
trial_start:
description: If the subscription has a trial, the beginning of that trial.
format: unix-time
nullable: true
type: integer
required:
- automatic_tax
- billing_cycle_anchor
- cancel_at_period_end
- collection_method
- created
- currency
- current_period_end
- current_period_start
- customer
- id
- items
- livemode
- metadata
- object
- start_date
- status
title: Subscription
type: object
x-expandableFields:
- application
- automatic_tax
- billing_thresholds
- cancellation_details
- customer
- default_payment_method
- default_source
- default_tax_rates
- discount
- items
- latest_invoice
- on_behalf_of
- pause_collection
- payment_settings
- pending_invoice_item_interval
- pending_setup_intent
- pending_update
- schedule
- test_clock
- transfer_data
- trial_settings
x-resourceId: subscription
bank_account:
description: 'These bank accounts are payment methods on `Customer` objects.
On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer
destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).
They can be bank accounts or debit cards as well, and are documented in the links above.
Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)'
properties:
account:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/account'
description: The ID of the account that the bank account is associated with.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/account'
account_holder_name:
description: The name of the person or business that owns the bank account.
maxLength: 5000
nullable: true
type: string
account_holder_type:
description: The type of entity that holds the account. This can be either `individual` or `company`.
maxLength: 5000
nullable: true
type: string
account_type:
description: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
maxLength: 5000
nullable: true
type: string
available_payout_methods:
description: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.
items:
enum:
- instant
- standard
type: string
nullable: true
type: array
bank_name:
description: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter ISO code representing the country the bank account is located in.
maxLength: 5000
type: string
currency:
description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/customer'
- $ref: '#/components/schemas/deleted_customer'
description: The ID of the customer that the bank account is associated with.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/customer'
- $ref: '#/components/schemas/deleted_customer'
default_for_currency:
description: Whether this bank account is the default external account for its currency.
nullable: true
type: boolean
fingerprint:
description: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
future_requirements:
anyOf:
- $ref: '#/components/schemas/external_account_requirements'
description: Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
nullable: true
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
last4:
description: The last four digits of the bank account number.
maxLength: 5000
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
nullable: true
type: object
object:
description: String representing the object's type. Objects of the same type share the same value.
enum:
- bank_account
type: string
requirements:
anyOf:
- $ref: '#/components/schemas/external_account_requirements'
description: Information about the requirements for the bank account, including what information needs to be collected.
nullable: true
routing_number:
description: The routing transit number for the bank account.
maxLength: 5000
nullable: true
type: string
status:
description: 'For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn''t had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we''ll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.
For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In India, if we can''t [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we''ll set the status to `verification_failed`. Other validations aren''t run against external accounts because they''re only used for payouts. This means the other statuses don''t apply.'
maxLength: 5000
type: string
required:
- country
- currency
- id
- last4
- object
- status
title: BankAccount
type: object
x-expandableFields:
- account
- customer
- future_requirements
- requirements
x-resourceId: bank_account
error:
description: An error response from the Stripe API
properties:
error:
$ref: '#/components/schemas/api_errors'
required:
- error
type: object
discount:
description: 'A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
It contains information about when the discount began, when it will end, and what it is applied to.
Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)'
properties:
checkout_session:
description: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
maxLength: 5000
nullable: true
type: string
coupon:
$ref: '#/components/schemas/coupon'
customer:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/customer'
- $ref: '#/components/schemas/deleted_customer'
description: The ID of the customer associated with this discount.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/customer'
- $ref: '#/components/schemas/deleted_customer'
end:
description: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.
format: unix-time
nullable: true
type: integer
id:
description: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.
maxLength: 5000
type: string
invoice:
description: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
maxLength: 5000
nullable: true
type: string
invoice_item:
description: The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
maxLength: 5000
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same type share the same value.
enum:
- discount
type: string
promotion_code:
anyOf:
- maxLength: 5000
type: string
- $ref: '#/components/schemas/promotion_code'
description: The promotion code applied to create this discount.
nullable: true
x-expansionResources:
oneOf:
- $ref: '#/components/schemas/promotion_code'
start:
description: Date that the coupon was applied.
format: unix-time
type: integer
subscription:
description: The subscription that this coupon is applied to, if it is applied to a particular subscription.
maxLength: 5000
nullable: true
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-verify-api-openapi.yml