Package com.stripe.model.issuing
Class Authorization
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.issuing.Authorization
-
- All Implemented Interfaces:
BalanceTransactionSource
,HasId
,MetadataStore<Authorization>
,StripeObjectInterface
public class Authorization extends ApiResource implements MetadataStore<Authorization>, BalanceTransactionSource
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Authorization.AmountDetails
static class
Authorization.MerchantData
static class
Authorization.PendingRequest
static class
Authorization.RequestHistory
static class
Authorization.VerificationData
-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
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 Description Authorization()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Authorization
approve()
Approves a pending IssuingAuthorization
object.Authorization
approve(RequestOptions options)
Approves a pending IssuingAuthorization
object.Authorization
approve(AuthorizationApproveParams params)
Approves a pending IssuingAuthorization
object.Authorization
approve(AuthorizationApproveParams params, RequestOptions options)
Approves a pending IssuingAuthorization
object.Authorization
approve(java.util.Map<java.lang.String,java.lang.Object> params)
Approves a pending IssuingAuthorization
object.Authorization
approve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Approves a pending IssuingAuthorization
object.protected boolean
canEqual(java.lang.Object other)
Authorization
decline()
Declines a pending IssuingAuthorization
object.Authorization
decline(RequestOptions options)
Declines a pending IssuingAuthorization
object.Authorization
decline(AuthorizationDeclineParams params)
Declines a pending IssuingAuthorization
object.Authorization
decline(AuthorizationDeclineParams params, RequestOptions options)
Declines a pending IssuingAuthorization
object.Authorization
decline(java.util.Map<java.lang.String,java.lang.Object> params)
Declines a pending IssuingAuthorization
object.Authorization
decline(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Declines a pending IssuingAuthorization
object.boolean
equals(java.lang.Object o)
java.lang.Long
getAmount()
The total amount that was authorized or rejected.Authorization.AmountDetails
getAmountDetails()
Detailed breakdown of amount components.java.lang.Boolean
getApproved()
Whether the authorization has been approved.java.lang.String
getAuthorizationMethod()
How the card details were provided.java.util.List<BalanceTransaction>
getBalanceTransactions()
List of balance transactions associated with this authorization.Card
getCard()
You can create physical or virtual cards that are issued to cardholders.java.lang.String
getCardholder()
Get ID of expandablecardholder
object.Cardholder
getCardholderObject()
Get expandedcardholder
.java.lang.Long
getCreated()
Time at which the object was created.java.lang.String
getCurrency()
Three-letter ISO currency code, in lowercase.java.lang.String
getId()
Unique identifier for the object.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.java.lang.Long
getMerchantAmount()
The total amount that was authorized or rejected.java.lang.String
getMerchantCurrency()
The currency that was presented to the cardholder for the authorization.Authorization.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.Authorization.PendingRequest
getPendingRequest()
The pending authorization request.java.util.List<Authorization.RequestHistory>
getRequestHistory()
History of every timepending_request
was approved/denied, either by you directly or by Stripe (e.g.java.lang.String
getStatus()
The current status of the authorization in its lifecycle.java.util.List<Transaction>
getTransactions()
List of transactions associated with this authorization.Authorization.VerificationData
getVerificationData()
java.lang.String
getWallet()
What, if any, digital wallet was used for this authorization.int
hashCode()
static AuthorizationCollection
list(AuthorizationListParams params)
Returns a list of IssuingAuthorization
objects.static AuthorizationCollection
list(AuthorizationListParams params, RequestOptions options)
Returns a list of IssuingAuthorization
objects.static AuthorizationCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of IssuingAuthorization
objects.static AuthorizationCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list of IssuingAuthorization
objects.static Authorization
retrieve(java.lang.String authorization)
Retrieves an IssuingAuthorization
object.static Authorization
retrieve(java.lang.String authorization, RequestOptions options)
Retrieves an IssuingAuthorization
object.static Authorization
retrieve(java.lang.String authorization, AuthorizationRetrieveParams params, RequestOptions options)
Retrieves an IssuingAuthorization
object.static Authorization
retrieve(java.lang.String authorization, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves an IssuingAuthorization
object.void
setAmount(java.lang.Long amount)
The total amount that was authorized or rejected.void
setAmountDetails(Authorization.AmountDetails amountDetails)
Detailed breakdown of amount components.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
setBalanceTransactions(java.util.List<BalanceTransaction> balanceTransactions)
List of balance transactions associated with this authorization.void
setCard(Card card)
You can create physical or virtual cards that are issued to cardholders.void
setCardholder(java.lang.String id)
void
setCardholderObject(Cardholder expandableObject)
void
setCreated(java.lang.Long created)
Time at which the object was created.void
setCurrency(java.lang.String currency)
Three-letter ISO currency code, in lowercase.void
setId(java.lang.String id)
Unique identifier for the object.void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMerchantAmount(java.lang.Long merchantAmount)
The total amount that was authorized or rejected.void
setMerchantCurrency(java.lang.String merchantCurrency)
The currency that was presented to the cardholder for the authorization.void
setMerchantData(Authorization.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
setPendingRequest(Authorization.PendingRequest pendingRequest)
The pending authorization request.void
setRequestHistory(java.util.List<Authorization.RequestHistory> requestHistory)
History of every timepending_request
was approved/denied, either by you directly or by Stripe (e.g.void
setStatus(java.lang.String status)
The current status of the authorization in its lifecycle.void
setTransactions(java.util.List<Transaction> transactions)
List of transactions associated with this authorization.void
setVerificationData(Authorization.VerificationData verificationData)
void
setWallet(java.lang.String wallet)
What, if any, digital wallet was used for this authorization.Authorization
update(AuthorizationUpdateParams params)
Updates the specified IssuingAuthorization
object by setting the values of the parameters passed.Authorization
update(AuthorizationUpdateParams params, RequestOptions options)
Updates the specified IssuingAuthorization
object by setting the values of the parameters passed.Authorization
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates the specified IssuingAuthorization
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 IssuingAuthorization
object by setting the values of the parameters passed.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.stripe.model.StripeObjectInterface
getLastResponse, setLastResponse
-
-
-
-
Method Detail
-
getCardholder
public java.lang.String getCardholder()
Get ID of expandablecardholder
object.
-
setCardholder
public void setCardholder(java.lang.String id)
-
getCardholderObject
public Cardholder getCardholderObject()
Get expandedcardholder
.
-
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 IssuingAuthorization
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 IssuingAuthorization
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 IssuingAuthorization
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 IssuingAuthorization
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 IssuingAuthorization
object.- Throws:
StripeException
-
retrieve
public static Authorization retrieve(java.lang.String authorization, RequestOptions options) throws StripeException
Retrieves an IssuingAuthorization
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 IssuingAuthorization
object.- Throws:
StripeException
-
retrieve
public static Authorization retrieve(java.lang.String authorization, AuthorizationRetrieveParams params, RequestOptions options) throws StripeException
Retrieves an IssuingAuthorization
object.- Throws:
StripeException
-
update
public Authorization update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates the specified IssuingAuthorization
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
update
in interfaceMetadataStore<Authorization>
- Throws:
StripeException
-
update
public Authorization update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates the specified IssuingAuthorization
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
update
in interfaceMetadataStore<Authorization>
- Throws:
StripeException
-
update
public Authorization update(AuthorizationUpdateParams params) throws StripeException
Updates the specified IssuingAuthorization
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 IssuingAuthorization
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 IssuingAuthorization
object. This request should be made within the timeout window of the real-time authorization flow.- Throws:
StripeException
-
approve
public Authorization approve(RequestOptions options) throws StripeException
Approves a pending IssuingAuthorization
object. This request should be made within the timeout window of the real-time authorization flow.- Throws:
StripeException
-
approve
public Authorization approve(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Approves a pending IssuingAuthorization
object. This request should be made within the timeout window of the real-time authorization flow.- Throws:
StripeException
-
approve
public Authorization approve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Approves a pending IssuingAuthorization
object. This request should be made within the timeout window of the real-time authorization flow.- Throws:
StripeException
-
approve
public Authorization approve(AuthorizationApproveParams params) throws StripeException
Approves a pending IssuingAuthorization
object. This request should be made within the timeout window of the real-time authorization flow.- Throws:
StripeException
-
approve
public Authorization approve(AuthorizationApproveParams params, RequestOptions options) throws StripeException
Approves a pending IssuingAuthorization
object. This request should be made within the timeout window of the real-time authorization flow.- Throws:
StripeException
-
decline
public Authorization decline() throws StripeException
Declines a pending IssuingAuthorization
object. This request should be made within the timeout window of the real time authorization flow.- Throws:
StripeException
-
decline
public Authorization decline(RequestOptions options) throws StripeException
Declines a pending IssuingAuthorization
object. This request should be made within the timeout window of the real time authorization flow.- Throws:
StripeException
-
decline
public Authorization decline(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Declines a pending IssuingAuthorization
object. This request should be made within the timeout window of the real time authorization flow.- Throws:
StripeException
-
decline
public Authorization decline(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Declines a pending IssuingAuthorization
object. This request should be made within the timeout window of the real time authorization flow.- Throws:
StripeException
-
decline
public Authorization decline(AuthorizationDeclineParams params) throws StripeException
Declines a pending IssuingAuthorization
object. This request should be made within the timeout window of the real time authorization flow.- Throws:
StripeException
-
decline
public Authorization decline(AuthorizationDeclineParams params, RequestOptions options) throws StripeException
Declines a pending IssuingAuthorization
object. This request should be made within the timeout window of the real time authorization flow.- Throws:
StripeException
-
getAmount
public java.lang.Long getAmount()
The total amount that was authorized or rejected. This amount is in the card's currency and in the smallest currency unit.
-
getAmountDetails
public Authorization.AmountDetails getAmountDetails()
Detailed breakdown of amount components. These amounts are denominated incurrency
and in the smallest currency unit.
-
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
chip
,contactless
,keyed_in
,online
, orswipe
.
-
getBalanceTransactions
public java.util.List<BalanceTransaction> getBalanceTransactions()
List of balance transactions associated with this authorization.
-
getCard
public Card getCard()
You can create physical or virtual cards that are issued to cardholders.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getMerchantAmount
public java.lang.Long getMerchantAmount()
The total amount that was authorized or rejected. This amount is in themerchant_currency
and in the smallest currency unit.
-
getMerchantCurrency
public java.lang.String getMerchantCurrency()
The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getMerchantData
public Authorization.MerchantData getMerchantData()
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
issuing.authorization
.
-
getPendingRequest
public Authorization.PendingRequest getPendingRequest()
The pending authorization request. This field will only be non-null during anissuing_authorization.request
webhook.
-
getRequestHistory
public java.util.List<Authorization.RequestHistory> getRequestHistory()
History of every timepending_request
was approved/denied, either by you directly or by Stripe (e.g. based on yourspending_controls
). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization.
-
getStatus
public java.lang.String getStatus()
The current status of the authorization in its lifecycle.One of
closed
,pending
, orreversed
.
-
getTransactions
public java.util.List<Transaction> getTransactions()
List of transactions associated with this authorization.
-
getVerificationData
public Authorization.VerificationData getVerificationData()
-
getWallet
public java.lang.String getWallet()
What, if any, digital wallet was used for this authorization. One ofapple_pay
,google_pay
, orsamsung_pay
.
-
setAmount
public void setAmount(java.lang.Long amount)
The total amount that was authorized or rejected. This amount is in the card's currency and in the smallest currency unit.
-
setAmountDetails
public void setAmountDetails(Authorization.AmountDetails amountDetails)
Detailed breakdown of amount components. These amounts are denominated incurrency
and in the smallest currency unit.
-
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
chip
,contactless
,keyed_in
,online
, orswipe
.
-
setBalanceTransactions
public void setBalanceTransactions(java.util.List<BalanceTransaction> balanceTransactions)
List of balance transactions associated with this authorization.
-
setCard
public void setCard(Card card)
You can create physical or virtual cards that are issued to cardholders.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setCurrency
public void setCurrency(java.lang.String currency)
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
setMerchantAmount
public void setMerchantAmount(java.lang.Long merchantAmount)
The total amount that was authorized or rejected. This amount is in themerchant_currency
and in the smallest currency unit.
-
setMerchantCurrency
public void setMerchantCurrency(java.lang.String merchantCurrency)
The currency that was presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
setMerchantData
public void setMerchantData(Authorization.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.Equal to
issuing.authorization
.
-
setPendingRequest
public void setPendingRequest(Authorization.PendingRequest pendingRequest)
The pending authorization request. This field will only be non-null during anissuing_authorization.request
webhook.
-
setRequestHistory
public void setRequestHistory(java.util.List<Authorization.RequestHistory> requestHistory)
History of every timepending_request
was approved/denied, either by you directly or by Stripe (e.g. based on yourspending_controls
). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization.
-
setStatus
public void setStatus(java.lang.String status)
The current status of the authorization in its lifecycle.One of
closed
,pending
, orreversed
.
-
setTransactions
public void setTransactions(java.util.List<Transaction> transactions)
List of transactions associated with this authorization.
-
setVerificationData
public void setVerificationData(Authorization.VerificationData verificationData)
-
setWallet
public void setWallet(java.lang.String wallet)
What, if any, digital wallet was used for this authorization. One ofapple_pay
,google_pay
, orsamsung_pay
.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
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 interfaceMetadataStore<Authorization>
-
-