object mandate
{
  "type": "object",
  "title": "Mandate",
  "required": [
    "customer_acceptance",
    "id",
    "livemode",
    "object",
    "payment_method",
    "payment_method_details",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "multi_use",
        "single_use"
      ],
      "type": "string",
      "description": "The type of the mandate."
    },
    "object": {
      "enum": [
        "mandate"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The mandate status indicates whether or not you can use it to initiate a 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`."
    },
    "multi_use": {
      "$ref": "#/components/schemas/mandate_multi_use"
    },
    "single_use": {
      "$ref": "#/components/schemas/mandate_single_use"
    },
    "on_behalf_of": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account (if any) that the mandate is intended for."
    },
    "payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "description": "ID of the payment method associated with this mandate.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "customer_acceptance": {
      "$ref": "#/components/schemas/customer_acceptance"
    },
    "payment_method_details": {
      "$ref": "#/components/schemas/mandate_payment_method_details"
    }
  },
  "description": "A Mandate is a record of the permission that your customer gives you to debit their payment method.",
  "x-resourceId": "mandate",
  "x-expandableFields": [
    "customer_acceptance",
    "multi_use",
    "payment_method",
    "payment_method_details",
    "single_use"
  ]
}
object mandate_acss_debit
{
  "type": "object",
  "title": "mandate_acss_debit",
  "required": [
    "payment_schedule",
    "transaction_type"
  ],
  "properties": {
    "default_for": {
      "type": "array",
      "items": {
        "enum": [
          "invoice",
          "subscription"
        ],
        "type": "string"
      },
      "description": "List of Stripe products where this mandate can be selected automatically."
    },
    "payment_schedule": {
      "enum": [
        "combined",
        "interval",
        "sporadic"
      ],
      "type": "string",
      "description": "Payment schedule for the mandate."
    },
    "transaction_type": {
      "enum": [
        "business",
        "personal"
      ],
      "type": "string",
      "description": "Transaction type of the mandate."
    },
    "interval_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_amazon_pay
{
  "type": "object",
  "title": "mandate_amazon_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_au_becs_debit
{
  "type": "object",
  "title": "mandate_au_becs_debit",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_bacs_debit
{
  "type": "object",
  "title": "mandate_bacs_debit",
  "required": [
    "network_status",
    "reference",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL that will contain the mandate that the customer has signed."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "The unique reference identifying the mandate on the Bacs network."
    },
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The display name for the account on this mandate."
    },
    "network_status": {
      "enum": [
        "accepted",
        "pending",
        "refused",
        "revoked"
      ],
      "type": "string",
      "description": "The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`."
    },
    "revocation_reason": {
      "enum": [
        "account_closed",
        "bank_account_restricted",
        "bank_ownership_changed",
        "could_not_process",
        "debit_not_authorized"
      ],
      "type": "string",
      "nullable": true,
      "description": "When the mandate is revoked on the Bacs network this field displays the reason for the revocation."
    },
    "service_user_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The service user number for the account on this mandate."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_cashapp
{
  "type": "object",
  "title": "mandate_cashapp",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_kakao_pay
{
  "type": "object",
  "title": "mandate_kakao_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_klarna
{
  "type": "object",
  "title": "mandate_klarna",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_kr_card
{
  "type": "object",
  "title": "mandate_kr_card",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_link
{
  "type": "object",
  "title": "mandate_link",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_multi_use
{
  "type": "object",
  "title": "mandate_multi_use",
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount of the payment on a multi use mandate."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "The currency of the payment on a multi use mandate."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_naver_pay
{
  "type": "object",
  "title": "mandate_naver_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_nz_bank_account
{
  "type": "object",
  "title": "mandate_nz_bank_account",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_options_payto
{
  "type": "object",
  "title": "mandate_options_payto",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount that will be collected. It is required when `amount_type` is `fixed`."
    },
    "purpose": {
      "enum": [
        "dependant_support",
        "government",
        "loan",
        "mortgage",
        "other",
        "pension",
        "personal",
        "retail",
        "salary",
        "tax",
        "utility"
      ],
      "type": "string",
      "nullable": true,
      "description": "The purpose for which payments are made. Has a default value based on your merchant category code."
    },
    "end_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date."
    },
    "start_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`."
    },
    "payment_schedule": {
      "enum": [
        "adhoc",
        "annual",
        "daily",
        "fortnightly",
        "monthly",
        "quarterly",
        "semi_annual",
        "weekly"
      ],
      "type": "string",
      "nullable": true,
      "description": "The periodicity at which payments will be collected. Defaults to `adhoc`."
    },
    "payments_per_period": {
      "type": "integer",
      "nullable": true,
      "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_options_upi
{
  "type": "object",
  "title": "mandate_options_upi",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount to be charged for future payments."
    },
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "End date of the mandate or subscription."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "A description of the mandate or subscription that is meant to be displayed to the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_payment_method_details
{
  "type": "object",
  "title": "mandate_payment_method_details",
  "required": [
    "type"
  ],
  "properties": {
    "pix": {
      "$ref": "#/components/schemas/mandate_pix"
    },
    "upi": {
      "$ref": "#/components/schemas/mandate_upi"
    },
    "card": {
      "$ref": "#/components/schemas/card_mandate_payment_method_details"
    },
    "link": {
      "$ref": "#/components/schemas/mandate_link"
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method."
    },
    "payto": {
      "$ref": "#/components/schemas/mandate_payto"
    },
    "twint": {
      "$ref": "#/components/schemas/mandate_twint"
    },
    "klarna": {
      "$ref": "#/components/schemas/mandate_klarna"
    },
    "paypal": {
      "$ref": "#/components/schemas/mandate_paypal"
    },
    "cashapp": {
      "$ref": "#/components/schemas/mandate_cashapp"
    },
    "kr_card": {
      "$ref": "#/components/schemas/mandate_kr_card"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/mandate_kakao_pay"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/mandate_naver_pay"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/mandate_acss_debit"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/mandate_amazon_pay"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/mandate_bacs_debit"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/mandate_sepa_debit"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/mandate_revolut_pay"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/mandate_au_becs_debit"
    },
    "nz_bank_account": {
      "$ref": "#/components/schemas/mandate_nz_bank_account"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/mandate_us_bank_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "acss_debit",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "card",
    "cashapp",
    "kakao_pay",
    "klarna",
    "kr_card",
    "link",
    "naver_pay",
    "nz_bank_account",
    "paypal",
    "payto",
    "pix",
    "revolut_pay",
    "sepa_debit",
    "twint",
    "upi",
    "us_bank_account"
  ]
}
object mandate_paypal
{
  "type": "object",
  "title": "mandate_paypal",
  "properties": {
    "payer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer."
    },
    "billing_agreement_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_payto
{
  "type": "object",
  "title": "mandate_payto",
  "required": [
    "amount_type",
    "payment_schedule"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount that will be collected. It is required when `amount_type` is `fixed`."
    },
    "purpose": {
      "enum": [
        "dependant_support",
        "government",
        "loan",
        "mortgage",
        "other",
        "pension",
        "personal",
        "retail",
        "salary",
        "tax",
        "utility"
      ],
      "type": "string",
      "nullable": true,
      "description": "The purpose for which payments are made. Has a default value based on your merchant category code."
    },
    "end_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date."
    },
    "start_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`."
    },
    "payment_schedule": {
      "enum": [
        "adhoc",
        "annual",
        "daily",
        "fortnightly",
        "monthly",
        "quarterly",
        "semi_annual",
        "weekly"
      ],
      "type": "string",
      "description": "The periodicity at which payments will be collected. Defaults to `adhoc`."
    },
    "payments_per_period": {
      "type": "integer",
      "nullable": true,
      "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_pix
{
  "type": "object",
  "title": "mandate_pix",
  "properties": {
    "end_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "Subscription name displayed to buyers in their bank app."
    },
    "start_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Start date of the mandate, in `YYYY-MM-DD`."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "description": "Type of amount."
    },
    "payment_schedule": {
      "enum": [
        "halfyearly",
        "monthly",
        "quarterly",
        "weekly",
        "yearly"
      ],
      "type": "string",
      "description": "Schedule at which the future payments will be charged."
    },
    "amount_includes_iof": {
      "enum": [
        "always",
        "never"
      ],
      "type": "string",
      "description": "Determines if the amount includes the IOF tax."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_revolut_pay
{
  "type": "object",
  "title": "mandate_revolut_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_sepa_debit
{
  "type": "object",
  "title": "mandate_sepa_debit",
  "required": [
    "reference",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "The unique reference of the mandate."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_single_use
{
  "type": "object",
  "title": "mandate_single_use",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount of the payment on a single use mandate."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "The currency of the payment on a single use mandate."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_twint
{
  "type": "object",
  "title": "mandate_twint",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object mandate_upi
{
  "type": "object",
  "title": "mandate_upi",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount to be charged for future payments."
    },
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "End date of the mandate or subscription."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "A description of the mandate or subscription that is meant to be displayed to the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object mandate_us_bank_account
{
  "type": "object",
  "title": "mandate_us_bank_account",
  "properties": {
    "collection_method": {
      "enum": [
        "paper"
      ],
      "type": "string",
      "description": "Mandate collection method",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}
object networks
{
  "type": "object",
  "title": "networks",
  "required": [
    "available"
  ],
  "properties": {
    "available": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network)."
    },
    "preferred": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object notification_event_data
{
  "type": "object",
  "title": "NotificationEventData",
  "required": [
    "object"
  ],
  "properties": {
    "object": {
      "type": "object",
      "description": "Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://api.stripe.com#invoice_object) as the value of the object key."
    },
    "previous_attributes": {
      "type": "object",
      "description": "Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object notification_event_request
{
  "type": "object",
  "title": "NotificationEventRequest",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API."
    },
    "idempotency_key": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object offline_acceptance
{
  "type": "object",
  "title": "offline_acceptance",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}
object online_acceptance
{
  "type": "object",
  "title": "online_acceptance",
  "properties": {
    "ip_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer accepts the mandate from this IP address."
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer accepts the mandate using the user agent of the browser."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object outbound_payments_payment_method_details
{
  "type": "object",
  "title": "OutboundPaymentsPaymentMethodDetails",
  "required": [
    "billing_details",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "financial_account",
        "us_bank_account"
      ],
      "type": "string",
      "description": "The type of the payment method used in the OutboundPayment.",
      "x-stripeBypassValidation": true
    },
    "billing_details": {
      "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/outbound_payments_payment_method_details_us_bank_account"
    },
    "financial_account": {
      "$ref": "#/components/schemas/outbound_payments_payment_method_details_financial_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_details",
    "financial_account",
    "us_bank_account"
  ]
}
object outbound_payments_payment_method_details_financial_account
{
  "type": "object",
  "title": "outbound_payments_payment_method_details_financial_account",
  "required": [
    "id",
    "network"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Token of the FinancialAccount."
    },
    "network": {
      "enum": [
        "stripe"
      ],
      "type": "string",
      "description": "The rails used to send funds."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object outbound_payments_payment_method_details_us_bank_account
{
  "type": "object",
  "title": "outbound_payments_payment_method_details_us_bank_account",
  "required": [
    "network"
  ],
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "description": "ID of the mandate used to make this payment.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "network": {
      "enum": [
        "ach",
        "us_domestic_wire"
      ],
      "type": "string",
      "description": "The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "enum": [
        "checking",
        "savings"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account type: checkings or savings. Defaults to checking if omitted."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing number of the bank account."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account holder type: individual or company."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate"
  ]
}
object outbound_transfers_payment_method_details
{
  "type": "object",
  "title": "OutboundTransfersPaymentMethodDetails",
  "required": [
    "billing_details",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "financial_account",
        "us_bank_account"
      ],
      "type": "string",
      "description": "The type of the payment method used in the OutboundTransfer."
    },
    "billing_details": {
      "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/outbound_transfers_payment_method_details_us_bank_account"
    },
    "financial_account": {
      "$ref": "#/components/schemas/outbound_transfers_payment_method_details_financial_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_details",
    "financial_account",
    "us_bank_account"
  ]
}
object outbound_transfers_payment_method_details_financial_account
{
  "type": "object",
  "title": "outbound_transfers_payment_method_details_financial_account",
  "required": [
    "id",
    "network"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Token of the FinancialAccount."
    },
    "network": {
      "enum": [
        "stripe"
      ],
      "type": "string",
      "description": "The rails used to send funds."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object outbound_transfers_payment_method_details_us_bank_account
{
  "type": "object",
  "title": "outbound_transfers_payment_method_details_us_bank_account",
  "required": [
    "network"
  ],
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "description": "ID of the mandate used to make this payment.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "network": {
      "enum": [
        "ach",
        "us_domestic_wire"
      ],
      "type": "string",
      "description": "The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "enum": [
        "checking",
        "savings"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account type: checkings or savings. Defaults to checking if omitted."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing number of the bank account."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account holder type: individual or company."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate"
  ]
}
object package_dimensions
{
  "type": "object",
  "title": "PackageDimensions",
  "required": [
    "height",
    "length",
    "weight",
    "width"
  ],
  "properties": {
    "width": {
      "type": "number",
      "description": "Width, in inches."
    },
    "height": {
      "type": "number",
      "description": "Height, in inches."
    },
    "length": {
      "type": "number",
      "description": "Length, in inches."
    },
    "weight": {
      "type": "number",
      "description": "Weight, in ounces."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_attempt_record
{
  "type": "object",
  "title": "PaymentAttemptRecord",
  "required": [
    "amount",
    "amount_authorized",
    "amount_canceled",
    "amount_failed",
    "amount_guaranteed",
    "amount_refunded",
    "amount_requested",
    "created",
    "id",
    "livemode",
    "metadata",
    "object",
    "processor_details",
    "reported_by"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "object": {
      "enum": [
        "payment_attempt_record"
      ],
      "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",
      "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
      }
    },
    "application": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Connect application that created the PaymentAttemptRecord."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "reported_by": {
      "enum": [
        "self",
        "stripe"
      ],
      "type": "string",
      "description": "Indicates who reported the payment."
    },
    "amount_failed": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "payment_record": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Payment Record this Payment Attempt Record belongs to."
    },
    "amount_canceled": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_refunded": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_requested": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "customer_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_customer_details"
        }
      ],
      "nullable": true,
      "description": "Customer information for this payment."
    },
    "shipping_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_shipping_details"
        }
      ],
      "nullable": true,
      "description": "Shipping information for this payment."
    },
    "amount_authorized": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_guaranteed": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "customer_presence": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates whether the customer was present in your checkout flow during this payment."
    },
    "processor_details": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details"
    },
    "payment_method_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_details"
        }
      ],
      "nullable": true,
      "description": "Information about the Payment Method debited for this payment."
    }
  },
  "description": "A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe.\nEach payment attempt tries to collect a fixed amount of money from a fixed customer and payment\nmethod. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record\ncan have guaranteed funds.",
  "x-resourceId": "payment_attempt_record",
  "x-expandableFields": [
    "amount",
    "amount_authorized",
    "amount_canceled",
    "amount_failed",
    "amount_guaranteed",
    "amount_refunded",
    "amount_requested",
    "customer_details",
    "payment_method_details",
    "processor_details",
    "shipping_details"
  ]
}
object payment_data
{
  "type": "object",
  "title": "payment_data",
  "properties": {
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "An arbitrary string attached to the destination payment. Often useful for displaying to users."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_flows_amount_details
{
  "type": "object",
  "title": "PaymentFlowsAmountDetails",
  "properties": {
    "tax": {
      "$ref": "#/components/schemas/payment_flows_amount_details_resource_tax"
    },
    "tip": {
      "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip"
    },
    "error": {
      "$ref": "#/components/schemas/payment_flows_amount_details_resource_error"
    },
    "shipping": {
      "$ref": "#/components/schemas/payment_flows_amount_details_resource_shipping"
    },
    "line_items": {
      "type": "object",
      "title": "PaymentFlowsAmountDetailsResourceLineItemsList",
      "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/payment_intent_amount_details_line_item"
          },
          "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 line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.",
      "x-expandableFields": [
        "data"
      ]
    },
    "discount_amount": {
      "type": "integer",
      "description": "The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field."
    }
  },
  "description": "",
  "x-expandableFields": [
    "error",
    "line_items",
    "shipping",
    "tax",
    "tip"
  ]
}
object payment_flows_amount_details_client
{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsClient",
  "properties": {
    "tip": {
      "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip"
    }
  },
  "description": "",
  "x-expandableFields": [
    "tip"
  ]
}
object payment_flows_amount_details_client_resource_tip
{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsClientResourceTip",
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Portion of the amount that corresponds to a tip."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_flows_amount_details_resource_error
{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceError",
  "properties": {
    "code": {
      "enum": [
        "amount_details_amount_mismatch",
        "amount_details_tax_shipping_discount_greater_than_amount"
      ],
      "type": "string",
      "nullable": true,
      "description": "The code of the error that occurred when validating the current amount details."
    },
    "message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A message providing more details about the error."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options
{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions",
  "properties": {
    "card": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options"
    },
    "klarna": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options"
    },
    "paypal": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options"
    },
    "card_present": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options"
    }
  },
  "description": "",
  "x-expandableFields": [
    "card",
    "card_present",
    "klarna",
    "paypal"
  ]
}
object payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax
{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourceTax",
  "required": [
    "total_tax_amount"
  ],
  "properties": {
    "total_tax_amount": {
      "type": "integer",
      "description": "The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_flows_amount_details_resource_shipping
{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceShipping",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0."
    },
    "to_postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens and spaces are allowed."
    },
    "from_postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens and spaces are allowed."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_flows_amount_details_resource_tax
{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceTax",
  "properties": {
    "total_tax_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_flows_automatic_payment_methods_payment_intent
{
  "type": "object",
  "title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Automatically calculates compatible payment methods"
    },
    "allow_redirects": {
      "enum": [
        "always",
        "never"
      ],
      "type": "string",
      "description": "Controls whether this PaymentIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_flows_automatic_payment_methods_setup_intent
{
  "type": "object",
  "title": "PaymentFlowsAutomaticPaymentMethodsSetupIntent",
  "properties": {
    "enabled": {
      "type": "boolean",
      "nullable": true,
      "description": "Automatically calculates compatible payment methods"
    },
    "allow_redirects": {
      "enum": [
        "always",
        "never"
      ],
      "type": "string",
      "description": "Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object payment_flows_installment_options
{
  "type": "object",
  "title": "PaymentFlowsInstallmentOptions",
  "required": [
    "enabled"
  ],
  "properties": {
    "plan": {
      "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "description": "",
  "x-expandableFields": [
    "plan"
  ]
}
Load more schemas