Authorization (stripe-java 10.0.2 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.issuing.Authorization

All Implemented Interfaces:: BalanceTransactionSource, HasId, MetadataStore<Authorization>

public class Authorization
extends ApiResource
implements BalanceTransactionSource, MetadataStore<Authorization>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Authorization.RequestHistory

static class Authorization.VerificationData
- Nested classes/interfaces inherited from class com.stripe.net.ApiResource
  ApiResource.RequestMethod, ApiResource.RequestType

Nested Classes
Modifier and Type	Class and Description
`static class`	`Authorization.RequestHistory`
`static class`	`Authorization.VerificationData`

Field Summary
- Fields inherited from class com.stripe.net.ApiResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

Authorization()

Constructors
Constructor and Description
`Authorization()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authorization`	`approve()` Approves a pending Issuing `Authorization` object.
`Authorization`	`approve(AuthorizationApproveParams params)` Approves a pending Issuing `Authorization` object.
`Authorization`	`approve(AuthorizationApproveParams params, RequestOptions options)` Approves a pending Issuing `Authorization` object.
`Authorization`	`approve(java.util.Map<java.lang.String,java.lang.Object> params)` Approves a pending Issuing `Authorization` object.
`Authorization`	`approve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Approves a pending Issuing `Authorization` object.
`Authorization`	`approve(RequestOptions options)` Approves a pending Issuing `Authorization` object.
`protected boolean`	`canEqual(java.lang.Object other)`
`Authorization`	`decline()` Declines a pending Issuing `Authorization` object.
`Authorization`	`decline(AuthorizationDeclineParams params)` Declines a pending Issuing `Authorization` object.
`Authorization`	`decline(AuthorizationDeclineParams params, RequestOptions options)` Declines a pending Issuing `Authorization` object.
`Authorization`	`decline(java.util.Map<java.lang.String,java.lang.Object> params)` Declines a pending Issuing `Authorization` object.
`Authorization`	`decline(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Declines a pending Issuing `Authorization` object.
`Authorization`	`decline(RequestOptions options)` Declines a pending Issuing `Authorization` object.
`boolean`	`equals(java.lang.Object o)`
`java.lang.Boolean`	`getApproved()` Whether the authorization has been approved.
`java.lang.String`	`getAuthorizationMethod()` How the card details were provided.
`java.lang.Long`	`getAuthorizedAmount()` The amount that has been authorized.
`java.lang.String`	`getAuthorizedCurrency()` The currency that was presented to the cardholder for the authorization.
`java.util.List<BalanceTransaction>`	`getBalanceTransactions()`
`Card`	`getCard()`
`java.lang.String`	`getCardholder()` Get id of expandable `cardholder` object.
`Cardholder`	`getCardholderObject()` Get expanded `cardholder`.
`java.lang.Long`	`getCreated()` Time at which the object was created.
`java.lang.Long`	`getHeldAmount()` The amount the authorization is expected to be in `held_currency`.
`java.lang.String`	`getHeldCurrency()` The currency of the [held amount](https://stripe.com/docs/api#issuing_authorization_object-held_amount).
`java.lang.String`	`getId()` Unique identifier for the object.
`java.lang.Boolean`	`getIsHeldAmountControllable()`
`java.lang.Boolean`	`getLivemode()` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`MerchantData`	`getMerchantData()`
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Set of key-value pairs that you can attach to an object.
`java.lang.String`	`getObject()` String representing the object's type.
`java.lang.Long`	`getPendingAuthorizedAmount()` The amount the user is requesting to be authorized.
`java.lang.Long`	`getPendingHeldAmount()` The additional amount Stripe will hold if the authorization is approved.
`java.util.List<Authorization.RequestHistory>`	`getRequestHistory()`
`java.lang.String`	`getStatus()` One of `pending`, `reversed`, or `closed`.
`java.util.List<Transaction>`	`getTransactions()`
`Authorization.VerificationData`	`getVerificationData()`
`java.lang.String`	`getWalletProvider()` What, if any, digital wallet was used for this authorization.
`int`	`hashCode()`
`static AuthorizationCollection`	`list(AuthorizationListParams params)` Returns a list of Issuing `Authorization` objects.
`static AuthorizationCollection`	`list(AuthorizationListParams params, RequestOptions options)` Returns a list of Issuing `Authorization` objects.
`static AuthorizationCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params)` Returns a list of Issuing `Authorization` objects.
`static AuthorizationCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Returns a list of Issuing `Authorization` objects.
`static Authorization`	`retrieve(java.lang.String authorization)` Retrieves an Issuing `Authorization` object.
`static Authorization`	`retrieve(java.lang.String authorization, AuthorizationRetrieveParams params, RequestOptions options)` Retrieves an Issuing `Authorization` object.
`static Authorization`	`retrieve(java.lang.String authorization, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieves an Issuing `Authorization` object.
`static Authorization`	`retrieve(java.lang.String authorization, RequestOptions options)` Retrieves an Issuing `Authorization` object.
`void`	`setApproved(java.lang.Boolean approved)` Whether the authorization has been approved.
`void`	`setAuthorizationMethod(java.lang.String authorizationMethod)` How the card details were provided.
`void`	`setAuthorizedAmount(java.lang.Long authorizedAmount)` The amount that has been authorized.
`void`	`setAuthorizedCurrency(java.lang.String authorizedCurrency)` The currency that was presented to the cardholder for the authorization.
`void`	`setBalanceTransactions(java.util.List<BalanceTransaction> balanceTransactions)`
`void`	`setCard(Card card)`
`void`	`setCardholder(java.lang.String id)`
`void`	`setCardholderObject(Cardholder expandableObject)`
`void`	`setCreated(java.lang.Long created)` Time at which the object was created.
`void`	`setHeldAmount(java.lang.Long heldAmount)` The amount the authorization is expected to be in `held_currency`.
`void`	`setHeldCurrency(java.lang.String heldCurrency)` The currency of the [held amount](https://stripe.com/docs/api#issuing_authorization_object-held_amount).
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setIsHeldAmountControllable(java.lang.Boolean isHeldAmountControllable)`
`void`	`setLivemode(java.lang.Boolean livemode)` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`void`	`setMerchantData(MerchantData merchantData)`
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Set of key-value pairs that you can attach to an object.
`void`	`setObject(java.lang.String object)` String representing the object's type.
`void`	`setPendingAuthorizedAmount(java.lang.Long pendingAuthorizedAmount)` The amount the user is requesting to be authorized.
`void`	`setPendingHeldAmount(java.lang.Long pendingHeldAmount)` The additional amount Stripe will hold if the authorization is approved.
`void`	`setRequestHistory(java.util.List<Authorization.RequestHistory> requestHistory)`
`void`	`setStatus(java.lang.String status)` One of `pending`, `reversed`, or `closed`.
`void`	`setTransactions(java.util.List<Transaction> transactions)`
`void`	`setVerificationData(Authorization.VerificationData verificationData)`
`void`	`setWalletProvider(java.lang.String walletProvider)` What, if any, digital wallet was used for this authorization.
`Authorization`	`update(AuthorizationUpdateParams params)` Updates the specified Issuing `Authorization` object by setting the values of the parameters passed.
`Authorization`	`update(AuthorizationUpdateParams params, RequestOptions options)` Updates the specified Issuing `Authorization` object by setting the values of the parameters passed.
`Authorization`	`update(java.util.Map<java.lang.String,java.lang.Object> params)` Updates the specified Issuing `Authorization` object by setting the values of the parameters passed.
`Authorization`	`update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Updates the specified Issuing `Authorization` object by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, multipartRequest, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Authorization
```
public Authorization()
```
- Method Detail
  - getCardholder
```
public java.lang.String getCardholder()
```
    Get id of expandable `cardholder` object.
  - setCardholder
```
public void setCardholder(java.lang.String id)
```
  - getCardholderObject
```
public Cardholder getCardholderObject()
```
    Get expanded `cardholder`.
  - setCardholderObject
```
public void setCardholderObject(Cardholder expandableObject)
```
  - list
```
public static AuthorizationCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                                    throws StripeException
```
    Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static AuthorizationCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                           RequestOptions options)
                                    throws StripeException
```
    Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static AuthorizationCollection list(AuthorizationListParams params)
                                    throws StripeException
```
    Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static AuthorizationCollection list(AuthorizationListParams params,
                                           RequestOptions options)
                                    throws StripeException
```
    Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Authorization retrieve(java.lang.String authorization)
                              throws StripeException
```
    Retrieves an Issuing Authorization object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Authorization retrieve(java.lang.String authorization,
                                     RequestOptions options)
                              throws StripeException
```
    Retrieves an Issuing Authorization object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Authorization retrieve(java.lang.String authorization,
                                     java.util.Map<java.lang.String,java.lang.Object> params,
                                     RequestOptions options)
                              throws StripeException
```
    Retrieves an Issuing Authorization object.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Authorization retrieve(java.lang.String authorization,
                                     AuthorizationRetrieveParams params,
                                     RequestOptions options)
                              throws StripeException
```
    Retrieves an Issuing Authorization object.
    
    Throws:
    
    StripeException
  - update
```
public Authorization update(java.util.Map<java.lang.String,java.lang.Object> params)
                     throws StripeException
```
    Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
    
    Specified by:
    
    update in interface MetadataStore<Authorization>
    
    Throws:
    
    StripeException
  - update
```
public Authorization update(java.util.Map<java.lang.String,java.lang.Object> params,
                            RequestOptions options)
                     throws StripeException
```
    Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
    
    Specified by:
    
    update in interface MetadataStore<Authorization>
    
    Throws:
    
    StripeException
  - update
```
public Authorization update(AuthorizationUpdateParams params)
                     throws StripeException
```
    Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
    
    Throws:
    
    StripeException
  - update
```
public Authorization update(AuthorizationUpdateParams params,
                            RequestOptions options)
                     throws StripeException
```
    Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
    
    Throws:
    
    StripeException
  - approve
```
public Authorization approve()
                      throws StripeException
```
    Approves a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - approve
```
public Authorization approve(RequestOptions options)
                      throws StripeException
```
    Approves a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - approve
```
public Authorization approve(java.util.Map<java.lang.String,java.lang.Object> params)
                      throws StripeException
```
    Approves a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - approve
```
public Authorization approve(java.util.Map<java.lang.String,java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException
```
    Approves a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - approve
```
public Authorization approve(AuthorizationApproveParams params)
                      throws StripeException
```
    Approves a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - approve
```
public Authorization approve(AuthorizationApproveParams params,
                             RequestOptions options)
                      throws StripeException
```
    Approves a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - decline
```
public Authorization decline()
                      throws StripeException
```
    Declines a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - decline
```
public Authorization decline(RequestOptions options)
                      throws StripeException
```
    Declines a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - decline
```
public Authorization decline(java.util.Map<java.lang.String,java.lang.Object> params)
                      throws StripeException
```
    Declines a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - decline
```
public Authorization decline(java.util.Map<java.lang.String,java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException
```
    Declines a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - decline
```
public Authorization decline(AuthorizationDeclineParams params)
                      throws StripeException
```
    Declines a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - decline
```
public Authorization decline(AuthorizationDeclineParams params,
                             RequestOptions options)
                      throws StripeException
```
    Declines a pending Issuing Authorization object.
    
    Throws:
    
    StripeException
  - getApproved
```
public java.lang.Boolean getApproved()
```
    Whether the authorization has been approved.
  - getAuthorizationMethod
```
public java.lang.String getAuthorizationMethod()
```
    How the card details were provided. One of `keyed_in`, `swipe`, `chip`, `contactless`, or `online`.
  - getAuthorizedAmount
```
public java.lang.Long getAuthorizedAmount()
```
    The amount that has been authorized. This will be `0` when the object is created, and increase after it has been approved.
  - getAuthorizedCurrency
```
public java.lang.String getAuthorizedCurrency()
```
    The currency that was presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
  - getBalanceTransactions
```
public java.util.List<BalanceTransaction> getBalanceTransactions()
```
  - getCard
```
public Card getCard()
```
  - getCreated
```
public java.lang.Long getCreated()
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - getHeldAmount
```
public java.lang.Long getHeldAmount()
```
    The amount the authorization is expected to be in `held_currency`. When Stripe holds funds from you, this is the amount reserved for the authorization. This will be `0` when the object is created, and increase after it has been approved. For multi-currency transactions, `held_amount` can be used to determine the expected exchange rate.
  - getHeldCurrency
```
public java.lang.String getHeldCurrency()
```
    The currency of the [held amount](https://stripe.com/docs/api#issuing_authorization_object-held_amount). This will always be the card currency.
  - getIsHeldAmountControllable
```
public java.lang.Boolean getIsHeldAmountControllable()
```
  - getLivemode
```
public java.lang.Boolean getLivemode()
```
    Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
  - getMerchantData
```
public MerchantData getMerchantData()
```
  - getObject
```
public java.lang.String getObject()
```
    String representing the object's type. Objects of the same type share the same value.
  - getPendingAuthorizedAmount
```
public java.lang.Long getPendingAuthorizedAmount()
```
    The amount the user is requesting to be authorized. This field will only be non-zero during an `issuing.authorization.request` webhook.
  - getPendingHeldAmount
```
public java.lang.Long getPendingHeldAmount()
```
    The additional amount Stripe will hold if the authorization is approved. This field will only be non-zero during an `issuing.authorization.request` webhook.
  - getRequestHistory
```
public java.util.List<Authorization.RequestHistory> getRequestHistory()
```
  - getStatus
```
public java.lang.String getStatus()
```
    One of `pending`, `reversed`, or `closed`.
  - getTransactions
```
public java.util.List<Transaction> getTransactions()
```
  - getVerificationData
```
public Authorization.VerificationData getVerificationData()
```
  - getWalletProvider
```
public java.lang.String getWalletProvider()
```
    What, if any, digital wallet was used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`.
  - setApproved
```
public void setApproved(java.lang.Boolean approved)
```
    Whether the authorization has been approved.
  - setAuthorizationMethod
```
public void setAuthorizationMethod(java.lang.String authorizationMethod)
```
    How the card details were provided. One of `keyed_in`, `swipe`, `chip`, `contactless`, or `online`.
  - setAuthorizedAmount
```
public void setAuthorizedAmount(java.lang.Long authorizedAmount)
```
    The amount that has been authorized. This will be `0` when the object is created, and increase after it has been approved.
  - setAuthorizedCurrency
```
public void setAuthorizedCurrency(java.lang.String authorizedCurrency)
```
    The currency that was presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
  - setBalanceTransactions
```
public void setBalanceTransactions(java.util.List<BalanceTransaction> balanceTransactions)
```
  - setCard
```
public void setCard(Card card)
```
  - setCreated
```
public void setCreated(java.lang.Long created)
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - setHeldAmount
```
public void setHeldAmount(java.lang.Long heldAmount)
```
    The amount the authorization is expected to be in `held_currency`. When Stripe holds funds from you, this is the amount reserved for the authorization. This will be `0` when the object is created, and increase after it has been approved. For multi-currency transactions, `held_amount` can be used to determine the expected exchange rate.
  - setHeldCurrency
```
public void setHeldCurrency(java.lang.String heldCurrency)
```
    The currency of the [held amount](https://stripe.com/docs/api#issuing_authorization_object-held_amount). This will always be the card currency.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier for the object.
  - setIsHeldAmountControllable
```
public void setIsHeldAmountControllable(java.lang.Boolean isHeldAmountControllable)
```
  - setLivemode
```
public void setLivemode(java.lang.Boolean livemode)
```
    Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
  - setMerchantData
```
public void setMerchantData(MerchantData merchantData)
```
  - setMetadata
```
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
```
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
  - setObject
```
public void setObject(java.lang.String object)
```
    String representing the object's type. Objects of the same type share the same value.
  - setPendingAuthorizedAmount
```
public void setPendingAuthorizedAmount(java.lang.Long pendingAuthorizedAmount)
```
    The amount the user is requesting to be authorized. This field will only be non-zero during an `issuing.authorization.request` webhook.
  - setPendingHeldAmount
```
public void setPendingHeldAmount(java.lang.Long pendingHeldAmount)
```
    The additional amount Stripe will hold if the authorization is approved. This field will only be non-zero during an `issuing.authorization.request` webhook.
  - setRequestHistory
```
public void setRequestHistory(java.util.List<Authorization.RequestHistory> requestHistory)
```
  - setStatus
```
public void setStatus(java.lang.String status)
```
    One of `pending`, `reversed`, or `closed`.
  - setTransactions
```
public void setTransactions(java.util.List<Transaction> transactions)
```
  - setVerificationData
```
public void setVerificationData(Authorization.VerificationData verificationData)
```
  - setWalletProvider
```
public void setWalletProvider(java.lang.String walletProvider)
```
    What, if any, digital wallet was used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public java.lang.String getId()
```
    Unique identifier for the object.
    
    Specified by:
    
    getId in interface HasId
  - getMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
```
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    
    Specified by:
    
    getMetadata in interface MetadataStore<Authorization>

Class Authorization

Nested Class Summary

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

Field Summary

Fields inherited from class com.stripe.net.ApiResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.ApiResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Authorization

Method Detail

getCardholder

setCardholder

getCardholderObject

setCardholderObject

list

list

list

list

retrieve

retrieve

retrieve

retrieve

update

update

update

update

approve

approve

approve

approve

approve

approve

decline

decline

decline

decline

decline

decline

getApproved

getAuthorizationMethod

getAuthorizedAmount

getAuthorizedCurrency

getBalanceTransactions

getCard

getCreated

getHeldAmount

getHeldCurrency

getIsHeldAmountControllable

getLivemode

getMerchantData

getObject

getPendingAuthorizedAmount

getPendingHeldAmount

getRequestHistory

getStatus

getTransactions

getVerificationData

getWalletProvider

setApproved

setAuthorizationMethod

setAuthorizedAmount

setAuthorizedCurrency

setBalanceTransactions

setCard

setCreated

setHeldAmount

setHeldCurrency

setId

setIsHeldAmountControllable

setLivemode

setMerchantData

setMetadata

setObject

setPendingAuthorizedAmount

setPendingHeldAmount

setRequestHistory