Package com.stripe.param.issuing

Class AuthorizationCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.issuing.AuthorizationCreateParams

public class AuthorizationCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthorizationCreateParams.AmountDetails
static enum	AuthorizationCreateParams.AuthorizationMethod
static class	AuthorizationCreateParams.Builder
static class	AuthorizationCreateParams.MerchantData	Add all map key/value pairs to `extraParams` map.
static class	AuthorizationCreateParams.NetworkData
static class	AuthorizationCreateParams.VerificationData	Add all map key/value pairs to `extraParams` map.
static enum	AuthorizationCreateParams.Wallet

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static AuthorizationCreateParams.Builder	builder()
Long	getAmount()	Required. The total amount to attempt to authorize.
AuthorizationCreateParams.AmountDetails	getAmountDetails()	Detailed breakdown of amount components.
AuthorizationCreateParams.AuthorizationMethod	getAuthorizationMethod()	How the card details were provided.
String	getCard()	Required. Card associated with this authorization.
String	getCurrency()	The currency of the authorization.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Boolean	getIsAmountControllable()	If set true, you may provide amount to control how much to hold for the authorization.
AuthorizationCreateParams.MerchantData	getMerchantData()	Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
AuthorizationCreateParams.NetworkData	getNetworkData()	Details about the authorization, such as identifiers, set by the card network.
AuthorizationCreateParams.VerificationData	getVerificationData()	Verifications that Stripe performed on information that the cardholder provided to the merchant.
AuthorizationCreateParams.Wallet	getWallet()	The digital wallet used for this transaction.

Methods inherited from class com.stripe.net.ApiRequestParams

paramsToMap, toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static AuthorizationCreateParams.Builder builder()

getAmount

public Long getAmount()

Required. The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the smallest currency unit.

getAmountDetails

public AuthorizationCreateParams.AmountDetails getAmountDetails()

Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.

getAuthorizationMethod

public AuthorizationCreateParams.AuthorizationMethod getAuthorizationMethod()

How the card details were provided. Defaults to online.

getCard

public String getCard()

Required. Card associated with this authorization.

getCurrency

public String getCurrency()

The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public Map<String,Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getIsAmountControllable

public Boolean getIsAmountControllable()

If set true, you may provide amount to control how much to hold for the authorization.

getMerchantData

public AuthorizationCreateParams.MerchantData getMerchantData()

Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.

getNetworkData

public AuthorizationCreateParams.NetworkData getNetworkData()

Details about the authorization, such as identifiers, set by the card network.

getVerificationData

public AuthorizationCreateParams.VerificationData getVerificationData()

Verifications that Stripe performed on information that the cardholder provided to the merchant.

getWallet

public AuthorizationCreateParams.Wallet getWallet()

The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. Will populate as null when no digital wallet was utilized.