public class AccountLinkCreateParams extends ApiRequestParams
Modifier and Type | Class and Description |
---|---|
static class |
AccountLinkCreateParams.Builder |
static class |
AccountLinkCreateParams.Collect |
static class |
AccountLinkCreateParams.Type |
ApiRequestParams.EnumParam
EXTRA_PARAMS_KEY
Modifier and Type | Method and Description |
---|---|
static AccountLinkCreateParams.Builder |
builder() |
java.lang.String |
getAccount()
The identifier of the account to create an account link for.
|
AccountLinkCreateParams.Collect |
getCollect()
Which information the platform needs to collect from the user.
|
java.util.List<java.lang.String> |
getExpand()
Specifies which fields in the response should be expanded.
|
java.util.Map<java.lang.String,java.lang.Object> |
getExtraParams()
Map of extra parameters for custom features not available in this client library.
|
java.lang.String |
getRefreshUrl()
The URL that the user will be redirected to if the account link is no longer valid.
|
java.lang.String |
getReturnUrl()
The URL that the user will be redirected to upon leaving or completing the linked flow.
|
AccountLinkCreateParams.Type |
getType()
The type of account link the user is requesting.
|
toMap
public static AccountLinkCreateParams.Builder builder()
public java.lang.String getAccount()
public AccountLinkCreateParams.Collect getCollect()
currently_due
or
eventually_due
. Default is currently_due
.public java.util.List<java.lang.String> getExpand()
public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()
@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.public java.lang.String getRefreshUrl()
refresh_url
should trigger a method on your server to create a new account link using this
API, with the same parameters, and redirect the user to the new account link.public java.lang.String getReturnUrl()
public AccountLinkCreateParams.Type getType()
account_onboarding
or account_update
.