Class Authorization
java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.financialconnections.Authorization
- All Implemented Interfaces:
HasId,StripeActiveObject,StripeObjectInterface
An Authorization represents the set of credentials used to connect a group of Financial
Connections Accounts.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classFor more details about AccountHolder, please refer to the API Reference.static classFor more details about StatusDetails, please refer to the API Reference.Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod -
Field Summary
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON, INTERNAL_GSONFields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanbooleanThe account holder that this authorization belongs to.getId()Unique identifier for the object.Get ID of expandableinstitutionobject.The name of the institution that this authorization belongs to.Get expandedinstitution.Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.String representing the object's type.The status of the connection to the Authorization.inthashCode()static AuthorizationRetrieves the details of an Financial ConnectionsAuthorization.static Authorizationretrieve(String authorization, RequestOptions options) Retrieves the details of an Financial ConnectionsAuthorization.static Authorizationretrieve(String authorization, AuthorizationRetrieveParams params, RequestOptions options) Retrieves the details of an Financial ConnectionsAuthorization.static AuthorizationRetrieves the details of an Financial ConnectionsAuthorization.voidsetAccountHolder(Authorization.AccountHolder accountHolder) The account holder that this authorization belongs to.voidUnique identifier for the object.voidsetInstitution(String id) voidsetInstitutionName(String institutionName) The name of the institution that this authorization belongs to.voidsetInstitutionObject(Institution expandableObject) voidsetLivemode(Boolean livemode) Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.voidString representing the object's type.voidsetResponseGetter(StripeResponseGetter responseGetter) The action (if any) to relink the inactive Authorization.voidThe status of the connection to the Authorization.voidsetStatusDetails(Authorization.StatusDetails statusDetails) Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeIdMethods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.stripe.model.StripeActiveObject
trySetResponseGetter
-
Constructor Details
-
Authorization
public Authorization()
-
-
Method Details
-
getInstitution
Get ID of expandableinstitutionobject. -
setInstitution
-
getInstitutionObject
Get expandedinstitution. -
setInstitutionObject
-
retrieve
Retrieves the details of an Financial ConnectionsAuthorization.- Throws:
StripeException
-
retrieve
public static Authorization retrieve(String authorization, RequestOptions options) throws StripeException Retrieves the details of an Financial ConnectionsAuthorization.- Throws:
StripeException
-
retrieve
public static Authorization retrieve(String authorization, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves the details of an Financial ConnectionsAuthorization.- Throws:
StripeException
-
retrieve
public static Authorization retrieve(String authorization, AuthorizationRetrieveParams params, RequestOptions options) throws StripeException Retrieves the details of an Financial ConnectionsAuthorization.- Throws:
StripeException
-
setResponseGetter
The action (if any) to relink the inactive Authorization.One of
none, orrelink_required.- Specified by:
setResponseGetterin interfaceStripeActiveObject- Overrides:
setResponseGetterin classApiResource- Parameters:
responseGetter- theStripeResponseGetterinstance to use for making further requests.
-
getAccountHolder
The account holder that this authorization belongs to. -
getInstitutionName
The name of the institution that this authorization belongs to. -
getLivemode
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode. -
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
financial_connections.authorization. -
getStatus
The status of the connection to the Authorization.One of
active,disconnected, orinactive. -
getStatusDetails
-
setAccountHolder
The account holder that this authorization belongs to. -
setId
Unique identifier for the object. -
setInstitutionName
The name of the institution that this authorization belongs to. -
setLivemode
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode. -
setObject
String representing the object's type. Objects of the same type share the same value.Equal to
financial_connections.authorization. -
setStatus
The status of the connection to the Authorization.One of
active,disconnected, orinactive. -
setStatusDetails
-
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object.
-