Package com.adyen.model.checkout
Class SessionResultResponse
- java.lang.Object
-
- com.adyen.model.checkout.SessionResultResponse
-
public class SessionResultResponse extends Object
SessionResultResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSessionResultResponse.StatusEnumThe status of the session.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ADDITIONAL_DATAstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_PAYMENTSstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_STATUS
-
Constructor Summary
Constructors Constructor Description SessionResultResponse()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SessionResultResponseadditionalData(Map<String,String> additionalData)Contains additional information about the payment.SessionResultResponseaddPaymentsItem(Payment paymentsItem)booleanequals(Object o)Return true if this SessionResultResponse object is equal to o.static SessionResultResponsefromJson(String jsonString)Create an instance of SessionResultResponse given an JSON stringMap<String,String>getAdditionalData()Contains additional information about the payment.Map<String,Object>getExplicitNulls()Returns a map of properties to be merged into the JSON payload as explicit null values.StringgetId()A unique identifier of the session.List<Payment>getPayments()A list of all authorised payments done for this session.StringgetReference()The unique reference that you provided in the original `/sessions` request.SessionResultResponse.StatusEnumgetStatus()The status of the session.inthashCode()SessionResultResponseid(String id)A unique identifier of the session.SessionResultResponseincludeNullValues(boolean includeNullValues)Configures whether null values are explicitly serialized in the JSON payload.booleanisIncludeNullValues()Returns whether null values are explicitly serialized in the JSON payload.SessionResultResponsepayments(List<Payment> payments)A list of all authorised payments done for this session.SessionResultResponseputAdditionalDataItem(String key, String additionalDataItem)SessionResultResponsereference(String reference)The unique reference that you provided in the original `/sessions` request.voidsetAdditionalData(Map<String,String> additionalData)Contains additional information about the payment.voidsetId(String id)A unique identifier of the session.voidsetIncludeNullValues(boolean includeNullValues)Sets whether null values should be explicitly serialized in the JSON payload.voidsetPayments(List<Payment> payments)A list of all authorised payments done for this session.voidsetReference(String reference)The unique reference that you provided in the original `/sessions` request.voidsetStatus(SessionResultResponse.StatusEnum status)The status of the session.SessionResultResponsestatus(SessionResultResponse.StatusEnum status)The status of the session.StringtoJson()Convert an instance of SessionResultResponse to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_ADDITIONAL_DATA
public static final String JSON_PROPERTY_ADDITIONAL_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENTS
public static final String JSON_PROPERTY_PAYMENTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STATUS
public static final String JSON_PROPERTY_STATUS
- See Also:
- Constant Field Values
-
-
Method Detail
-
additionalData
public SessionResultResponse additionalData(Map<String,String> additionalData)
Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.- Parameters:
additionalData- Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.- Returns:
- the current
SessionResultResponseinstance, allowing for method chaining
-
putAdditionalDataItem
public SessionResultResponse putAdditionalDataItem(String key, String additionalDataItem)
-
getAdditionalData
public Map<String,String> getAdditionalData()
Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.- Returns:
- additionalData Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.
-
setAdditionalData
public void setAdditionalData(Map<String,String> additionalData)
Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.- Parameters:
additionalData- Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**.
-
id
public SessionResultResponse id(String id)
A unique identifier of the session.- Parameters:
id- A unique identifier of the session.- Returns:
- the current
SessionResultResponseinstance, allowing for method chaining
-
getId
public String getId()
A unique identifier of the session.- Returns:
- id A unique identifier of the session.
-
setId
public void setId(String id)
A unique identifier of the session.- Parameters:
id- A unique identifier of the session.
-
payments
public SessionResultResponse payments(List<Payment> payments)
A list of all authorised payments done for this session.- Parameters:
payments- A list of all authorised payments done for this session.- Returns:
- the current
SessionResultResponseinstance, allowing for method chaining
-
addPaymentsItem
public SessionResultResponse addPaymentsItem(Payment paymentsItem)
-
getPayments
public List<Payment> getPayments()
A list of all authorised payments done for this session.- Returns:
- payments A list of all authorised payments done for this session.
-
setPayments
public void setPayments(List<Payment> payments)
A list of all authorised payments done for this session.- Parameters:
payments- A list of all authorised payments done for this session.
-
reference
public SessionResultResponse reference(String reference)
The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.- Parameters:
reference- The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.- Returns:
- the current
SessionResultResponseinstance, allowing for method chaining
-
getReference
public String getReference()
The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.- Returns:
- reference The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.
-
setReference
public void setReference(String reference)
The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.- Parameters:
reference- The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status.
-
status
public SessionResultResponse status(SessionResultResponse.StatusEnum status)
The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.- Parameters:
status- The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.- Returns:
- the current
SessionResultResponseinstance, allowing for method chaining
-
getStatus
public SessionResultResponse.StatusEnum getStatus()
The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.- Returns:
- status The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.
-
setStatus
public void setStatus(SessionResultResponse.StatusEnum status)
The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.- Parameters:
status- The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.
-
includeNullValues
public SessionResultResponse includeNullValues(boolean includeNullValues)
Configures whether null values are explicitly serialized in the JSON payload. Default is false.
-
isIncludeNullValues
public boolean isIncludeNullValues()
Returns whether null values are explicitly serialized in the JSON payload.
-
setIncludeNullValues
public void setIncludeNullValues(boolean includeNullValues)
Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
-
equals
public boolean equals(Object o)
Return true if this SessionResultResponse object is equal to o.
-
getExplicitNulls
public Map<String,Object> getExplicitNulls()
Returns a map of properties to be merged into the JSON payload as explicit null values.
-
fromJson
public static SessionResultResponse fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of SessionResultResponse given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of SessionResultResponse
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to SessionResultResponse
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of SessionResultResponse to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-