Stripe: Charges schemas (part 2)
59 Stripe schemas with complete fields and constraints.
← Charges operations · All schemas
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
Referenced models: Retrieve a Mandate — response body, 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 extended authorization, 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 incremental authorization, 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 overcapture, 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 multicapture, 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 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 installments Installment details for this payment plan, 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 network token value used, 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 wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout, 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 three d secure value authentication flow, electronic commerce indicator, exemption indicator, exemption indicator applied, result, result reason, transaction id, version
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 extended authorization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Indicates whether or not the capture window is extended beyond the standard authorization. Known values: disabled, enabled |
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 incremental authorization
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Indicates whether or not the incremental authorization feature is supported. Known values: available, unavailable |
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 installments Installment details for this payment plan
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 multicapture
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Indicates whether or not multiple captures are supported. Known values: available, unavailable |
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 network token value used
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
used | boolean | Required within parent | Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction. |
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 overcapture
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximum_amount_capturable | JSON | Required within parent | |
maximum_amount_capturable (anyOf 1) | integer | Alternative | The maximum amount that can be captured. |
maximum_amount_capturable (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
status | string | Required within parent | Indicates whether or not the authorized amount can be over-captured. Known values: available, unavailable |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_authorized | JSON | Optional | |
amount_authorized (anyOf 1) | JSON | Alternative | |
amount_authorized (anyOf 1) (anyOf 1) | integer | Alternative | The authorized amount |
amount_authorized (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_authorized (anyOf 2) | null | Alternative | |
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 | |
capture_before | JSON | Optional | |
capture_before (anyOf 1) | integer | Alternative | When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. Format: unix-time |
capture_before (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 | |
emv_auth_data | JSON | Optional | |
emv_auth_data (anyOf 1) | string | Alternative | Authorization response cryptogram. Maximum length: 5000 |
emv_auth_data (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 | |
generated_card | JSON | Optional | |
generated_card (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
generated_card (anyOf 2) | null | Alternative | |
incremental_authorization_supported | boolean | Required within parent | Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). |
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 | |
location | string | Optional | ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. Maximum length: 5000 |
network | JSON | Optional | |
network (anyOf 1) | string | Alternative | 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`. Maximum length: 5000 |
network (anyOf 2) | null | Alternative | |
network_transaction_id | JSON | Optional | |
network_transaction_id (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
network_transaction_id (anyOf 2) | null | Alternative | |
offline | JSON | Optional | |
offline (anyOf 1) | JSON | Alternative | Details about payments 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 | |
overcapture_supported | boolean | Required within parent | Defines whether the authorized amount can be over-captured or not |
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 | |
reader | string | Optional | ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. Maximum length: 5000 |
receipt | JSON | Optional | |
receipt (anyOf 1) | JSON | Alternative | A collection of fields required to be displayed on receipts. Only required for EMV transactions. |
receipt (anyOf 1) (anyOf 1) | Model | Alternative | 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 / receipt / value / account_type: checking, credit, prepaid, unknown |
receipt (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 offline Details about payment methods collected offline stored at, type, 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 / receipt / value / account_type: checking, credit, prepaid, unknown
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 three d secure value authentication flow, electronic commerce indicator, exemption indicator, exemption indicator applied, result, result reason, transaction id, version
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authentication_flow | JSON | Optional | |
authentication_flow (anyOf 1) | string | Alternative | For authenticated transactions: how the customer was authenticated by the issuing bank. Known values: challenge, frictionless |
authentication_flow (anyOf 2) | null | Alternative | |
electronic_commerce_indicator | JSON | Optional | |
electronic_commerce_indicator (anyOf 1) | string | Alternative | The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed. Known values: 01, 02, 05, 06, 07 |
electronic_commerce_indicator (anyOf 2) | null | Alternative | |
exemption_indicator | JSON | Optional | |
exemption_indicator (anyOf 1) | string | Alternative | The exemption requested via 3DS and accepted by the issuer at authentication time. Known values: low_risk, none |
exemption_indicator (anyOf 2) | null | Alternative | |
exemption_indicator_applied | boolean | Optional | Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on the outcome of Stripe's internal risk assessment. |
result | JSON | Optional | |
result (anyOf 1) | string | Alternative | Indicates the outcome of 3D Secure authentication. Known values: attempt_acknowledged, authenticated, data_share_only, exempted, failed, not_supported, processing_error |
result (anyOf 2) | null | Alternative | |
result_reason | JSON | Optional | |
result_reason (anyOf 1) | string | Alternative | Additional information about why 3D Secure succeeded or failed based on the `result`. Known values: abandoned, bypassed, canceled, card_not_enrolled, network_not_supported, protocol_error, rejected |
result_reason (anyOf 2) | null | Alternative | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID (dsTransId) for this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative | |
version | JSON | Optional | |
version (anyOf 1) | string | Alternative | The version of 3D Secure that was used. Known values: 1.0.2, 2.1.0, 2.2.0, 2.3.0, 2.3.1 |
version (anyOf 2) | null | Alternative |
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 wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout
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 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 wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout link
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 wallet value amex express checkout, apple pay, dynamic last4, google pay, link, masterpass, samsung pay, type, visa checkout link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
funding_source_group | JSON | Optional | |
funding_source_group (anyOf 1) | string | Alternative | The [funding source group code](https://docs.stripe.com/payments/link/link-payment-methods) applied to this Link payment at confirmation time. Maximum length: 5000 |
funding_source_group (anyOf 2) | null | Alternative |
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 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 | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | A unique and immutable identifier of payments assigned by Cash App Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 crypto
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buyer_address | string | Optional | The wallet address of the customer. Maximum length: 5000 |
network | string | Optional | The blockchain network that the transaction was sent on. Known values: base, ethereum, polygon, solana, sui, tempo |
token_currency | string | Optional | The token currency that the transaction was sent with. Known values: phantom_cash, usdc, usdg, usdp, usdsui, usdt |
transaction_hash | string | Optional | The blockchain transaction hash of the crypto payment. Maximum length: 5000 |
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 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 | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
verified_name (anyOf 2) | null | Alternative |
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 fpx
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | string | Required within parent | The customer's bank. 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 |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | Unique transaction id generated by FPX for every request from the merchant Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 giropay
| 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 | |
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 | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | Bank Identifier Code of the bank associated with the bank account. Maximum length: 5000 |
bic (anyOf 2) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
verified_name (anyOf 2) | null | Alternative |
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 grabpay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | Unique transaction id generated by GrabPay Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 ideal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | JSON | Optional | |
bank (anyOf 1) | string | Alternative | 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`. 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. 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 | |
generated_sepa_debit | JSON | Optional | |
generated_sepa_debit (anyOf 1) | JSON | Alternative | The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. |
generated_sepa_debit (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
generated_sepa_debit (anyOf 2) | null | Alternative | |
generated_sepa_debit_mandate | JSON | Optional | |
generated_sepa_debit_mandate (anyOf 1) | JSON | Alternative | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. |
generated_sepa_debit_mandate (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit_mandate (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
generated_sepa_debit_mandate (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | Last four characters of the IBAN. Maximum length: 5000 |
iban_last4 (anyOf 2) | null | Alternative | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | Unique transaction ID generated by iDEAL. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
verified_name (anyOf 2) | null | Alternative |
Referenced models: Retrieve a Mandate — response body, Create a Payment Method — response body
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 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 | |
emv_auth_data | JSON | Optional | |
emv_auth_data (anyOf 1) | string | Alternative | Authorization response cryptogram. Maximum length: 5000 |
emv_auth_data (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 | |
generated_card | JSON | Optional | |
generated_card (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
generated_card (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 | |
location | string | Optional | ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. Maximum length: 5000 |
network | JSON | Optional | |
network (anyOf 1) | string | Alternative | 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`. Maximum length: 5000 |
network (anyOf 2) | null | Alternative | |
network_transaction_id | JSON | Optional | |
network_transaction_id (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
network_transaction_id (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 | |
reader | string | Optional | ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. Maximum length: 5000 |
receipt | JSON | Optional | |
receipt (anyOf 1) | JSON | Alternative | A collection of fields required to be displayed on receipts. Only required for EMV transactions. |
receipt (anyOf 1) (anyOf 1) | Model | Alternative | 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 / interac_present / receipt / value / account_type: checking, savings, unknown |
receipt (anyOf 2) | null | Alternative |
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 kakao pay
| 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 | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Kakao Pay transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 klarna
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
location | string | Optional | ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. Maximum length: 5000 |
payer_details | JSON | Optional | |
payer_details (anyOf 1) | JSON | Alternative | The payer details for this transaction. |
payer_details (anyOf 1) (anyOf 1) | Model | Alternative | 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 klarna payer details The payer details for this transaction address |
payer_details (anyOf 2) | null | Alternative | |
payment_method_category | JSON | Optional | |
payment_method_category (anyOf 1) | string | Alternative | The Klarna payment method used for this transaction. Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` Maximum length: 5000 |
payment_method_category (anyOf 2) | null | Alternative | |
preferred_locale | JSON | Optional | |
preferred_locale (anyOf 1) | string | Alternative | Preferred language of the Klarna authorization page that the customer is redirected to. Can 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` Maximum length: 5000 |
preferred_locale (anyOf 2) | null | Alternative | |
reader | string | Optional | ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. Maximum length: 5000 |
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 klarna payer details The payer details for this transaction address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | The payer's address |
address (anyOf 1) (anyOf 1) | Model | Alternative | 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 klarna payer details The payer details for this transaction address address The payer's address country |
address (anyOf 2) | null | Alternative |
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 klarna payer details The payer details for this transaction address address The payer's address country
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The payer address country Maximum length: 5000 |
country (anyOf 2) | null | Alternative |
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 konbini
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
store | JSON | Optional | |
store (anyOf 1) | JSON | Alternative | If the payment succeeded, this contains the details of the convenience store where the payment was completed. |
store (anyOf 1) (anyOf 1) | Model | Alternative | 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 konbini store value chain |
store (anyOf 2) | null | Alternative |
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 konbini store value chain
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
chain | JSON | Optional | |
chain (anyOf 1) | string | Alternative | The name of the convenience store chain where the payment was completed. Known values: familymart, lawson, ministop, seicomart |
chain (anyOf 2) | null | Alternative |
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 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 | |
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 | |
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 | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Korean Card transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter ISO code representing the funding source country beneath the Link payment. You could use this attribute to get a sense of international fees. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
funding_source_group | string | Optional | The [funding source group code](https://docs.stripe.com/payments/link/link-payment-methods) applied to this Link payment at confirmation time. Maximum length: 5000 |
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 mobilepay
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 mobilepay card Internal card details brand, country, exp month, exp year, last4
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | Brand of the card used in the transaction Maximum length: 5000 |
brand (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter ISO code representing the country of the card Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
exp_month | JSON | Optional | |
exp_month (anyOf 1) | JSON | Alternative | |
exp_month (anyOf 1) (anyOf 1) | integer | Alternative | Two digit number representing the card's expiration month |
exp_month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_month (anyOf 2) | null | Alternative | |
exp_year | JSON | Optional | |
exp_year (anyOf 1) | JSON | Alternative | |
exp_year (anyOf 1) (anyOf 1) | integer | Alternative | Two digit number representing the card's expiration year |
exp_year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | The last 4 digits of the card Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative |
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 multibanco
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity | JSON | Optional | |
entity (anyOf 1) | string | Alternative | Entity number associated with this Multibanco payment. Maximum length: 5000 |
entity (anyOf 2) | null | Alternative | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | Reference number associated with this Multibanco payment. Maximum length: 5000 |
reference (anyOf 2) | null | Alternative |
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 naver pay
| 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 | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Naver Pay transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 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 |
expected_debit_date | string | Optional | Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. 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 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 oxxo
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | OXXO reference number Maximum length: 5000 |
number (anyOf 2) | null | Alternative |
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 p24
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | JSON | Optional | |
bank (anyOf 1) | string | Alternative | 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`. 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 | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | Unique reference for this Przelewy24 payment. Maximum length: 5000 |
reference (anyOf 2) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | Owner's verified full name. Values are verified or provided by Przelewy24 directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Przelewy24 rarely provides this information so the attribute is usually empty. Maximum length: 5000 |
verified_name (anyOf 2) | null | Alternative |
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 payco
| 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 | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Payco transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 paynow
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
location | string | Optional | ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. Maximum length: 5000 |
reader | string | Optional | ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. Maximum length: 5000 |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | Reference number associated with this PayNow payment Maximum length: 5000 |
reference (anyOf 2) | null | Alternative |
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 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 | |
payer_name | JSON | Optional | |
payer_name (anyOf 1) | string | Alternative | Owner's full name. Values provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
payer_name (anyOf 2) | null | Alternative | |
seller_protection | JSON | Optional | |
seller_protection (anyOf 1) | JSON | Alternative | The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction. |
seller_protection (anyOf 1) (anyOf 1) | Model | Alternative | 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 / paypal / seller_protection / value / status: eligible, not eligible, partially eligible |
seller_protection (anyOf 2) | null | Alternative | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | A unique ID generated by PayPal for this transaction. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 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 | |
mandate | string | Optional | ID of the mandate used to make this payment. Maximum length: 5000 |
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 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 pix
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_transaction_id | JSON | Optional | |
bank_transaction_id (anyOf 1) | string | Alternative | Unique transaction id generated by BCB Maximum length: 5000 |
bank_transaction_id (anyOf 2) | null | Alternative | |
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 | |
mandate | string | Optional | ID of the multi use Mandate generated by the PaymentIntent or SetupIntent. Maximum length: 5000 |
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 promptpay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | Bill reference generated by PromptPay Maximum length: 5000 |
reference (anyOf 2) | null | Alternative |
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 revolut pay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
funding | 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 amazon pay funding |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Revolut Pay transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 samsung pay
| 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 | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Samsung Pay transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 satispay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Satispay transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 scalapay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Scalapay transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 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 | |
expected_debit_date | string | Optional | Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Maximum length: 5000 |
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 characters of the IBAN. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
mandate | JSON | Optional | |
mandate (anyOf 1) | string | Alternative | Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve). Maximum length: 5000 |
mandate (anyOf 2) | null | Alternative |
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 sequra
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The SeQura transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 sofort
| 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 | |
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 | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | Bank Identifier Code of the bank associated with the bank account. Maximum length: 5000 |
bic (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 | |
generated_sepa_debit | JSON | Optional | |
generated_sepa_debit (anyOf 1) | JSON | Alternative | The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. |
generated_sepa_debit (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
generated_sepa_debit (anyOf 2) | null | Alternative | |
generated_sepa_debit_mandate | JSON | Optional | |
generated_sepa_debit_mandate (anyOf 1) | JSON | Alternative | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. |
generated_sepa_debit_mandate (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit_mandate (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
generated_sepa_debit_mandate (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | Last four characters of the IBAN. Maximum length: 5000 |
iban_last4 (anyOf 2) | null | Alternative | |
preferred_language | JSON | Optional | |
preferred_language (anyOf 1) | string | Alternative | Preferred language of the SOFORT authorization page that the customer is redirected to. Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl` Known values: de, en, es, fr, it, nl, pl |
preferred_language (anyOf 2) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | Owner's verified full name. Values are verified or provided by SOFORT directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
verified_name (anyOf 2) | null | Alternative |
Referenced models: Retrieve a Mandate — response body, Create a Payment Method — response body
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 sunbit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Sunbit transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 swish
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
payment_reference | JSON | Optional | |
payment_reference (anyOf 1) | string | Alternative | Payer bank reference number for the payment Maximum length: 5000 |
payment_reference (anyOf 2) | null | Alternative | |
verified_phone_last4 | JSON | Optional | |
verified_phone_last4 (anyOf 1) | string | Alternative | The last four digits of the Swish account phone number Maximum length: 5000 |
verified_phone_last4 (anyOf 2) | null | Alternative |
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 twint
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate | string | Optional | ID of the multi use Mandate generated by the PaymentIntent or SetupIntent. Maximum length: 5000 |
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 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 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 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 | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
expected_debit_date | string | Optional | Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Maximum length: 5000 |
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 | |
mandate | JSON | Optional | ID of the mandate used to make this payment. |
mandate (anyOf 1) | string | Alternative | Maximum length: 5000 |
mandate (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
payment_reference | JSON | Optional | |
payment_reference (anyOf 1) | string | Alternative | Reference number to locate ACH payments with customer's bank. Maximum length: 5000 |
payment_reference (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 |
Referenced models: Retrieve a Mandate — response body
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 wechat pay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
location | string | Optional | ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. Maximum length: 5000 |
reader | string | Optional | ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. Maximum length: 5000 |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | Transaction ID of this particular WeChat Pay transaction. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
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 / receipt / value / account_type: checking, credit, prepaid, unknown
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_type | string | Optional | The type of account being debited or credited Known values: checking, credit, prepaid, unknown |
application_cryptogram | JSON | Optional | |
application_cryptogram (anyOf 1) | string | Alternative | The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers. Maximum length: 5000 |
application_cryptogram (anyOf 2) | null | Alternative | |
application_preferred_name | JSON | Optional | |
application_preferred_name (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
application_preferred_name (anyOf 2) | null | Alternative | |
authorization_code | JSON | Optional | |
authorization_code (anyOf 1) | string | Alternative | Identifier for this transaction. Maximum length: 5000 |
authorization_code (anyOf 2) | null | Alternative | |
authorization_response_code | JSON | Optional | |
authorization_response_code (anyOf 1) | string | Alternative | EMV tag 8A. A code returned by the card issuer. Maximum length: 5000 |
authorization_response_code (anyOf 2) | null | Alternative | |
cardholder_verification_method | JSON | Optional | |
cardholder_verification_method (anyOf 1) | string | Alternative | 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`. Maximum length: 5000 |
cardholder_verification_method (anyOf 2) | null | Alternative | |
dedicated_file_name | JSON | Optional | |
dedicated_file_name (anyOf 1) | string | Alternative | Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84. Maximum length: 5000 |
dedicated_file_name (anyOf 2) | null | Alternative | |
terminal_verification_results | JSON | Optional | |
terminal_verification_results (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
terminal_verification_results (anyOf 2) | null | Alternative | |
transaction_status_information | JSON | Optional | |
transaction_status_information (anyOf 1) | string | Alternative | An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B. Maximum length: 5000 |
transaction_status_information (anyOf 2) | null | Alternative |
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 / interac_present / receipt / value / account_type: checking, savings, unknown
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_type | string | Optional | The type of account being debited or credited Known values: checking, savings, unknown |
application_cryptogram | JSON | Optional | |
application_cryptogram (anyOf 1) | string | Alternative | The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers. Maximum length: 5000 |
application_cryptogram (anyOf 2) | null | Alternative | |
application_preferred_name | JSON | Optional | |
application_preferred_name (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
application_preferred_name (anyOf 2) | null | Alternative | |
authorization_code | JSON | Optional | |
authorization_code (anyOf 1) | string | Alternative | Identifier for this transaction. Maximum length: 5000 |
authorization_code (anyOf 2) | null | Alternative | |
authorization_response_code | JSON | Optional | |
authorization_response_code (anyOf 1) | string | Alternative | EMV tag 8A. A code returned by the card issuer. Maximum length: 5000 |
authorization_response_code (anyOf 2) | null | Alternative | |
cardholder_verification_method | JSON | Optional | |
cardholder_verification_method (anyOf 1) | string | Alternative | 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`. Maximum length: 5000 |
cardholder_verification_method (anyOf 2) | null | Alternative | |
dedicated_file_name | JSON | Optional | |
dedicated_file_name (anyOf 1) | string | Alternative | Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84. Maximum length: 5000 |
dedicated_file_name (anyOf 2) | null | Alternative | |
terminal_verification_results | JSON | Optional | |
terminal_verification_results (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
terminal_verification_results (anyOf 2) | null | Alternative | |
transaction_status_information | JSON | Optional | |
transaction_status_information (anyOf 1) | string | Alternative | An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B. Maximum length: 5000 |
transaction_status_information (anyOf 2) | null | Alternative |
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 / paypal / seller_protection / value / status: eligible, not eligible, partially eligible
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dispute_categories | JSON | Optional | |
dispute_categories (anyOf 1) | array | Alternative | An array of conditions that are covered for the transaction, if applicable. |
dispute_categories (anyOf 1)[] | string | Each item | Known values: fraudulent, product_not_received |
dispute_categories (anyOf 2) | null | Alternative | |
status | string | Required within parent | Indicates whether the transaction is eligible for PayPal's seller protection. Known values: eligible, not_eligible, partially_eligible |
Create a charge — response body — radar options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. |
session | string | Optional | A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. Maximum length: 5000 |
Create a charge — response body — transfer data value amount, destination
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
destination | JSON | Required within parent | ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. |
destination (anyOf 1) | string | Alternative | Maximum length: 5000 |
destination (anyOf 2) | Model | Alternative | Expand Create an account — response body |
Referenced models: Create an account — response body
Post Charges Charge Dispute — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
evidence | Model | Optional | Expand Post Charges Charge Dispute — request body — body evidence |
expand | array | Optional | Specifies which fields in the response should be expanded. |
expand[] | string | Each item | Maximum length: 5000 |
metadata | JSON | Optional | 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. |
metadata (anyOf 1) | object | Alternative | Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | |
metadata (anyOf 2) | string | Alternative | One of: |
submit | boolean | Optional | Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default). |
Referenced models: Post Charges Charge Dispute — request body — body evidence