public class Authorization extends ApiResource implements MetadataStore<Authorization>, BalanceTransactionSource
Modifier and Type | Class and Description |
---|---|
static class |
Authorization.PendingRequest |
static class |
Authorization.RequestHistory |
static class |
Authorization.ThreeDSecure
Name of the authorization control.
|
static class |
Authorization.VerificationData |
ApiResource.RequestMethod
CHARSET, GSON
PRETTY_PRINT_GSON
Constructor and Description |
---|
Authorization() |
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.Long |
getAmount()
The total amount in the card's currency that was authorized or rejected.
|
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()
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 expandable
cardholder object. |
Cardholder |
getCardholderObject()
Get expanded
cardholder . |
java.lang.Long |
getCreated()
Time at which the object was created.
|
java.lang.String |
getCurrency()
Three-letter ISO currency code,
in lowercase.
|
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.
|
java.lang.String |
getId()
Unique identifier for the object.
|
java.lang.Boolean |
getIsHeldAmountControllable()
If set
true , you may provide held_amount
to control how much to hold for the authorization. |
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. |
java.lang.Long |
getMerchantAmount()
The total amount that was authorized or rejected in the local merchant_currency.
|
java.lang.String |
getMerchantCurrency()
The currency that was presented to the cardholder for the 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.
|
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.
|
Authorization.PendingRequest |
getPendingRequest()
The pending authorization request.
|
java.util.List<Authorization.RequestHistory> |
getRequestHistory()
History of every time the authorization was approved/denied (whether approved/denied by you
directly, or by Stripe based on your authorization_controls).
|
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.
|
java.lang.String |
getWalletProvider()
[DEPRECATED] 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 |
setAmount(java.lang.Long amount)
The total amount in the card's currency that was authorized or rejected.
|
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)
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 |
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.
|
void |
setId(java.lang.String id)
Unique identifier for the object.
|
void |
setIsHeldAmountControllable(java.lang.Boolean isHeldAmountControllable)
If set
true , you may provide held_amount
to control how much to hold for the authorization. |
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 |
setMerchantAmount(java.lang.Long merchantAmount)
The total amount that was authorized or rejected in the local merchant_currency.
|
void |
setMerchantCurrency(java.lang.String merchantCurrency)
The currency that was presented to the cardholder for the authorization.
|
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 |
setPendingRequest(Authorization.PendingRequest pendingRequest)
The pending authorization request.
|
void |
setRequestHistory(java.util.List<Authorization.RequestHistory> requestHistory)
History of every time the authorization was approved/denied (whether approved/denied by you
directly, or by Stripe based on your authorization_controls).
|
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.
|
void |
setWalletProvider(java.lang.String walletProvider)
[DEPRECATED] 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. |
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getLastResponse, setLastResponse
public java.lang.String getCardholder()
cardholder
object.public void setCardholder(java.lang.String id)
public Cardholder getCardholderObject()
cardholder
.public void setCardholderObject(Cardholder expandableObject)
public static AuthorizationCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Authorization
objects. The objects are sorted in
descending order by creation date, with the most recently created object appearing first.StripeException
public static AuthorizationCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Authorization
objects. The objects are sorted in
descending order by creation date, with the most recently created object appearing first.StripeException
public static AuthorizationCollection list(AuthorizationListParams params) throws StripeException
Authorization
objects. The objects are sorted in
descending order by creation date, with the most recently created object appearing first.StripeException
public static AuthorizationCollection list(AuthorizationListParams params, RequestOptions options) throws StripeException
Authorization
objects. The objects are sorted in
descending order by creation date, with the most recently created object appearing first.StripeException
public static Authorization retrieve(java.lang.String authorization) throws StripeException
Authorization
object.StripeException
public static Authorization retrieve(java.lang.String authorization, RequestOptions options) throws StripeException
Authorization
object.StripeException
public static Authorization retrieve(java.lang.String authorization, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Authorization
object.StripeException
public static Authorization retrieve(java.lang.String authorization, AuthorizationRetrieveParams params, RequestOptions options) throws StripeException
Authorization
object.StripeException
public Authorization update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Authorization
object by setting the values of the
parameters passed. Any parameters not provided will be left unchanged.update
in interface MetadataStore<Authorization>
StripeException
public Authorization update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Authorization
object by setting the values of the
parameters passed. Any parameters not provided will be left unchanged.update
in interface MetadataStore<Authorization>
StripeException
public Authorization update(AuthorizationUpdateParams params) throws StripeException
Authorization
object by setting the values of the
parameters passed. Any parameters not provided will be left unchanged.StripeException
public Authorization update(AuthorizationUpdateParams params, RequestOptions options) throws StripeException
Authorization
object by setting the values of the
parameters passed. Any parameters not provided will be left unchanged.StripeException
public Authorization approve() throws StripeException
Authorization
object.StripeException
public Authorization approve(RequestOptions options) throws StripeException
Authorization
object.StripeException
public Authorization approve(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Authorization
object.StripeException
public Authorization approve(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Authorization
object.StripeException
public Authorization approve(AuthorizationApproveParams params) throws StripeException
Authorization
object.StripeException
public Authorization approve(AuthorizationApproveParams params, RequestOptions options) throws StripeException
Authorization
object.StripeException
public Authorization decline() throws StripeException
Authorization
object.StripeException
public Authorization decline(RequestOptions options) throws StripeException
Authorization
object.StripeException
public Authorization decline(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Authorization
object.StripeException
public Authorization decline(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Authorization
object.StripeException
public Authorization decline(AuthorizationDeclineParams params) throws StripeException
Authorization
object.StripeException
public Authorization decline(AuthorizationDeclineParams params, RequestOptions options) throws StripeException
Authorization
object.StripeException
public java.lang.Long getAmount()
public java.lang.Boolean getApproved()
public java.lang.String getAuthorizationMethod()
One of chip
, contactless
, keyed_in
, online
, or swipe
.
public java.lang.Long getAuthorizedAmount()
0
when the object is created, and
increase after it has been approved.public java.lang.String getAuthorizedCurrency()
public java.util.List<BalanceTransaction> getBalanceTransactions()
public Card getCard()
public java.lang.Long getCreated()
public java.lang.String getCurrency()
public java.lang.Long getHeldAmount()
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.public java.lang.String getHeldCurrency()
public java.lang.Boolean getIsHeldAmountControllable()
true
, you may provide held_amount
to control how much to hold for the authorization.public java.lang.Boolean getLivemode()
true
if the object exists in live mode or the value false
if the
object exists in test mode.public java.lang.Long getMerchantAmount()
public java.lang.String getMerchantCurrency()
public MerchantData getMerchantData()
public java.lang.String getObject()
Equal to issuing.authorization
.
public java.lang.Long getPendingAuthorizedAmount()
issuing.authorization.request
webhook.public java.lang.Long getPendingHeldAmount()
issuing.authorization.request
webhook.public Authorization.PendingRequest getPendingRequest()
issuing.authorization.request
webhook.public java.util.List<Authorization.RequestHistory> getRequestHistory()
public java.lang.String getStatus()
One of closed
, pending
, or reversed
.
public java.util.List<Transaction> getTransactions()
public Authorization.VerificationData getVerificationData()
public java.lang.String getWallet()
apple_pay
, google_pay
, or samsung_pay
.public java.lang.String getWalletProvider()
apple_pay
, google_pay
, or samsung_pay
.public void setAmount(java.lang.Long amount)
public void setApproved(java.lang.Boolean approved)
public void setAuthorizationMethod(java.lang.String authorizationMethod)
One of chip
, contactless
, keyed_in
, online
, or swipe
.
public void setAuthorizedAmount(java.lang.Long authorizedAmount)
0
when the object is created, and
increase after it has been approved.public void setAuthorizedCurrency(java.lang.String authorizedCurrency)
public void setBalanceTransactions(java.util.List<BalanceTransaction> balanceTransactions)
public void setCard(Card card)
public void setCreated(java.lang.Long created)
public void setCurrency(java.lang.String currency)
public void setHeldAmount(java.lang.Long heldAmount)
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.public void setHeldCurrency(java.lang.String heldCurrency)
public void setId(java.lang.String id)
public void setIsHeldAmountControllable(java.lang.Boolean isHeldAmountControllable)
true
, you may provide held_amount
to control how much to hold for the authorization.public void setLivemode(java.lang.Boolean livemode)
true
if the object exists in live mode or the value false
if the
object exists in test mode.public void setMerchantAmount(java.lang.Long merchantAmount)
public void setMerchantCurrency(java.lang.String merchantCurrency)
public void setMerchantData(MerchantData merchantData)
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
public void setObject(java.lang.String object)
Equal to issuing.authorization
.
public void setPendingAuthorizedAmount(java.lang.Long pendingAuthorizedAmount)
issuing.authorization.request
webhook.public void setPendingHeldAmount(java.lang.Long pendingHeldAmount)
issuing.authorization.request
webhook.public void setPendingRequest(Authorization.PendingRequest pendingRequest)
issuing.authorization.request
webhook.public void setRequestHistory(java.util.List<Authorization.RequestHistory> requestHistory)
public void setStatus(java.lang.String status)
One of closed
, pending
, or reversed
.
public void setTransactions(java.util.List<Transaction> transactions)
public void setVerificationData(Authorization.VerificationData verificationData)
public void setWallet(java.lang.String wallet)
apple_pay
, google_pay
, or samsung_pay
.public void setWalletProvider(java.lang.String walletProvider)
apple_pay
, google_pay
, or samsung_pay
.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected boolean canEqual(java.lang.Object other)
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getId()
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
getMetadata
in interface MetadataStore<Authorization>