Stripe: Payment methods schemas
45 Stripe schemas with complete fields and constraints.
← Payment methods operations · All schemas
Create a Payment Method — request body — body billing details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | |
address (anyOf 1).city | string | Optional | Maximum length: 5000 |
address (anyOf 1).country | string | Optional | Maximum length: 5000 |
address (anyOf 1).line1 | string | Optional | Maximum length: 5000 |
address (anyOf 1).line2 | string | Optional | Maximum length: 5000 |
address (anyOf 1).postal_code | string | Optional | Maximum length: 5000 |
address (anyOf 1).state | string | Optional | Maximum length: 5000 |
address (anyOf 2) | string | Alternative | One of: |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | string | Alternative | One of: |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Maximum length: 5000 |
name (anyOf 2) | string | Alternative | One of: |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Maximum length: 5000 |
phone (anyOf 2) | string | Alternative | One of: |
tax_id | string | Optional | Maximum length: 5000 |
Create a Payment Method — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). |
acss_debit | Model | Optional | Expand Create a Payment Method — response body — acss debit |
affirm | Model | Optional | Expand Create a Payment Method — response body — zip |
afterpay_clearpay | Model | Optional | Expand Create a Payment Method — response body — zip |
alipay | Model | Optional | Expand Create a Payment Method — response body — zip |
allow_redisplay | string | Optional | This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. Known values: always, limited, unspecified |
alma | Model | Optional | Expand Create a Payment Method — response body — zip |
amazon_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
au_becs_debit | Model | Optional | Expand Create a Payment Method — response body — au becs debit |
bacs_debit | Model | Optional | Expand Create a Payment Method — response body — bacs debit |
bancontact | Model | Optional | Expand Create a Payment Method — response body — zip |
billie | Model | Optional | Expand Create a Payment Method — response body — zip |
billing_details | Model | Required within parent | Expand Create a charge — response body — billing details |
bizum | Model | Optional | Expand Create a Payment Method — response body — bizum |
blik | Model | Optional | Expand Create a Payment Method — response body — blik |
boleto | Model | Optional | Expand Create a Payment Method — response body — boleto |
card | Model | Optional | Expand Create a Payment Method — response body — card |
card_present | Model | Optional | Expand Create a Payment Method — response body — card present |
cashapp | Model | Optional | Expand Create a Payment Method — response body — cashapp |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
crypto | Model | Optional | Expand Create a Payment Method — response body — zip |
custom | Model | Optional | Expand Create a Payment Method — response body — custom |
customer | JSON | Optional | |
customer (anyOf 1) | JSON | Alternative | The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. |
customer (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
customer (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a customer — response body |
customer (anyOf 2) | null | Alternative | |
customer_account | JSON | Optional | |
customer_account (anyOf 1) | string | Alternative | Maximum length: 5000 |
customer_account (anyOf 2) | null | Alternative | |
customer_balance | Model | Optional | Expand Create a Payment Method — response body — zip |
eps | Model | Optional | Expand Create a Payment Method — response body — eps |
fpx | Model | Optional | Expand Create a Payment Method — response body — fpx |
giropay | Model | Optional | Expand Create a Payment Method — response body — zip |
grabpay | Model | Optional | Expand Create a Payment Method — response body — zip |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
ideal | Model | Optional | Expand Create a Payment Method — response body — ideal |
interac_present | Model | Optional | Expand Create a Payment Method — response body — interac present |
kakao_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
klarna | Model | Optional | Expand Create a Payment Method — response body — klarna |
konbini | Model | Optional | Expand Create a Payment Method — response body — zip |
kr_card | Model | Optional | Expand Create a Payment Method — response body — kr card |
link | Model | Optional | Expand Create a Payment Method — response body — link |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
mb_way | Model | Optional | Expand Create a Payment Method — response body — zip |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | 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. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | Maximum length: 500 |
metadata (anyOf 2) | null | Alternative | |
mobilepay | Model | Optional | Expand Create a Payment Method — response body — zip |
multibanco | Model | Optional | Expand Create a Payment Method — response body — zip |
naver_pay | Model | Optional | Expand Create a Payment Method — response body — naver pay |
nz_bank_account | Model | Optional | Expand Create a Payment Method — response body — nz bank account |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: payment_method |
oxxo | Model | Optional | Expand Create a Payment Method — response body — zip |
p24 | Model | Optional | Expand Create a Payment Method — response body — p24 |
pay_by_bank | Model | Optional | Expand Create a Payment Method — response body — zip |
payco | Model | Optional | Expand Create a Payment Method — response body — zip |
paynow | Model | Optional | Expand Create a Payment Method — response body — zip |
paypal | Model | Optional | Expand Create a Payment Method — response body — paypal |
paypay | Model | Optional | Expand Create a Payment Method — response body — zip |
payto | Model | Optional | Expand Create a Payment Method — response body — payto |
pix | Model | Optional | Expand Create a Payment Method — response body — pix |
promptpay | Model | Optional | Expand Create a Payment Method — response body — zip |
radar_options | Model | Optional | Expand Create a charge — response body — radar options |
revolut_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
samsung_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
satispay | Model | Optional | Expand Create a Payment Method — response body — zip |
scalapay | Model | Optional | Expand Create a Payment Method — response body — zip |
sepa_debit | Model | Optional | Expand Create a Payment Method — response body — sepa debit |
sequra | Model | Optional | Expand Create a Payment Method — response body — zip |
sofort | Model | Optional | Expand Create a Payment Method — response body — sofort |
sunbit | Model | Optional | Expand Create a Payment Method — response body — zip |
swish | Model | Optional | Expand Create a Payment Method — response body — zip |
twint | Model | Optional | Expand Create a Payment Method — response body — zip |
type | string | Required within parent | The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. Known values: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, custom, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip |
upi | Model | Optional | Expand Create a Payment Method — response body — upi |
us_bank_account | Model | Optional | Expand Create a Payment Method — response body — us bank account |
wechat_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
zip | Model | Optional | Expand Create a Payment Method — response body — zip |
Referenced models: Create a Payment Method — response body — zip, Create a charge — response body — billing details, Create a customer — response body, Create a Payment Method — response body — acss debit, Create a Payment Method — response body — au becs debit, Create a Payment Method — response body — bacs debit, Create a Payment Method — response body — bizum, Create a Payment Method — response body — blik, Create a Payment Method — response body — boleto, Create a Payment Method — response body — card, Create a Payment Method — response body — card present, Create a Payment Method — response body — cashapp, Create a Payment Method — response body — custom, Create a Payment Method — response body — eps, Create a Payment Method — response body — fpx, Create a Payment Method — response body — ideal, Create a Payment Method — response body — interac present, Create a Payment Method — response body — klarna, Create a Payment Method — response body — kr card, Create a Payment Method — response body — link, Create a Payment Method — response body — naver pay, Create a Payment Method — response body — nz bank account, Create a Payment Method — response body — p24, Create a Payment Method — response body — paypal, Create a Payment Method — response body — payto, Create a Payment Method — response body — pix, Create a Payment Method — response body — sepa debit, Create a Payment Method — response body — sofort, Create a Payment Method — response body — upi, Create a Payment Method — response body — us bank account, Create a charge — response body — radar options
Create a Payment Method — response body — acss debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
institution_number | JSON | Optional | |
institution_number (anyOf 1) | string | Alternative | Institution number of the bank account. Maximum length: 5000 |
institution_number (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
transit_number | JSON | Optional | |
transit_number (anyOf 1) | string | Alternative | Transit number of the bank account. Maximum length: 5000 |
transit_number (anyOf 2) | null | Alternative |
Create a Payment Method — response body — au becs debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bsb_number | JSON | Optional | |
bsb_number (anyOf 1) | string | Alternative | Six-digit number identifying bank and branch associated with this bank account. Maximum length: 5000 |
bsb_number (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative |
Create a Payment Method — response body — bacs debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
sort_code | JSON | Optional | |
sort_code (anyOf 1) | string | Alternative | Sort code of the bank account. (e.g., `10-20-30`) Maximum length: 5000 |
sort_code (anyOf 2) | null | Alternative |
Create a Payment Method — response body — bizum
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buyer_id | JSON | Optional | |
buyer_id (anyOf 1) | string | Alternative | A unique identifier for the buyer as determined by the local payment processor. Maximum length: 5000 |
buyer_id (anyOf 2) | null | Alternative |
Create a Payment Method — response body — blik
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buyer_id | JSON | Optional | |
buyer_id (anyOf 1) | string | Alternative | A unique and immutable identifier assigned by BLIK to every buyer. Maximum length: 5000 |
buyer_id (anyOf 2) | null | Alternative |
Create a Payment Method — response body — boleto
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tax_id | string | Required within parent | Uniquely identifies the customer tax id (CNPJ or CPF) Maximum length: 5000 |
Create a Payment Method — response body — card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | string | Required within parent | Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. Maximum length: 5000 |
checks | JSON | Optional | |
checks (anyOf 1) | JSON | Alternative | Checks on Card address and CVC if provided. |
checks (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card checks Checks on Card address and CVC if provided address line1 check, address postal code check, cvc check |
checks (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
display_brand | JSON | Optional | |
display_brand (anyOf 1) | string | Alternative | The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. Maximum length: 5000 |
display_brand (anyOf 2) | null | Alternative | |
exp_month | JSON | Required within parent | |
exp_month (anyOf 1) | integer | Alternative | Two-digit number representing the card's expiration month. |
exp_month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year | JSON | Required within parent | |
exp_year (anyOf 1) | integer | Alternative | Four-digit number representing the card's expiration year. |
exp_year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | 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. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
funding | string | Required within parent | Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Maximum length: 5000 |
generated_from | JSON | Optional | |
generated_from (anyOf 1) | JSON | Alternative | Details of the original PaymentMethod that created this object. |
generated_from (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card generated from value charge, payment method details, setup attempt |
generated_from (anyOf 2) | null | Alternative | |
last4 | string | Required within parent | The last four digits of the card. Maximum length: 5000 |
networks | JSON | Optional | |
networks (anyOf 1) | JSON | Alternative | Contains information about card networks that can be used to process the payment. |
networks (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card networks value available, preferred |
networks (anyOf 2) | null | Alternative | |
regulated_status | JSON | Optional | |
regulated_status (anyOf 1) | string | Alternative | Status of a card based on the card issuer. Known values: regulated, unregulated |
regulated_status (anyOf 2) | null | Alternative | |
three_d_secure_usage | JSON | Optional | |
three_d_secure_usage (anyOf 1) | JSON | Alternative | Contains details on how this Card may be used for 3D Secure authentication. |
three_d_secure_usage (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card three d secure usage value supported |
three_d_secure_usage (anyOf 2) | null | Alternative | |
wallet | JSON | Optional | |
wallet (anyOf 1) | JSON | Alternative | If this Card is part of a card wallet, this contains the details of the card wallet. |
wallet (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout |
wallet (anyOf 2) | null | Alternative |
Referenced models: Create a Payment Method — response body — card networks value available, preferred, Create a Payment Method — response body — card checks Checks on Card address and CVC if provided address line1 check, address postal code check, cvc check, Create a Payment Method — response body — card generated from value charge, payment method details, setup attempt, Create a Payment Method — response body — card wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout, Create a Payment Method — response body — card three d secure usage value supported
Create a Payment Method — response body — card checks Checks on Card address and CVC if provided address line1 check, address postal code check, cvc check
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line1_check | JSON | Optional | |
address_line1_check (anyOf 1) | string | Alternative | If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. Maximum length: 5000 |
address_line1_check (anyOf 2) | null | Alternative | |
address_postal_code_check | JSON | Optional | |
address_postal_code_check (anyOf 1) | string | Alternative | If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. Maximum length: 5000 |
address_postal_code_check (anyOf 2) | null | Alternative | |
cvc_check | JSON | Optional | |
cvc_check (anyOf 1) | string | Alternative | If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. Maximum length: 5000 |
cvc_check (anyOf 2) | null | Alternative |
Create a Payment Method — response body — card generated from value charge, payment method details, setup attempt
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
charge | JSON | Optional | |
charge (anyOf 1) | string | Alternative | The charge that created this object. Maximum length: 5000 |
charge (anyOf 2) | null | Alternative | |
payment_method_details | JSON | Optional | |
payment_method_details (anyOf 1) | JSON | Alternative | Transaction-specific details of the payment method used in the payment. |
payment_method_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card generated from value charge, payment method details, setup attempt payment method details value card present, type |
payment_method_details (anyOf 2) | null | Alternative | |
setup_attempt | JSON | Optional | |
setup_attempt (anyOf 1) | JSON | Alternative | The ID of the SetupAttempt that generated this PaymentMethod, if any. |
setup_attempt (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
setup_attempt (anyOf 1) (anyOf 2) | Model | Alternative | Expand List all Setup Attempts — response body — data item |
setup_attempt (anyOf 2) | null | Alternative |
Referenced models: Create a Payment Method — response body — card generated from value charge, payment method details, setup attempt payment method details value card present, type, List all Setup Attempts — response body — data item
Create a Payment Method — response body — card generated from value charge, payment method details, setup attempt payment method details value card present, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
card_present | Model | Optional | Expand Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip card present |
type | string | Required within parent | The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. Maximum length: 5000 |
Create a Payment Method — response body — card networks value available, preferred
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available | array | Required within parent | All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). |
available[] | string | Each item | Maximum length: 5000 |
preferred | JSON | Optional | |
preferred (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
preferred (anyOf 2) | null | Alternative |
Create a Payment Method — response body — card present
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. Maximum length: 5000 |
brand (anyOf 2) | null | Alternative | |
brand_product | JSON | Optional | |
brand_product (anyOf 1) | string | Alternative | The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. Maximum length: 5000 |
brand_product (anyOf 2) | null | Alternative | |
cardholder_name | JSON | Optional | |
cardholder_name (anyOf 1) | string | Alternative | The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. Maximum length: 5000 |
cardholder_name (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A high-level description of the type of cards issued in this range. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
exp_month | JSON | Required within parent | |
exp_month (anyOf 1) | integer | Alternative | Two-digit number representing the card's expiration month. |
exp_month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year | JSON | Required within parent | |
exp_year (anyOf 1) | integer | Alternative | Four-digit number representing the card's expiration year. |
exp_year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | 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. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
funding | JSON | Optional | |
funding (anyOf 1) | string | Alternative | Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Maximum length: 5000 |
funding (anyOf 2) | null | Alternative | |
issuer | JSON | Optional | |
issuer (anyOf 1) | string | Alternative | The name of the card's issuing bank. Maximum length: 5000 |
issuer (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | The last four digits of the card. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
networks | JSON | Optional | |
networks (anyOf 1) | JSON | Alternative | Contains information about card networks that can be used to process the payment. |
networks (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card present networks value available, preferred |
networks (anyOf 2) | null | Alternative | |
offline | JSON | Optional | |
offline (anyOf 1) | JSON | Alternative | Details about payment methods collected offline. |
offline (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card present offline Details about payment methods collected offline stored at, type |
offline (anyOf 2) | null | Alternative | |
preferred_locales | JSON | Optional | |
preferred_locales (anyOf 1) | array | Alternative | The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. |
preferred_locales (anyOf 1)[] | string | Each item | Maximum length: 5000 |
preferred_locales (anyOf 2) | null | Alternative | |
read_method | JSON | Optional | |
read_method (anyOf 1) | string | Alternative | How card details were read in this transaction. Known values: contact_emv, contactless_emv, contactless_magstripe_mode, magnetic_stripe_fallback, magnetic_stripe_track2 |
read_method (anyOf 2) | null | Alternative | |
wallet | Model | Optional | Expand Create a Payment Method — response body — card present wallet |
Referenced models: Create a Payment Method — response body — card present wallet, Create a Payment Method — response body — card present networks value available, preferred, Create a Payment Method — response body — card present offline Details about payment methods collected offline stored at, type
Create a Payment Method — response body — card present networks value available, preferred
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
available | array | Required within parent | All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). |
available[] | string | Each item | Maximum length: 5000 |
preferred | JSON | Optional | |
preferred (anyOf 1) | string | Alternative | The preferred network for the card. Maximum length: 5000 |
preferred (anyOf 2) | null | Alternative |
Create a Payment Method — response body — card present offline Details about payment methods collected offline stored at, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
stored_at | JSON | Optional | |
stored_at (anyOf 1) | JSON | Alternative | |
stored_at (anyOf 1) (anyOf 1) | integer | Alternative | Time at which the payment was collected while offline Format: unix-time |
stored_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
stored_at (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The method used to process this payment method offline. Only deferred is allowed. Known values: deferred |
type (anyOf 2) | null | Alternative |
Create a Payment Method — response body — card present wallet
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`. Known values: apple_pay, google_pay, samsung_pay, unknown |
Create a Payment Method — response body — card three d secure usage value supported
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
supported | boolean | Required within parent | Whether 3D Secure is supported on this card. |
Create a Payment Method — response body — card wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amex_express_checkout | Model | Optional | Expand Create a Payment Method — response body — zip |
apple_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
dynamic_last4 | JSON | Optional | |
dynamic_last4 (anyOf 1) | string | Alternative | (For tokenized numbers only.) The last four digits of the device account number. Maximum length: 5000 |
dynamic_last4 (anyOf 2) | null | Alternative | |
google_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
link | Model | Optional | Expand Create a Payment Method — response body — zip |
masterpass | Model | Optional | Expand Create a Payment Method — response body — card wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout masterpass |
samsung_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
type | string | Required within parent | The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, 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. Known values: amex_express_checkout, apple_pay, google_pay, link, masterpass, samsung_pay, visa_checkout |
visa_checkout | Model | Optional | Expand Create a Payment Method — response body — card wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout masterpass |
Referenced models: Create a Payment Method — response body — zip, Create a Payment Method — response body — card wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout masterpass
Create a Payment Method — response body — card wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout masterpass
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billing_address | JSON | Optional | |
billing_address (anyOf 1) | JSON | Alternative | Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. |
billing_address (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address |
billing_address (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
email (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
shipping_address | JSON | Optional | |
shipping_address (anyOf 1) | JSON | Alternative | Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. |
shipping_address (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address |
shipping_address (anyOf 2) | null | Alternative |
Referenced models: Create a Location — response body — address
Create a Payment Method — response body — cashapp
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buyer_id | JSON | Optional | |
buyer_id (anyOf 1) | string | Alternative | A unique and immutable identifier assigned by Cash App to every buyer. Maximum length: 5000 |
buyer_id (anyOf 2) | null | Alternative | |
cashtag | JSON | Optional | |
cashtag (anyOf 1) | string | Alternative | A public identifier for buyers using Cash App. Maximum length: 5000 |
cashtag (anyOf 2) | null | Alternative |
Create a Payment Method — response body — custom
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | JSON | Optional | |
display_name (anyOf 1) | string | Alternative | Display name of the Dashboard-only CustomPaymentMethodType. Maximum length: 5000 |
display_name (anyOf 2) | null | Alternative | |
logo | JSON | Optional | |
logo (anyOf 1) | JSON | Alternative | Contains information about the Dashboard-only CustomPaymentMethodType logo. |
logo (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — custom logo value content type, url |
logo (anyOf 2) | null | Alternative | |
type | string | Required within parent | ID of the Dashboard-only CustomPaymentMethodType. Not expandable. Maximum length: 5000 |
Referenced models: Create a Payment Method — response body — custom logo value content type, url
Create a Payment Method — response body — custom logo value content type, url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content_type | JSON | Optional | |
content_type (anyOf 1) | string | Alternative | Content type of the Dashboard-only CustomPaymentMethodType logo. Maximum length: 5000 |
content_type (anyOf 2) | null | Alternative | |
url | string | Required within parent | URL of the Dashboard-only CustomPaymentMethodType logo. Maximum length: 5000 |
Create a Payment Method — response body — eps
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | JSON | Optional | |
bank (anyOf 1) | string | Alternative | The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. Known values: arzte_und_apotheker_bank, austrian_anadi_bank_ag, bank_austria, bankhaus_carl_spangler, bankhaus_schelhammer_und_schattera_ag, bawag_psk_ag, bks_bank_ag, brull_kallmus_bank_ag, btv_vier_lander_bank, capital_bank_grawe_gruppe_ag, deutsche_bank_ag, dolomitenbank, easybank_ag, erste_bank_und_sparkassen, hypo_alpeadriabank_international_ag, hypo_bank_burgenland_aktiengesellschaft, hypo_noe_lb_fur_niederosterreich_u_wien, hypo_oberosterreich_salzburg_steiermark, hypo_tirol_bank_ag, hypo_vorarlberg_bank_ag, marchfelder_bank, oberbank_ag, raiffeisen_bankengruppe_osterreich, schoellerbank_ag, sparda_bank_wien, volksbank_gruppe, volkskreditbank_ag, vr_bank_braunau |
bank (anyOf 2) | null | Alternative |
Create a Payment Method — response body — fpx
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | string | Required within parent | The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bnp_paribas`, `bank_rakyat`, `bsn`, `cimb`, `citibank`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `mbsb_bank`, `pb_enterprise`, or `bank_of_china`. Known values: affin_bank, agrobank, alliance_bank, ambank, bank_islam, bank_muamalat, bank_of_china, bank_rakyat, bnp_paribas, bsn, cimb, citibank, deutsche_bank, hong_leong_bank, hsbc, kfh, maybank2e, maybank2u, mbsb_bank, ocbc, pb_enterprise, public_bank, rhb, standard_chartered, uob |
Create a Payment Method — response body — ideal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | JSON | Optional | |
bank (anyOf 1) | string | Alternative | The customer's bank, if provided. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. Known values: abn_amro, adyen, asn_bank, bunq, buut, finom, handelsbanken, ing, knab, mollie, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, yoursafe |
bank (anyOf 2) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | The Bank Identifier Code of the customer's bank, if the bank was provided. Known values: ABNANL2A, ADYBNL2A, ASNBNL21, BITSNL2A, BUNQNL2A, BUUTNL2A, FNOMNL22, FVLBNL22, HANDNL2A, INGBNL2A, KNABNL2H, MLLENL2A, MOYONL21, NNBANL2G, NTSBDEB1, RABONL2U, RBRBNL21, REVOIE23, REVOLT21, SNSBNL2A, TRIONL2U |
bic (anyOf 2) | null | Alternative |
Create a Payment Method — response body — interac present
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | Card brand. Can be `interac`, `mastercard` or `visa`. Maximum length: 5000 |
brand (anyOf 2) | null | Alternative | |
cardholder_name | JSON | Optional | |
cardholder_name (anyOf 1) | string | Alternative | The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. Maximum length: 5000 |
cardholder_name (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A high-level description of the type of cards issued in this range. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
exp_month | JSON | Required within parent | |
exp_month (anyOf 1) | integer | Alternative | Two-digit number representing the card's expiration month. |
exp_month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year | JSON | Required within parent | |
exp_year (anyOf 1) | integer | Alternative | Four-digit number representing the card's expiration year. |
exp_year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | 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. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
funding | JSON | Optional | |
funding (anyOf 1) | string | Alternative | Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Maximum length: 5000 |
funding (anyOf 2) | null | Alternative | |
issuer | JSON | Optional | |
issuer (anyOf 1) | string | Alternative | The name of the card's issuing bank. Maximum length: 5000 |
issuer (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | The last four digits of the card. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
networks | JSON | Optional | |
networks (anyOf 1) | JSON | Alternative | Contains information about card networks that can be used to process the payment. |
networks (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card present networks value available, preferred |
networks (anyOf 2) | null | Alternative | |
preferred_locales | JSON | Optional | |
preferred_locales (anyOf 1) | array | Alternative | The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. |
preferred_locales (anyOf 1)[] | string | Each item | Maximum length: 5000 |
preferred_locales (anyOf 2) | null | Alternative | |
read_method | JSON | Optional | |
read_method (anyOf 1) | string | Alternative | How card details were read in this transaction. Known values: contact_emv, contactless_emv, contactless_magstripe_mode, magnetic_stripe_fallback, magnetic_stripe_track2 |
read_method (anyOf 2) | null | Alternative |
Referenced models: Create a Payment Method — response body — card present networks value available, preferred
Create a Payment Method — response body — klarna
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dob | JSON | Optional | |
dob (anyOf 1) | JSON | Alternative | The customer's date of birth, if provided. |
dob (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a person — accounts post Accounts Account People — response body — dob |
dob (anyOf 2) | null | Alternative |
Referenced models: Create a person — accounts post Accounts Account People — response body — dob
Create a Payment Method — response body — kr card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | The local credit or debit card brand. Known values: bc, citi, hana, hyundai, jeju, jeonbuk, kakaobank, kbank, kdbbank, kookmin, kwangju, lotte, mg, nh, post, samsung, savingsbank, shinhan, shinhyup, suhyup, tossbank, woori |
brand (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | The last four digits of the card. This may not be present for American Express cards. Maximum length: 4 |
last4 (anyOf 2) | null | Alternative |
Create a Payment Method — response body — link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Account owner's email address. Maximum length: 5000 |
email (anyOf 2) | null | Alternative |
Create a Payment Method — response body — naver pay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buyer_id | JSON | Optional | |
buyer_id (anyOf 1) | string | Alternative | Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same. Maximum length: 5000 |
buyer_id (anyOf 2) | null | Alternative | |
funding | string | Required within parent | Whether to fund this transaction with Naver Pay points or a card. Known values: card, points |
Create a Payment Method — response body — nz bank account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_holder_name | JSON | Optional | |
account_holder_name (anyOf 1) | string | Alternative | The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details. Maximum length: 5000 |
account_holder_name (anyOf 2) | null | Alternative | |
bank_code | string | Required within parent | The numeric code for the bank account's bank. Maximum length: 5000 |
bank_name | string | Required within parent | The name of the bank. Maximum length: 5000 |
branch_code | string | Required within parent | The numeric code for the bank account's bank branch. Maximum length: 5000 |
last4 | string | Required within parent | Last four digits of the bank account number. Maximum length: 5000 |
suffix | JSON | Optional | |
suffix (anyOf 1) | string | Alternative | The suffix of the bank account number. Maximum length: 5000 |
suffix (anyOf 2) | null | Alternative |
Create a Payment Method — response body — p24
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | JSON | Optional | |
bank (anyOf 1) | string | Alternative | The customer's bank, if provided. Known values: alior_bank, bank_millennium, bank_nowy_bfg_sa, bank_pekao_sa, banki_spbdzielcze, blik, bnp_paribas, boz, citi_handlowy, credit_agricole, envelobank, etransfer_pocztowy24, getin_bank, ideabank, ing, inteligo, mbank_mtransfer, nest_przelew, noble_pay, pbac_z_ipko, plus_bank, santander_przelew24, tmobile_usbugi_bankowe, toyota_bank, velobank, volkswagen_bank |
bank (anyOf 2) | null | Alternative |
Create a Payment Method — response body — paypal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
payer_email | JSON | Optional | |
payer_email (anyOf 1) | string | Alternative | Owner's email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
payer_email (anyOf 2) | null | Alternative | |
payer_id | JSON | Optional | |
payer_id (anyOf 1) | string | Alternative | PayPal account PayerID. This identifier uniquely identifies the PayPal customer. Maximum length: 5000 |
payer_id (anyOf 2) | null | Alternative |
Create a Payment Method — response body — payto
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bsb_number | JSON | Optional | |
bsb_number (anyOf 1) | string | Alternative | Bank-State-Branch number of the bank account. Maximum length: 5000 |
bsb_number (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
pay_id | JSON | Optional | |
pay_id (anyOf 1) | string | Alternative | The PayID alias for the bank account. Maximum length: 5000 |
pay_id (anyOf 2) | null | Alternative |
Create a Payment Method — response body — pix
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular Pix account. You can use this attribute to check whether two Pix accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative |
Create a Payment Method — response body — sepa debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | Bank code of bank associated with the bank account. Maximum length: 5000 |
bank_code (anyOf 2) | null | Alternative | |
branch_code | JSON | Optional | |
branch_code (anyOf 1) | string | Alternative | Branch code of bank associated with the bank account. Maximum length: 5000 |
branch_code (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter ISO code representing the country the bank account is located in. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
generated_from | JSON | Optional | |
generated_from (anyOf 1) | JSON | Alternative | Information about the object that generated this PaymentMethod. |
generated_from (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — sepa debit generated from value charge, setup attempt |
generated_from (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four characters of the IBAN. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative |
Referenced models: Create a Payment Method — response body — sepa debit generated from value charge, setup attempt
Create a Payment Method — response body — sepa debit generated from value charge, setup attempt
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
charge | JSON | Optional | |
charge (anyOf 1) | JSON | Alternative | The ID of the Charge that generated this PaymentMethod, if any. |
charge (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
charge (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a charge — response body |
charge (anyOf 2) | null | Alternative | |
setup_attempt | JSON | Optional | |
setup_attempt (anyOf 1) | JSON | Alternative | The ID of the SetupAttempt that generated this PaymentMethod, if any. |
setup_attempt (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
setup_attempt (anyOf 1) (anyOf 2) | Model | Alternative | Expand List all Setup Attempts — response body — data item |
setup_attempt (anyOf 2) | null | Alternative |
Referenced models: Create a charge — response body, List all Setup Attempts — response body — data item
Create a Payment Method — response body — sofort
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter ISO code representing the country the bank account is located in. Maximum length: 5000 |
country (anyOf 2) | null | Alternative |
Create a Payment Method — response body — upi
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
vpa | JSON | Optional | |
vpa (anyOf 1) | string | Alternative | Customer's unique Virtual Payment Address Maximum length: 5000 |
vpa (anyOf 2) | null | Alternative |
Create a Payment Method — response body — us bank account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_holder_type | JSON | Optional | |
account_holder_type (anyOf 1) | string | Alternative | Account holder type: individual or company. Known values: company, individual |
account_holder_type (anyOf 2) | null | Alternative | |
account_type | JSON | Optional | |
account_type (anyOf 1) | string | Alternative | Account type: checkings or savings. Defaults to checking if omitted. Known values: checking, savings |
account_type (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | The name of the bank. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
financial_connections_account | JSON | Optional | |
financial_connections_account (anyOf 1) | string | Alternative | The ID of the Financial Connections Account used to create the payment method. Maximum length: 5000 |
financial_connections_account (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
networks | JSON | Optional | |
networks (anyOf 1) | JSON | Alternative | Contains information about US bank account networks that can be used. |
networks (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — us bank account networks value preferred, supported |
networks (anyOf 2) | null | Alternative | |
routing_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | Routing number of the bank account. Maximum length: 5000 |
routing_number (anyOf 2) | null | Alternative | |
status_details | JSON | Optional | |
status_details (anyOf 1) | JSON | Alternative | Contains information about the future reusability of this PaymentMethod. |
status_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — us bank account status details value blocked |
status_details (anyOf 2) | null | Alternative |
Referenced models: Create a Payment Method — response body — us bank account status details value blocked, Create a Payment Method — response body — us bank account networks value preferred, supported
Create a Payment Method — response body — us bank account networks value preferred, supported
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
preferred | JSON | Optional | |
preferred (anyOf 1) | string | Alternative | The preferred network. Maximum length: 5000 |
preferred (anyOf 2) | null | Alternative | |
supported | array | Required within parent | All supported networks. |
supported[] | string | Each item | Known values: ach, us_domestic_wire |
Create a Payment Method — response body — us bank account status details value blocked
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
blocked | Model | Optional | Expand Create a Payment Method — response body — us bank account status details value blocked blocked |
Referenced models: Create a Payment Method — response body — us bank account status details value blocked blocked
Create a Payment Method — response body — us bank account status details value blocked blocked
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
network_code | JSON | Optional | |
network_code (anyOf 1) | string | Alternative | The ACH network code that resulted in this block. Known values: R02, R03, R04, R05, R07, R08, R10, R11, R16, R20, R29, R31 |
network_code (anyOf 2) | null | Alternative | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | The reason why this PaymentMethod's fingerprint has been blocked Known values: bank_account_closed, bank_account_frozen, bank_account_invalid_details, bank_account_restricted, bank_account_unusable, debit_not_authorized, tokenized_account_number_deactivated |
reason (anyOf 2) | null | Alternative |
Create a Payment Method — response body — zip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |