payment_method_details_card_wallet_apple_pay
{
"type": "object",
"title": "payment_method_details_card_wallet_apple_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_wallet_google_pay
{
"type": "object",
"title": "payment_method_details_card_wallet_google_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_wallet_link
{
"type": "object",
"title": "payment_method_details_card_wallet_link",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_wallet_masterpass
{
"type": "object",
"title": "payment_method_details_card_wallet_masterpass",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"billing_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "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."
},
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"billing_address",
"shipping_address"
]
}
payment_method_details_card_wallet_samsung_pay
{
"type": "object",
"title": "payment_method_details_card_wallet_samsung_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_card_wallet_visa_checkout
{
"type": "object",
"title": "payment_method_details_card_wallet_visa_checkout",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"billing_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "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."
},
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"billing_address",
"shipping_address"
]
}
payment_method_details_cashapp
{
"type": "object",
"title": "payment_method_details_cashapp",
"properties": {
"cashtag": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A public identifier for buyers using Cash App."
},
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique and immutable identifier assigned by Cash App to every buyer."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique and immutable identifier of payments assigned by Cash App"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_crypto
{
"type": "object",
"title": "payment_method_details_crypto",
"properties": {
"network": {
"enum": [
"base",
"ethereum",
"polygon",
"solana",
"tempo"
],
"type": "string",
"description": "The blockchain network that the transaction was sent on."
},
"buyer_address": {
"type": "string",
"maxLength": 5000,
"description": "The wallet address of the customer."
},
"token_currency": {
"enum": [
"phantom_cash",
"usdc",
"usdg",
"usdp",
"usdt"
],
"type": "string",
"description": "The token currency that the transaction was sent with.",
"x-stripeBypassValidation": true
},
"transaction_hash": {
"type": "string",
"maxLength": 5000,
"description": "The blockchain transaction hash of the crypto payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_customer_balance
{
"type": "object",
"title": "payment_method_details_customer_balance",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_eps
{
"type": "object",
"title": "payment_method_details_eps",
"properties": {
"bank": {
"enum": [
"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"
],
"type": "string",
"nullable": true,
"description": "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`."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_fpx
{
"type": "object",
"title": "payment_method_details_fpx",
"required": [
"bank"
],
"properties": {
"bank": {
"enum": [
"affin_bank",
"agrobank",
"alliance_bank",
"ambank",
"bank_islam",
"bank_muamalat",
"bank_of_china",
"bank_rakyat",
"bsn",
"cimb",
"deutsche_bank",
"hong_leong_bank",
"hsbc",
"kfh",
"maybank2e",
"maybank2u",
"ocbc",
"pb_enterprise",
"public_bank",
"rhb",
"standard_chartered",
"uob"
],
"type": "string",
"description": "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique transaction id generated by FPX for every request from the merchant"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_giropay
{
"type": "object",
"title": "payment_method_details_giropay",
"properties": {
"bic": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank Identifier Code of the bank associated with the bank account."
},
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank code of bank associated with the bank account."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_grabpay
{
"type": "object",
"title": "payment_method_details_grabpay",
"properties": {
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique transaction id generated by GrabPay"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_ideal
{
"type": "object",
"title": "payment_method_details_ideal",
"properties": {
"bic": {
"enum": [
"ABNANL2A",
"ADYBNL2A",
"ASNBNL21",
"BITSNL2A",
"BUNQNL2A",
"BUUTNL2A",
"FNOMNL22",
"FVLBNL22",
"HANDNL2A",
"INGBNL2A",
"KNABNL2H",
"MLLENL2A",
"MOYONL21",
"NNBANL2G",
"NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
"REVOLT21",
"SNSBNL2A",
"TRIONL2U"
],
"type": "string",
"nullable": true,
"description": "The Bank Identifier Code of the customer's bank."
},
"bank": {
"enum": [
"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"
],
"type": "string",
"nullable": true,
"description": "The customer's bank. 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`."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique transaction ID generated by iDEAL."
},
"generated_sepa_debit": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"generated_sepa_debit_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
}
payment_method_details_interac_present
{
"type": "object",
"title": "payment_method_details_interac_present",
"required": [
"exp_month",
"exp_year"
],
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `interac`, `mastercard` or `visa`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"issuer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the card's issuing bank."
},
"reader": {
"type": "string",
"maxLength": 5000,
"description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"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."
},
"funding": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"network": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`."
},
"receipt": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_interac_present_receipt"
}
],
"nullable": true,
"description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions."
},
"exp_year": {
"type": "integer",
"description": "Four-digit number representing the card's expiration year."
},
"location": {
"type": "string",
"maxLength": 5000,
"description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
},
"exp_month": {
"type": "integer",
"description": "Two-digit number representing the card's expiration month."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A high-level description of the type of cards issued in this range."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"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*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.*"
},
"read_method": {
"enum": [
"contact_emv",
"contactless_emv",
"contactless_magstripe_mode",
"magnetic_stripe_fallback",
"magnetic_stripe_track2"
],
"type": "string",
"nullable": true,
"description": "How card details were read in this transaction."
},
"emv_auth_data": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Authorization response cryptogram."
},
"generated_card": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod."
},
"cardholder_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"preferred_locales": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"nullable": true,
"description": "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."
},
"network_transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise."
}
},
"description": "",
"x-expandableFields": [
"receipt"
]
}
payment_method_details_interac_present_receipt
{
"type": "object",
"title": "payment_method_details_interac_present_receipt",
"properties": {
"account_type": {
"enum": [
"checking",
"savings",
"unknown"
],
"type": "string",
"description": "The type of account being debited or credited",
"x-stripeBypassValidation": true
},
"authorization_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Identifier for this transaction."
},
"dedicated_file_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84."
},
"application_cryptogram": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers."
},
"application_preferred_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip."
},
"authorization_response_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "EMV tag 8A. A code returned by the card issuer."
},
"terminal_verification_results": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95."
},
"cardholder_verification_method": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`."
},
"transaction_status_information": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_kakao_pay
{
"type": "object",
"title": "payment_method_details_kakao_pay",
"properties": {
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique identifier for the buyer as determined by the local payment processor."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Kakao Pay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_klarna
{
"type": "object",
"title": "payment_method_details_klarna",
"properties": {
"reader": {
"type": "string",
"maxLength": 5000,
"description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
},
"location": {
"type": "string",
"maxLength": 5000,
"description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
},
"payer_details": {
"anyOf": [
{
"$ref": "#/components/schemas/klarna_payer_details"
}
],
"nullable": true,
"description": "The payer details for this transaction."
},
"preferred_locale": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`"
},
"payment_method_category": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`"
}
},
"description": "",
"x-expandableFields": [
"payer_details"
]
}
payment_method_details_konbini
{
"type": "object",
"title": "payment_method_details_konbini",
"properties": {
"store": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_konbini_store"
}
],
"nullable": true,
"description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed."
}
},
"description": "",
"x-expandableFields": [
"store"
]
}
payment_method_details_konbini_store
{
"type": "object",
"title": "payment_method_details_konbini_store",
"properties": {
"chain": {
"enum": [
"familymart",
"lawson",
"ministop",
"seicomart"
],
"type": "string",
"nullable": true,
"description": "The name of the convenience store chain where the payment was completed.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_kr_card
{
"type": "object",
"title": "payment_method_details_kr_card",
"properties": {
"brand": {
"enum": [
"bc",
"citi",
"hana",
"hyundai",
"jeju",
"jeonbuk",
"kakaobank",
"kbank",
"kdbbank",
"kookmin",
"kwangju",
"lotte",
"mg",
"nh",
"post",
"samsung",
"savingsbank",
"shinhan",
"shinhyup",
"suhyup",
"tossbank",
"woori"
],
"type": "string",
"nullable": true,
"description": "The local credit or debit card brand."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 4,
"description": "The last four digits of the card. This may not be present for American Express cards."
},
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique identifier for the buyer as determined by the local payment processor."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Korean Card transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_link
{
"type": "object",
"title": "payment_method_details_link",
"properties": {
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the funding source country beneath the Link payment.\nYou could use this attribute to get a sense of international fees."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_mb_way
{
"type": "object",
"title": "payment_method_details_mb_way",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_mobilepay
{
"type": "object",
"title": "payment_method_details_mobilepay",
"properties": {
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/internal_card"
}
],
"nullable": true,
"description": "Internal card details"
}
},
"description": "",
"x-expandableFields": [
"card"
]
}
payment_method_details_multibanco
{
"type": "object",
"title": "payment_method_details_multibanco",
"properties": {
"entity": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Entity number associated with this Multibanco payment."
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Reference number associated with this Multibanco payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_naver_pay
{
"type": "object",
"title": "payment_method_details_naver_pay",
"properties": {
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique identifier for the buyer as determined by the local payment processor."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Naver Pay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_nz_bank_account
{
"type": "object",
"title": "payment_method_details_nz_bank_account",
"required": [
"bank_code",
"bank_name",
"branch_code",
"last4"
],
"properties": {
"last4": {
"type": "string",
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"suffix": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The suffix of the bank account number."
},
"bank_code": {
"type": "string",
"maxLength": 5000,
"description": "The numeric code for the bank account's bank."
},
"bank_name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the bank."
},
"branch_code": {
"type": "string",
"maxLength": 5000,
"description": "The numeric code for the bank account's bank branch."
},
"account_holder_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
},
"expected_debit_date": {
"type": "string",
"maxLength": 5000,
"description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_oxxo
{
"type": "object",
"title": "payment_method_details_oxxo",
"properties": {
"number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "OXXO reference number"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_p24
{
"type": "object",
"title": "payment_method_details_p24",
"properties": {
"bank": {
"enum": [
"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"
],
"type": "string",
"nullable": true,
"description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`."
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique reference for this Przelewy24 payment."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_passthrough_card
{
"type": "object",
"title": "payment_method_details_passthrough_card",
"properties": {
"brand": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
},
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The last four digits of the card."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"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."
},
"funding": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
},
"exp_year": {
"type": "integer",
"nullable": true,
"description": "Four-digit number representing the card's expiration year."
},
"exp_month": {
"type": "integer",
"nullable": true,
"description": "Two-digit number representing the card's expiration month."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_pay_by_bank
{
"type": "object",
"title": "payment_method_details_pay_by_bank",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_payco
{
"type": "object",
"title": "payment_method_details_payco",
"properties": {
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique identifier for the buyer as determined by the local payment processor."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Payco transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_acss_debit
{
"type": "object",
"title": "payment_method_details_payment_record_acss_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"mandate": {
"type": "string",
"maxLength": 5000,
"description": "ID of the mandate used to make this payment."
},
"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."
},
"transit_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Transit number of the bank account."
},
"institution_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Institution number of the bank account"
},
"expected_debit_date": {
"type": "string",
"maxLength": 5000,
"description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_affirm
{
"type": "object",
"title": "payment_method_details_payment_record_affirm",
"properties": {
"reader": {
"type": "string",
"maxLength": 5000,
"description": "ID of the reader this transaction was made on."
},
"location": {
"type": "string",
"maxLength": 5000,
"description": "ID of the location that this reader is assigned to."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Affirm transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_afterpay_clearpay
{
"type": "object",
"title": "payment_method_details_payment_record_afterpay_clearpay",
"properties": {
"order_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Afterpay order ID associated with this payment intent."
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Order identifier shown to the merchant in Afterpay's online portal."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_alma
{
"type": "object",
"title": "payment_method_details_payment_record_alma",
"properties": {
"installments": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_alma_details_resource_installments"
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Alma transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": [
"installments"
]
}
payment_method_details_payment_record_amazon_pay
{
"type": "object",
"title": "payment_method_details_payment_record_amazon_pay",
"properties": {
"funding": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_amazon_pay_details_resource_funding"
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Amazon Pay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": [
"funding"
]
}
payment_method_details_payment_record_bancontact
{
"type": "object",
"title": "payment_method_details_payment_record_bancontact",
"properties": {
"bic": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank Identifier Code of the bank associated with the bank account."
},
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank code of bank associated with the bank account."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"preferred_language": {
"enum": [
"de",
"en",
"fr",
"nl"
],
"type": "string",
"nullable": true,
"description": "Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl`"
},
"generated_sepa_debit": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"generated_sepa_debit_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
}
payment_method_details_payment_record_billie
{
"type": "object",
"title": "payment_method_details_payment_record_billie",
"properties": {
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Billie transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_blik
{
"type": "object",
"title": "payment_method_details_payment_record_blik",
"properties": {
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique and immutable identifier assigned by BLIK to every buyer."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_boleto
{
"type": "object",
"title": "payment_method_details_payment_record_boleto",
"properties": {
"tax_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_cashapp
{
"type": "object",
"title": "payment_method_details_payment_record_cashapp",
"properties": {
"cashtag": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A public identifier for buyers using Cash App."
},
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique and immutable identifier assigned by Cash App to every buyer."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique and immutable identifier of payments assigned by Cash App."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_eps
{
"type": "object",
"title": "payment_method_details_payment_record_eps",
"properties": {
"bank": {
"enum": [
"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"
],
"type": "string",
"nullable": true,
"description": "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`"
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by EPS directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. EPS rarely provides this information so the attribute is usually empty."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_giropay
{
"type": "object",
"title": "payment_method_details_payment_record_giropay",
"properties": {
"bic": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank Identifier Code of the bank associated with the bank account."
},
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank code of bank associated with the bank account."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_ideal
{
"type": "object",
"title": "payment_method_details_payment_record_ideal",
"properties": {
"bic": {
"enum": [
"ABNANL2A",
"ADYBNL2A",
"ASNBNL21",
"BITSNL2A",
"BUNQNL2A",
"BUUTNL2A",
"FNOMNL22",
"FVLBNL22",
"HANDNL2A",
"INGBNL2A",
"KNABNL2H",
"MLLENL2A",
"MOYONL21",
"NNBANL2G",
"NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
"REVOLT21",
"SNSBNL2A",
"TRIONL2U"
],
"type": "string",
"nullable": true,
"description": "The Bank Identifier Code of the customer's bank."
},
"bank": {
"enum": [
"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"
],
"type": "string",
"nullable": true,
"description": "The customer's bank. 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`."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by iDEAL directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Unique transaction ID generated by iDEAL."
},
"generated_sepa_debit": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"generated_sepa_debit_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
}
payment_method_details_payment_record_kakao_pay
{
"type": "object",
"title": "payment_method_details_payment_record_kakao_pay",
"properties": {
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unique identifier for the buyer as determined by the local payment processor."
},
"transaction_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The Kakao Pay transaction ID associated with this payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_konbini
{
"type": "object",
"title": "payment_method_details_payment_record_konbini",
"properties": {
"store": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store"
}
],
"nullable": true,
"description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed."
}
},
"description": "",
"x-expandableFields": [
"store"
]
}
payment_method_details_payment_record_mb_way
{
"type": "object",
"title": "payment_method_details_payment_record_mb_way",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_details_payment_record_mobilepay
{
"type": "object",
"title": "payment_method_details_payment_record_mobilepay",
"properties": {
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_mobilepay_details_resource_card"
}
],
"nullable": true,
"description": "Internal card details"
}
},
"description": "",
"x-expandableFields": [
"card"
]
}
payment_method_details_payment_record_multibanco
{
"type": "object",
"title": "payment_method_details_payment_record_multibanco",
"properties": {
"entity": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Entity number associated with this Multibanco payment."
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Reference number associated with this Multibanco payment."
}
},
"description": "",
"x-expandableFields": []
}