Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed May 1, 2023
1 parent 1e3a398 commit 7796308
Show file tree
Hide file tree
Showing 6 changed files with 686 additions and 16 deletions.
126 changes: 122 additions & 4 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42850,15 +42850,79 @@
"setup_attempt_payment_method_details_card": {
"description": "",
"properties": {
"brand": {
"description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"checks": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_checks"
}
],
"description": "Check results by Card networks on Card address and CVC at time of payment.",
"description": "Check results by Card networks on Card address and CVC at the time of authorization",
"nullable": true
},
"country": {
"description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"description": {
"description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"exp_month": {
"description": "Two-digit number representing the card's expiration month.",
"nullable": true,
"type": "integer"
},
"exp_year": {
"description": "Four-digit number representing the card's expiration year.",
"nullable": true,
"type": "integer"
},
"fingerprint": {
"description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"funding": {
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"iin": {
"description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"issuer": {
"description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"last4": {
"description": "The last four digits of the card.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"network": {
"description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"three_d_secure": {
"anyOf": [
{
Expand All @@ -42867,21 +42931,42 @@
],
"description": "Populated if this authorization used 3D Secure authentication.",
"nullable": true
},
"wallet": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_attempt_payment_method_details_card_wallet"
}
],
"description": "If this Card is part of a card wallet, this contains the details of the card wallet.",
"nullable": true
}
},
"required": [
"brand",
"checks",
"three_d_secure"
"country",
"exp_month",
"exp_year",
"funding",
"last4",
"network",
"three_d_secure",
"wallet"
],
"title": "setup_attempt_payment_method_details_card",
"type": "object",
"x-expandableFields": [
"checks",
"three_d_secure"
"three_d_secure",
"wallet"
],
"x-stripeResource": {
"class_name": "Card",
"in_class": "setup_attempt_payment_method_details"
"in_class": "setup_attempt_payment_method_details",
"inner_classes": [
"setup_attempt_payment_method_details_card_wallet"
]
}
},
"setup_attempt_payment_method_details_card_present": {
Expand Down Expand Up @@ -42921,6 +43006,39 @@
"in_class": "setup_attempt_payment_method_details"
}
},
"setup_attempt_payment_method_details_card_wallet": {
"description": "",
"properties": {
"apple_pay": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
},
"google_pay": {
"$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
},
"type": {
"description": "The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
"enum": [
"apple_pay",
"google_pay",
"link"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "setup_attempt_payment_method_details_card_wallet",
"type": "object",
"x-expandableFields": [
"apple_pay",
"google_pay"
],
"x-stripeResource": {
"class_name": "Wallet",
"in_class": "setup_attempt_payment_method_details_card"
}
},
"setup_attempt_payment_method_details_cashapp": {
"description": "",
"properties": {},
Expand Down
132 changes: 130 additions & 2 deletions openapi/spec3.beta.sdk.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38987,29 +38987,129 @@ components:
setup_attempt_payment_method_details_card:
description: ''
properties:
brand:
description: >-
Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`,
`mastercard`, `unionpay`, `visa`, or `unknown`.
maxLength: 5000
nullable: true
type: string
checks:
anyOf:
- $ref: '#/components/schemas/payment_method_details_card_checks'
description: >-
Check results by Card networks on Card address and CVC at time of
payment.
Check results by Card networks on Card address and CVC at the time
of authorization
nullable: true
country:
description: >-
Two-letter ISO code representing the country of the card. You could
use this attribute to get a sense of the international breakdown of
cards you've collected.
maxLength: 5000
nullable: true
type: string
description:
description: >-
A high-level description of the type of cards issued in this range.
(For internal use only and not typically available in standard API
requests.)
maxLength: 5000
nullable: true
type: string
exp_month:
description: Two-digit number representing the card's expiration month.
nullable: true
type: integer
exp_year:
description: Four-digit number representing the card's expiration year.
nullable: true
type: integer
fingerprint:
description: >-
Uniquely identifies this particular card number. You can use this
attribute to check whether two customers who’ve signed up with you
are using the same card number, for example. For payment methods
that tokenize card information (Apple Pay, Google Pay), the
tokenized number might be provided instead of the underlying card
number.


*Starting May 1, 2021, card fingerprint in India for Connect will
change to allow two fingerprints for the same card --- one for India
and one for the rest of the world.*
maxLength: 5000
nullable: true
type: string
funding:
description: >-
Card funding type. Can be `credit`, `debit`, `prepaid`, or
`unknown`.
maxLength: 5000
nullable: true
type: string
iin:
description: >-
Issuer identification number of the card. (For internal use only and
not typically available in standard API requests.)
maxLength: 5000
nullable: true
type: string
issuer:
description: >-
The name of the card's issuing bank. (For internal use only and not
typically available in standard API requests.)
maxLength: 5000
nullable: true
type: string
last4:
description: The last four digits of the card.
maxLength: 5000
nullable: true
type: string
network:
description: >-
Identifies which network this charge was processed on. Can be
`amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`,
`interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
maxLength: 5000
nullable: true
type: string
three_d_secure:
anyOf:
- $ref: '#/components/schemas/three_d_secure_details'
description: Populated if this authorization used 3D Secure authentication.
nullable: true
wallet:
anyOf:
- $ref: >-
#/components/schemas/setup_attempt_payment_method_details_card_wallet
description: >-
If this Card is part of a card wallet, this contains the details of
the card wallet.
nullable: true
required:
- brand
- checks
- country
- exp_month
- exp_year
- funding
- last4
- network
- three_d_secure
- wallet
title: setup_attempt_payment_method_details_card
type: object
x-expandableFields:
- checks
- three_d_secure
- wallet
x-stripeResource:
class_name: Card
in_class: setup_attempt_payment_method_details
inner_classes:
- setup_attempt_payment_method_details_card_wallet
setup_attempt_payment_method_details_card_present:
description: ''
properties:
Expand All @@ -39034,6 +39134,34 @@ components:
x-stripeResource:
class_name: CardPresent
in_class: setup_attempt_payment_method_details
setup_attempt_payment_method_details_card_wallet:
description: ''
properties:
apple_pay:
$ref: '#/components/schemas/payment_method_details_card_wallet_apple_pay'
google_pay:
$ref: '#/components/schemas/payment_method_details_card_wallet_google_pay'
type:
description: >-
The type of the card wallet, one of `apple_pay`, `google_pay`, or
`link`. An additional hash is included on the Wallet subhash with a
name matching this value. It contains additional information
specific to the card wallet type.
enum:
- apple_pay
- google_pay
- link
type: string
required:
- type
title: setup_attempt_payment_method_details_card_wallet
type: object
x-expandableFields:
- apple_pay
- google_pay
x-stripeResource:
class_name: Wallet
in_class: setup_attempt_payment_method_details_card
setup_attempt_payment_method_details_cashapp:
description: ''
properties: {}
Expand Down
Loading

0 comments on commit 7796308

Please sign in to comment.