Package model

Class Authorization

java.lang.Object

model.Authorization

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class Authorization
extends Object

A charge authorization

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Authorization.CustomTypeAdapterFactory
static class	Authorization.StateEnum	The state of the `Authorization`.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_3DS_REDIRECT_URL
static String	SERIALIZED_NAME_ADDITIONAL_BUYER_CHARGES
static String	SERIALIZED_NAME_AMOUNT
static String	SERIALIZED_NAME_APPLICATION
static String	SERIALIZED_NAME_CAPTURE_AMOUNT
static String	SERIALIZED_NAME_CARD_PRESENT_DETAILS
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_CURRENCY
static String	SERIALIZED_NAME_DEVICE
static String	SERIALIZED_NAME_EXPIRES_AT
static String	SERIALIZED_NAME_FAILURE_CODE
static String	SERIALIZED_NAME_FAILURE_MESSAGE
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_IDEMPOTENCY_ID
static String	SERIALIZED_NAME_IS_VOID
static String	SERIALIZED_NAME_LINKS
static String	SERIALIZED_NAME_MERCHANT_IDENTITY
static String	SERIALIZED_NAME_MESSAGES
static String	SERIALIZED_NAME_RAW
static String	SERIALIZED_NAME_SOURCE
static String	SERIALIZED_NAME_STATE
static String	SERIALIZED_NAME_TAGS
static String	SERIALIZED_NAME_TRACE_ID
static String	SERIALIZED_NAME_TRANSFER
static String	SERIALIZED_NAME_UPDATED_AT
static String	SERIALIZED_NAME_VOID_STATE

Constructor Summary

Constructors

Constructor	Description
Authorization()

Method Summary

Modifier and Type	Method	Description
Authorization	_3dsRedirectUrl(String _3dsRedirectUrl)
Authorization	additionalBuyerCharges(AdditionalBuyerCharges additionalBuyerCharges)
Authorization	addMessagesItem(String messagesItem)
Authorization	amount(Long amount)
Authorization	application(String application)
Authorization	captureAmount(Long captureAmount)
Authorization	cardPresentDetails(CardPresentDetails cardPresentDetails)
Authorization	createdAt(OffsetDateTime createdAt)
Authorization	currency(Currency currency)
Authorization	device(String device)
boolean	equals(Object o)
Authorization	expiresAt(OffsetDateTime expiresAt)
Authorization	failureCode(String failureCode)
Authorization	failureMessage(String failureMessage)
static Authorization	fromJson(String jsonString)	Create an instance of Authorization given an JSON string
String	get3dsRedirectUrl()	The redirect URL used for 3DS transactions (if supported by the processor).
AdditionalBuyerCharges	getAdditionalBuyerCharges()	Get additionalBuyerCharges
Long	getAmount()	The total amount that will be debited in cents (e.g.
String	getApplication()	The ID of the `Application` resource the `Authorization` was created under.
Long	getCaptureAmount()	The amount of the `Authorization` you would like to capture in cents.
CardPresentDetails	getCardPresentDetails()	Get cardPresentDetails
OffsetDateTime	getCreatedAt()	Timestamp of when the object was created.
Currency	getCurrency()	Get currency
String	getDevice()	The ID of the activated device.
OffsetDateTime	getExpiresAt()	`Authorization` expiration time.
String	getFailureCode()	The code of the failure so the decline can be handled programmatically.
String	getFailureMessage()	A human-readable description of why the transaction was declined.
String	getId()	The ID of the `Authorization` resource.
String	getIdempotencyId()	A randomly generated value that'll be associated with the request.
Boolean	getIsVoid()	Details if the `Authorization` is void.
AuthorizationLinks	getLinks()	Get links
String	getMerchantIdentity()	The ID of the resource.
List<String>	getMessages()	Message field that provides additional details.
Object	getRaw()	Raw response from the processor.
String	getSource()	ID of the `Payment Instrument` where funds get debited.
Authorization.StateEnum	getState()	The state of the `Authorization`.
Map<String,String>	getTags()	Key value pair for annotating custom meta data (e.g.
String	getTraceId()	Trace ID of the `Authorization`.
String	getTransfer()	The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**.
OffsetDateTime	getUpdatedAt()	Timestamp of when the object was last updated.
String	getVoidState()	Details if the `Authorization` has been voided.
int	hashCode()
Authorization	id(String id)
Authorization	idempotencyId(String idempotencyId)
Authorization	isVoid(Boolean isVoid)
Authorization	links(AuthorizationLinks links)
Authorization	merchantIdentity(String merchantIdentity)
Authorization	messages(List<String> messages)
Authorization	putTagsItem(String key, String tagsItem)
Authorization	raw(Object raw)
void	set3dsRedirectUrl(String _3dsRedirectUrl)
void	setAdditionalBuyerCharges(AdditionalBuyerCharges additionalBuyerCharges)
void	setAmount(Long amount)
void	setApplication(String application)
void	setCaptureAmount(Long captureAmount)
void	setCardPresentDetails(CardPresentDetails cardPresentDetails)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCurrency(Currency currency)
void	setDevice(String device)
void	setExpiresAt(OffsetDateTime expiresAt)
void	setFailureCode(String failureCode)
void	setFailureMessage(String failureMessage)
void	setId(String id)
void	setIdempotencyId(String idempotencyId)
void	setIsVoid(Boolean isVoid)
void	setLinks(AuthorizationLinks links)
void	setMerchantIdentity(String merchantIdentity)
void	setMessages(List<String> messages)
void	setRaw(Object raw)
void	setSource(String source)
void	setState(Authorization.StateEnum state)
void	setTags(Map<String,String> tags)
void	setTraceId(String traceId)
void	setTransfer(String transfer)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setVoidState(String voidState)
Authorization	source(String source)
Authorization	state(Authorization.StateEnum state)
Authorization	tags(Map<String,String> tags)
String	toJson()	Convert an instance of Authorization to an JSON string
String	toString()
Authorization	traceId(String traceId)
Authorization	transfer(String transfer)
Authorization	updatedAt(OffsetDateTime updatedAt)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found
Authorization	voidState(String voidState)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_3DS_REDIRECT_URL

public static final String SERIALIZED_NAME_3DS_REDIRECT_URL

See Also:

Constant Field Values

SERIALIZED_NAME_ADDITIONAL_BUYER_CHARGES

public static final String SERIALIZED_NAME_ADDITIONAL_BUYER_CHARGES

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_APPLICATION

public static final String SERIALIZED_NAME_APPLICATION

See Also:

Constant Field Values

SERIALIZED_NAME_CARD_PRESENT_DETAILS

public static final String SERIALIZED_NAME_CARD_PRESENT_DETAILS

See Also:

Constant Field Values

SERIALIZED_NAME_CAPTURE_AMOUNT

public static final String SERIALIZED_NAME_CAPTURE_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final String SERIALIZED_NAME_CURRENCY

See Also:

Constant Field Values

SERIALIZED_NAME_DEVICE

public static final String SERIALIZED_NAME_DEVICE

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRES_AT

public static final String SERIALIZED_NAME_EXPIRES_AT

See Also:

Constant Field Values

SERIALIZED_NAME_FAILURE_CODE

public static final String SERIALIZED_NAME_FAILURE_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_FAILURE_MESSAGE

public static final String SERIALIZED_NAME_FAILURE_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_IDEMPOTENCY_ID

public static final String SERIALIZED_NAME_IDEMPOTENCY_ID

See Also:

Constant Field Values

SERIALIZED_NAME_IS_VOID

public static final String SERIALIZED_NAME_IS_VOID

See Also:

Constant Field Values

SERIALIZED_NAME_MERCHANT_IDENTITY

public static final String SERIALIZED_NAME_MERCHANT_IDENTITY

See Also:

Constant Field Values

SERIALIZED_NAME_MESSAGES

public static final String SERIALIZED_NAME_MESSAGES

See Also:

Constant Field Values

SERIALIZED_NAME_RAW

public static final String SERIALIZED_NAME_RAW

See Also:

Constant Field Values

SERIALIZED_NAME_SOURCE

public static final String SERIALIZED_NAME_SOURCE

See Also:

Constant Field Values

SERIALIZED_NAME_STATE

public static final String SERIALIZED_NAME_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:

Constant Field Values

SERIALIZED_NAME_TRACE_ID

public static final String SERIALIZED_NAME_TRACE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSFER

public static final String SERIALIZED_NAME_TRANSFER

See Also:

Constant Field Values

SERIALIZED_NAME_VOID_STATE

public static final String SERIALIZED_NAME_VOID_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_LINKS

public static final String SERIALIZED_NAME_LINKS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

Authorization

public Authorization()

Method Detail

id

public Authorization id(String id)

getId

@Nullable
public String getId()

The ID of the `Authorization` resource.

Returns:

id

setId

public void setId(String id)

createdAt

public Authorization createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp of when the object was created.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public Authorization updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp of when the object was last updated.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

_3dsRedirectUrl

public Authorization _3dsRedirectUrl(String _3dsRedirectUrl)

get3dsRedirectUrl

@Nullable
public String get3dsRedirectUrl()

The redirect URL used for 3DS transactions (if supported by the processor).

Returns:

_3dsRedirectUrl

set3dsRedirectUrl

public void set3dsRedirectUrl(String _3dsRedirectUrl)

additionalBuyerCharges

public Authorization additionalBuyerCharges(AdditionalBuyerCharges additionalBuyerCharges)

getAdditionalBuyerCharges

@Nullable
public AdditionalBuyerCharges getAdditionalBuyerCharges()

Get additionalBuyerCharges

Returns:

additionalBuyerCharges

setAdditionalBuyerCharges

public void setAdditionalBuyerCharges(AdditionalBuyerCharges additionalBuyerCharges)

amount

public Authorization amount(Long amount)

getAmount

@Nullable
public Long getAmount()

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). minimum: 0

Returns:

amount

setAmount

public void setAmount(Long amount)

application

public Authorization application(String application)

getApplication

@Nullable
public String getApplication()

The ID of the `Application` resource the `Authorization` was created under.

Returns:

application

setApplication

public void setApplication(String application)

cardPresentDetails

public Authorization cardPresentDetails(CardPresentDetails cardPresentDetails)

getCardPresentDetails

@Nullable
public CardPresentDetails getCardPresentDetails()

Get cardPresentDetails

Returns:

cardPresentDetails

setCardPresentDetails

public void setCardPresentDetails(CardPresentDetails cardPresentDetails)

captureAmount

public Authorization captureAmount(Long captureAmount)

getCaptureAmount

@Nullable
public Long getCaptureAmount()

The amount of the `Authorization` you would like to capture in cents. Must be less than or equal to the `amount` of the `Authorization`.

Returns:

captureAmount

setCaptureAmount

public void setCaptureAmount(Long captureAmount)

currency

public Authorization currency(Currency currency)

getCurrency

@Nullable
public Currency getCurrency()

Get currency

Returns:

currency

setCurrency

public void setCurrency(Currency currency)

device

public Authorization device(String device)

getDevice

@Nullable
public String getDevice()

The ID of the activated device.

Returns:

device

setDevice

public void setDevice(String device)

expiresAt

public Authorization expiresAt(OffsetDateTime expiresAt)

getExpiresAt

@Nullable
public OffsetDateTime getExpiresAt()

`Authorization` expiration time.

Returns:

expiresAt

setExpiresAt

public void setExpiresAt(OffsetDateTime expiresAt)

failureCode

public Authorization failureCode(String failureCode)

getFailureCode

@Nullable
public String getFailureCode()

The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/docs/guides/developers/errors/#failure-codes).

Returns:

failureCode

setFailureCode

public void setFailureCode(String failureCode)

failureMessage

public Authorization failureMessage(String failureMessage)

getFailureMessage

@Nullable
public String getFailureMessage()

A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.

Returns:

failureMessage

setFailureMessage

public void setFailureMessage(String failureMessage)

idempotencyId

public Authorization idempotencyId(String idempotencyId)

getIdempotencyId

@Nullable
public String getIdempotencyId()

A randomly generated value that'll be associated with the request.

Returns:

idempotencyId

setIdempotencyId

public void setIdempotencyId(String idempotencyId)

isVoid

public Authorization isVoid(Boolean isVoid)

getIsVoid

@Nullable
public Boolean getIsVoid()

Details if the `Authorization` is void.

Returns:

isVoid

setIsVoid

public void setIsVoid(Boolean isVoid)

merchantIdentity

public Authorization merchantIdentity(String merchantIdentity)

getMerchantIdentity

@Nullable
public String getMerchantIdentity()

The ID of the resource.

Returns:

merchantIdentity

setMerchantIdentity

public void setMerchantIdentity(String merchantIdentity)

messages

public Authorization messages(List<String> messages)

addMessagesItem

public Authorization addMessagesItem(String messagesItem)

getMessages

@Nullable
public List<String> getMessages()

Message field that provides additional details. This field is typically **null**.

Returns:

messages

setMessages

public void setMessages(List<String> messages)

raw

public Authorization raw(Object raw)

getRaw

@Nullable
public Object getRaw()

Raw response from the processor.

Returns:

raw

setRaw

public void setRaw(Object raw)

source

public Authorization source(String source)

getSource

@Nullable
public String getSource()

ID of the `Payment Instrument` where funds get debited.

Returns:

source

setSource

public void setSource(String source)

state

public Authorization state(Authorization.StateEnum state)

getState

@Nullable
public Authorization.StateEnum getState()

The state of the `Authorization`.

Returns:

state

setState

public void setState(Authorization.StateEnum state)

tags

public Authorization tags(Map<String,String> tags)

putTagsItem

public Authorization putTagsItem(String key,
                                 String tagsItem)

getTags

@Nullable
public Map<String,String> getTags()

Key value pair for annotating custom meta data (e.g. order numbers).

Returns:

tags

setTags

public void setTags(Map<String,String> tags)

traceId

public Authorization traceId(String traceId)

getTraceId

@Nullable
public String getTraceId()

Trace ID of the `Authorization`. The processor sends back the `trace_id` so you can track the authorization end-to-end.

Returns:

traceId

setTraceId

public void setTraceId(String traceId)

transfer

public Authorization transfer(String transfer)

getTransfer

@Nullable
public String getTransfer()

The ID of the `transfer` resource that gets created when the `Authorization` moves to **SUCCEEDED**.

Returns:

transfer

setTransfer

public void setTransfer(String transfer)

voidState

public Authorization voidState(String voidState)

getVoidState

@Nullable
public String getVoidState()

Details if the `Authorization` has been voided.

Returns:

voidState

setVoidState

public void setVoidState(String voidState)

links

public Authorization links(AuthorizationLinks links)

getLinks

@Nullable
public AuthorizationLinks getLinks()

Get links

Returns:

links

setLinks

public void setLinks(AuthorizationLinks links)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to Authorization

fromJson

public static Authorization fromJson(String jsonString)
                              throws IOException

Create an instance of Authorization given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Authorization

Throws:

IOException - if the JSON string is invalid with respect to Authorization

toJson

public String toJson()

Convert an instance of Authorization to an JSON string

Returns:

JSON string