Package com.stripe.param

Class PaymentMethodCreateParams.Builder

java.lang.Object

com.stripe.param.PaymentMethodCreateParams.Builder

Enclosing class:

PaymentMethodCreateParams

public static class PaymentMethodCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaymentMethodCreateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
PaymentMethodCreateParams.Builder	addExpand(String element)	Add an element to `expand` list.
PaymentMethodCreateParams	build()	Finalize and obtain parameter instance from this builder.
PaymentMethodCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PaymentMethodCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
PaymentMethodCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PaymentMethodCreateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
PaymentMethodCreateParams.Builder	setAcssDebit(PaymentMethodCreateParams.AcssDebit acssDebit)	If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
PaymentMethodCreateParams.Builder	setAffirm(PaymentMethodCreateParams.Affirm affirm)	If this is an affirm PaymentMethod, this hash contains details about the Affirm payment method.
PaymentMethodCreateParams.Builder	setAfterpayClearpay(PaymentMethodCreateParams.AfterpayClearpay afterpayClearpay)	If this is an AfterpayClearpay PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
PaymentMethodCreateParams.Builder	setAlipay(PaymentMethodCreateParams.Alipay alipay)	If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.
PaymentMethodCreateParams.Builder	setAllowRedisplay(PaymentMethodCreateParams.AllowRedisplay allowRedisplay)	This field indicates whether this payment method can be shown again to its customer in a checkout flow.
PaymentMethodCreateParams.Builder	setAmazonPay(PaymentMethodCreateParams.AmazonPay amazonPay)	If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
PaymentMethodCreateParams.Builder	setAuBecsDebit(PaymentMethodCreateParams.AuBecsDebit auBecsDebit)	If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
PaymentMethodCreateParams.Builder	setBacsDebit(PaymentMethodCreateParams.BacsDebit bacsDebit)	If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
PaymentMethodCreateParams.Builder	setBancontact(PaymentMethodCreateParams.Bancontact bancontact)	If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.
PaymentMethodCreateParams.Builder	setBillingDetails(PaymentMethodCreateParams.BillingDetails billingDetails)	Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
PaymentMethodCreateParams.Builder	setBlik(PaymentMethodCreateParams.Blik blik)	If this is a blik PaymentMethod, this hash contains details about the BLIK payment method.
PaymentMethodCreateParams.Builder	setBoleto(PaymentMethodCreateParams.Boleto boleto)	If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
PaymentMethodCreateParams.Builder	setCard(PaymentMethodCreateParams.CardDetails card)	If this is a card PaymentMethod, this hash contains the user's card details.
PaymentMethodCreateParams.Builder	setCard(PaymentMethodCreateParams.Token card)	If this is a card PaymentMethod, this hash contains the user's card details.
PaymentMethodCreateParams.Builder	setCashapp(PaymentMethodCreateParams.Cashapp cashapp)	If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.
PaymentMethodCreateParams.Builder	setCustomer(String customer)	The Customer to whom the original PaymentMethod is attached.
PaymentMethodCreateParams.Builder	setCustomerBalance(PaymentMethodCreateParams.CustomerBalance customerBalance)	If this is a customer_balance PaymentMethod, this hash contains details about the CustomerBalance payment method.
PaymentMethodCreateParams.Builder	setEps(PaymentMethodCreateParams.Eps eps)	If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
PaymentMethodCreateParams.Builder	setFpx(PaymentMethodCreateParams.Fpx fpx)	If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
PaymentMethodCreateParams.Builder	setGiropay(PaymentMethodCreateParams.Giropay giropay)	If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.
PaymentMethodCreateParams.Builder	setGrabpay(PaymentMethodCreateParams.Grabpay grabpay)	If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.
PaymentMethodCreateParams.Builder	setIdeal(PaymentMethodCreateParams.Ideal ideal)	If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
PaymentMethodCreateParams.Builder	setInteracPresent(PaymentMethodCreateParams.InteracPresent interacPresent)	If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.
PaymentMethodCreateParams.Builder	setKlarna(PaymentMethodCreateParams.Klarna klarna)	If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
PaymentMethodCreateParams.Builder	setKonbini(PaymentMethodCreateParams.Konbini konbini)	If this is a konbini PaymentMethod, this hash contains details about the Konbini payment method.
PaymentMethodCreateParams.Builder	setLink(PaymentMethodCreateParams.Link link)	If this is an Link PaymentMethod, this hash contains details about the Link payment method.
PaymentMethodCreateParams.Builder	setMobilepay(PaymentMethodCreateParams.Mobilepay mobilepay)	If this is a mobilepay PaymentMethod, this hash contains details about the MobilePay payment method.
PaymentMethodCreateParams.Builder	setOxxo(PaymentMethodCreateParams.Oxxo oxxo)	If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.
PaymentMethodCreateParams.Builder	setP24(PaymentMethodCreateParams.P24 p24)	If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
PaymentMethodCreateParams.Builder	setPaymentMethod(String paymentMethod)	The PaymentMethod to share.
PaymentMethodCreateParams.Builder	setPaynow(PaymentMethodCreateParams.Paynow paynow)	If this is a paynow PaymentMethod, this hash contains details about the PayNow payment method.
PaymentMethodCreateParams.Builder	setPaypal(PaymentMethodCreateParams.Paypal paypal)	If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.
PaymentMethodCreateParams.Builder	setPix(PaymentMethodCreateParams.Pix pix)	If this is a pix PaymentMethod, this hash contains details about the Pix payment method.
PaymentMethodCreateParams.Builder	setPromptpay(PaymentMethodCreateParams.Promptpay promptpay)	If this is a promptpay PaymentMethod, this hash contains details about the PromptPay payment method.
PaymentMethodCreateParams.Builder	setRadarOptions(PaymentMethodCreateParams.RadarOptions radarOptions)	Options to configure Radar.
PaymentMethodCreateParams.Builder	setRevolutPay(PaymentMethodCreateParams.RevolutPay revolutPay)	If this is a Revolut Pay PaymentMethod, this hash contains details about the Revolut Pay payment method.
PaymentMethodCreateParams.Builder	setSepaDebit(PaymentMethodCreateParams.SepaDebit sepaDebit)	If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
PaymentMethodCreateParams.Builder	setSofort(PaymentMethodCreateParams.Sofort sofort)	If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
PaymentMethodCreateParams.Builder	setSwish(PaymentMethodCreateParams.Swish swish)	If this is a swish PaymentMethod, this hash contains details about the Swish payment method.
PaymentMethodCreateParams.Builder	setType(PaymentMethodCreateParams.Type type)	The type of the PaymentMethod.
PaymentMethodCreateParams.Builder	setUsBankAccount(PaymentMethodCreateParams.UsBankAccount usBankAccount)	If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.
PaymentMethodCreateParams.Builder	setWechatPay(PaymentMethodCreateParams.WechatPay wechatPay)	If this is an wechat_pay PaymentMethod, this hash contains details about the wechat_pay payment method.
PaymentMethodCreateParams.Builder	setZip(PaymentMethodCreateParams.Zip zip)	If this is a zip PaymentMethod, this hash contains details about the Zip payment method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public PaymentMethodCreateParams build()

Finalize and obtain parameter instance from this builder.

setAcssDebit

public PaymentMethodCreateParams.Builder setAcssDebit(PaymentMethodCreateParams.AcssDebit acssDebit)

If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.

setAffirm

public PaymentMethodCreateParams.Builder setAffirm(PaymentMethodCreateParams.Affirm affirm)

If this is an affirm PaymentMethod, this hash contains details about the Affirm payment method.

setAfterpayClearpay

public PaymentMethodCreateParams.Builder setAfterpayClearpay(PaymentMethodCreateParams.AfterpayClearpay afterpayClearpay)

If this is an AfterpayClearpay PaymentMethod, this hash contains details about the AfterpayClearpay payment method.

setAlipay

public PaymentMethodCreateParams.Builder setAlipay(PaymentMethodCreateParams.Alipay alipay)

If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.

setAllowRedisplay

public PaymentMethodCreateParams.Builder setAllowRedisplay(PaymentMethodCreateParams.AllowRedisplay allowRedisplay)

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to unspecified.

setAmazonPay

public PaymentMethodCreateParams.Builder setAmazonPay(PaymentMethodCreateParams.AmazonPay amazonPay)

If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

setAuBecsDebit

public PaymentMethodCreateParams.Builder setAuBecsDebit(PaymentMethodCreateParams.AuBecsDebit auBecsDebit)

If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.

setBacsDebit

public PaymentMethodCreateParams.Builder setBacsDebit(PaymentMethodCreateParams.BacsDebit bacsDebit)

If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

setBancontact

public PaymentMethodCreateParams.Builder setBancontact(PaymentMethodCreateParams.Bancontact bancontact)

If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.

setBillingDetails

public PaymentMethodCreateParams.Builder setBillingDetails(PaymentMethodCreateParams.BillingDetails billingDetails)

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

setBlik

public PaymentMethodCreateParams.Builder setBlik(PaymentMethodCreateParams.Blik blik)

If this is a blik PaymentMethod, this hash contains details about the BLIK payment method.

setBoleto

public PaymentMethodCreateParams.Builder setBoleto(PaymentMethodCreateParams.Boleto boleto)

If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.

setCard

public PaymentMethodCreateParams.Builder setCard(PaymentMethodCreateParams.CardDetails card)

If this is a card PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card: {token: "tok_visa"}. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Stripe.js instead of interacting with this API directly.

setCard

public PaymentMethodCreateParams.Builder setCard(PaymentMethodCreateParams.Token card)

If this is a card PaymentMethod, this hash contains the user's card details. For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card: {token: "tok_visa"}. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Stripe.js instead of interacting with this API directly.

setCashapp

public PaymentMethodCreateParams.Builder setCashapp(PaymentMethodCreateParams.Cashapp cashapp)

If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.

setCustomer

public PaymentMethodCreateParams.Builder setCustomer(String customer)

The Customer to whom the original PaymentMethod is attached.

setCustomerBalance

public PaymentMethodCreateParams.Builder setCustomerBalance(PaymentMethodCreateParams.CustomerBalance customerBalance)

If this is a customer_balance PaymentMethod, this hash contains details about the CustomerBalance payment method.

setEps

public PaymentMethodCreateParams.Builder setEps(PaymentMethodCreateParams.Eps eps)

If this is an eps PaymentMethod, this hash contains details about the EPS payment method.

addExpand

public PaymentMethodCreateParams.Builder addExpand(String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentMethodCreateParams.expand for the field documentation.

addAllExpand

public PaymentMethodCreateParams.Builder addAllExpand(List<String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PaymentMethodCreateParams.expand for the field documentation.

putExtraParam

public PaymentMethodCreateParams.Builder putExtraParam(String key,
 Object value)

Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PaymentMethodCreateParams.extraParams for the field documentation.

putAllExtraParam

public PaymentMethodCreateParams.Builder putAllExtraParam(Map<String,Object> map)

Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PaymentMethodCreateParams.extraParams for the field documentation.

setFpx

public PaymentMethodCreateParams.Builder setFpx(PaymentMethodCreateParams.Fpx fpx)

If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.

setGiropay

public PaymentMethodCreateParams.Builder setGiropay(PaymentMethodCreateParams.Giropay giropay)

If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.

setGrabpay

public PaymentMethodCreateParams.Builder setGrabpay(PaymentMethodCreateParams.Grabpay grabpay)

If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.

setIdeal

public PaymentMethodCreateParams.Builder setIdeal(PaymentMethodCreateParams.Ideal ideal)

If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.

setInteracPresent

public PaymentMethodCreateParams.Builder setInteracPresent(PaymentMethodCreateParams.InteracPresent interacPresent)

If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.

setKlarna

public PaymentMethodCreateParams.Builder setKlarna(PaymentMethodCreateParams.Klarna klarna)

If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.

setKonbini

public PaymentMethodCreateParams.Builder setKonbini(PaymentMethodCreateParams.Konbini konbini)

If this is a konbini PaymentMethod, this hash contains details about the Konbini payment method.

setLink

public PaymentMethodCreateParams.Builder setLink(PaymentMethodCreateParams.Link link)

If this is an Link PaymentMethod, this hash contains details about the Link payment method.

putMetadata

public PaymentMethodCreateParams.Builder putMetadata(String key,
 String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PaymentMethodCreateParams.metadata for the field documentation.

putAllMetadata

public PaymentMethodCreateParams.Builder putAllMetadata(Map<String,String> map)

Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PaymentMethodCreateParams.metadata for the field documentation.

setMobilepay

public PaymentMethodCreateParams.Builder setMobilepay(PaymentMethodCreateParams.Mobilepay mobilepay)

If this is a mobilepay PaymentMethod, this hash contains details about the MobilePay payment method.

setOxxo

public PaymentMethodCreateParams.Builder setOxxo(PaymentMethodCreateParams.Oxxo oxxo)

If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.

setP24

public PaymentMethodCreateParams.Builder setP24(PaymentMethodCreateParams.P24 p24)

If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.

setPaymentMethod

public PaymentMethodCreateParams.Builder setPaymentMethod(String paymentMethod)

The PaymentMethod to share.

setPaynow

public PaymentMethodCreateParams.Builder setPaynow(PaymentMethodCreateParams.Paynow paynow)

If this is a paynow PaymentMethod, this hash contains details about the PayNow payment method.

setPaypal

public PaymentMethodCreateParams.Builder setPaypal(PaymentMethodCreateParams.Paypal paypal)

If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.

setPix

public PaymentMethodCreateParams.Builder setPix(PaymentMethodCreateParams.Pix pix)

If this is a pix PaymentMethod, this hash contains details about the Pix payment method.

setPromptpay

public PaymentMethodCreateParams.Builder setPromptpay(PaymentMethodCreateParams.Promptpay promptpay)

If this is a promptpay PaymentMethod, this hash contains details about the PromptPay payment method.

setRadarOptions

public PaymentMethodCreateParams.Builder setRadarOptions(PaymentMethodCreateParams.RadarOptions radarOptions)

Options to configure Radar. See Radar Session for more information.

setRevolutPay

public PaymentMethodCreateParams.Builder setRevolutPay(PaymentMethodCreateParams.RevolutPay revolutPay)

If this is a Revolut Pay PaymentMethod, this hash contains details about the Revolut Pay payment method.

setSepaDebit

public PaymentMethodCreateParams.Builder setSepaDebit(PaymentMethodCreateParams.SepaDebit sepaDebit)

If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.

setSofort

public PaymentMethodCreateParams.Builder setSofort(PaymentMethodCreateParams.Sofort sofort)

If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.

setSwish

public PaymentMethodCreateParams.Builder setSwish(PaymentMethodCreateParams.Swish swish)

If this is a swish PaymentMethod, this hash contains details about the Swish payment method.

setType

public PaymentMethodCreateParams.Builder setType(PaymentMethodCreateParams.Type type)

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

setUsBankAccount

public PaymentMethodCreateParams.Builder setUsBankAccount(PaymentMethodCreateParams.UsBankAccount usBankAccount)

If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.

setWechatPay

public PaymentMethodCreateParams.Builder setWechatPay(PaymentMethodCreateParams.WechatPay wechatPay)

If this is an wechat_pay PaymentMethod, this hash contains details about the wechat_pay payment method.

setZip

public PaymentMethodCreateParams.Builder setZip(PaymentMethodCreateParams.Zip zip)

If this is a zip PaymentMethod, this hash contains details about the Zip payment method.