java.lang.Object
- com.adyen.model.checkout.BalanceCheckResponse

public class BalanceCheckResponse
extends Object

BalanceCheckResponse

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BalanceCheckResponse.ResultCodeEnum
The result of the cancellation request.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ADDITIONAL_DATA`
`static String`	`JSON_PROPERTY_BALANCE`
`static String`	`JSON_PROPERTY_FRAUD_RESULT`
`static String`	`JSON_PROPERTY_PSP_REFERENCE`
`static String`	`JSON_PROPERTY_REFUSAL_REASON`
`static String`	`JSON_PROPERTY_RESULT_CODE`
`static String`	`JSON_PROPERTY_TRANSACTION_LIMIT`

Constructor Summary

Constructors
Constructor Description

BalanceCheckResponse()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BalanceCheckResponse`	`additionalData(Map<String,String> additionalData)`	Contains additional information about the payment.
`BalanceCheckResponse`	`balance(Amount balance)`	balance
`boolean`	`equals(Object o)`	Return true if this BalanceCheckResponse object is equal to o.
`BalanceCheckResponse`	`fraudResult(FraudResult fraudResult)`	fraudResult
`static BalanceCheckResponse`	`fromJson(String jsonString)`	Create an instance of BalanceCheckResponse given an JSON string
`Map<String,String>`	`getAdditionalData()`	Contains additional information about the payment.
`Amount`	`getBalance()`	balance
`FraudResult`	`getFraudResult()`	fraudResult
`String`	`getPspReference()`	Adyen's 16-character reference associated with the transaction/request.
`String`	`getRefusalReason()`	If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error.
`BalanceCheckResponse.ResultCodeEnum`	`getResultCode()`	The result of the cancellation request.
`Amount`	`getTransactionLimit()`	transactionLimit
`int`	`hashCode()`
`BalanceCheckResponse`	`pspReference(String pspReference)`	Adyen's 16-character reference associated with the transaction/request.
`BalanceCheckResponse`	`putAdditionalDataItem(String key, String additionalDataItem)`
`BalanceCheckResponse`	`refusalReason(String refusalReason)`	If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error.
`BalanceCheckResponse`	`resultCode(BalanceCheckResponse.ResultCodeEnum resultCode)`	The result of the cancellation request.
`void`	`setAdditionalData(Map<String,String> additionalData)`	Contains additional information about the payment.
`void`	`setBalance(Amount balance)`	balance
`void`	`setFraudResult(FraudResult fraudResult)`	fraudResult
`void`	`setPspReference(String pspReference)`	Adyen's 16-character reference associated with the transaction/request.
`void`	`setRefusalReason(String refusalReason)`	If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error.
`void`	`setResultCode(BalanceCheckResponse.ResultCodeEnum resultCode)`	The result of the cancellation request.
`void`	`setTransactionLimit(Amount transactionLimit)`	transactionLimit
`String`	`toJson()`	Convert an instance of BalanceCheckResponse to an JSON string
`String`	`toString()`
`BalanceCheckResponse`	`transactionLimit(Amount transactionLimit)`	transactionLimit

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_ADDITIONAL_DATA
```
public static final String JSON_PROPERTY_ADDITIONAL_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BALANCE
```
public static final String JSON_PROPERTY_BALANCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FRAUD_RESULT
```
public static final String JSON_PROPERTY_FRAUD_RESULT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PSP_REFERENCE
```
public static final String JSON_PROPERTY_PSP_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFUSAL_REASON
```
public static final String JSON_PROPERTY_REFUSAL_REASON
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RESULT_CODE
```
public static final String JSON_PROPERTY_RESULT_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRANSACTION_LIMIT
```
public static final String JSON_PROPERTY_TRANSACTION_LIMIT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BalanceCheckResponse
```
public BalanceCheckResponse()
```
- Method Detail
  - additionalData
```
public BalanceCheckResponse additionalData(Map<String,String> additionalData)
```
    Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.
    
    Parameters:
    
    additionalData -
    
    Returns:
    
    the current BalanceCheckResponse instance, allowing for method chaining
  - putAdditionalDataItem
```
public BalanceCheckResponse putAdditionalDataItem(String key,
                                                  String additionalDataItem)
```
  - getAdditionalData
```
public Map<String,String> getAdditionalData()
```
    Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.
    
    Returns:
    
    additionalData
  - setAdditionalData
```
public void setAdditionalData(Map<String,String> additionalData)
```
    Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.
    
    Parameters:
    
    additionalData -
  - balance
```
public BalanceCheckResponse balance(Amount balance)
```
    balance
    
    Parameters:
    
    balance -
    
    Returns:
    
    the current BalanceCheckResponse instance, allowing for method chaining
  - getBalance
```
public Amount getBalance()
```
    balance
    
    Returns:
    
    balance
  - setBalance
```
public void setBalance(Amount balance)
```
    balance
    
    Parameters:
    
    balance -
  - fraudResult
```
public BalanceCheckResponse fraudResult(FraudResult fraudResult)
```
    fraudResult
    
    Parameters:
    
    fraudResult -
    
    Returns:
    
    the current BalanceCheckResponse instance, allowing for method chaining
  - getFraudResult
```
public FraudResult getFraudResult()
```
    fraudResult
    
    Returns:
    
    fraudResult
  - setFraudResult
```
public void setFraudResult(FraudResult fraudResult)
```
    fraudResult
    
    Parameters:
    
    fraudResult -
  - pspReference
```
public BalanceCheckResponse pspReference(String pspReference)
```
    Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
    
    Parameters:
    
    pspReference -
    
    Returns:
    
    the current BalanceCheckResponse instance, allowing for method chaining
  - getPspReference
```
public String getPspReference()
```
    Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
    
    Returns:
    
    pspReference
  - setPspReference
```
public void setPspReference(String pspReference)
```
    Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
    
    Parameters:
    
    pspReference -
  - refusalReason
```
public BalanceCheckResponse refusalReason(String refusalReason)
```
    If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
    
    Parameters:
    
    refusalReason -
    
    Returns:
    
    the current BalanceCheckResponse instance, allowing for method chaining
  - getRefusalReason
```
public String getRefusalReason()
```
    If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
    
    Returns:
    
    refusalReason
  - setRefusalReason
```
public void setRefusalReason(String refusalReason)
```
    If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
    
    Parameters:
    
    refusalReason -
  - resultCode
```
public BalanceCheckResponse resultCode(BalanceCheckResponse.ResultCodeEnum resultCode)
```
    The result of the cancellation request. Possible values: * **Success** – Indicates that the balance check was successful. * **NotEnoughBalance** – Commonly indicates that the card did not have enough balance to pay the amount in the request, or that the currency of the balance on the card did not match the currency of the requested amount. * **Failed** – Indicates that the balance check failed.
    
    Parameters:
    
    resultCode -
    
    Returns:
    
    the current BalanceCheckResponse instance, allowing for method chaining
  - getResultCode
```
public BalanceCheckResponse.ResultCodeEnum getResultCode()
```
    The result of the cancellation request. Possible values: * **Success** – Indicates that the balance check was successful. * **NotEnoughBalance** – Commonly indicates that the card did not have enough balance to pay the amount in the request, or that the currency of the balance on the card did not match the currency of the requested amount. * **Failed** – Indicates that the balance check failed.
    
    Returns:
    
    resultCode
  - setResultCode
```
public void setResultCode(BalanceCheckResponse.ResultCodeEnum resultCode)
```
    The result of the cancellation request. Possible values: * **Success** – Indicates that the balance check was successful. * **NotEnoughBalance** – Commonly indicates that the card did not have enough balance to pay the amount in the request, or that the currency of the balance on the card did not match the currency of the requested amount. * **Failed** – Indicates that the balance check failed.
    
    Parameters:
    
    resultCode -
  - transactionLimit
```
public BalanceCheckResponse transactionLimit(Amount transactionLimit)
```
    transactionLimit
    
    Parameters:
    
    transactionLimit -
    
    Returns:
    
    the current BalanceCheckResponse instance, allowing for method chaining
  - getTransactionLimit
```
public Amount getTransactionLimit()
```
    transactionLimit
    
    Returns:
    
    transactionLimit
  - setTransactionLimit
```
public void setTransactionLimit(Amount transactionLimit)
```
    transactionLimit
    
    Parameters:
    
    transactionLimit -
  - equals
```
public boolean equals(Object o)
```
    Return true if this BalanceCheckResponse object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static BalanceCheckResponse fromJson(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of BalanceCheckResponse given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of BalanceCheckResponse
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to BalanceCheckResponse
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of BalanceCheckResponse to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class BalanceCheckResponse

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ADDITIONAL_DATA

JSON_PROPERTY_BALANCE

JSON_PROPERTY_FRAUD_RESULT

JSON_PROPERTY_PSP_REFERENCE

JSON_PROPERTY_REFUSAL_REASON

JSON_PROPERTY_RESULT_CODE

JSON_PROPERTY_TRANSACTION_LIMIT

Constructor Detail

BalanceCheckResponse

Method Detail

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

balance

getBalance

setBalance

fraudResult

getFraudResult

setFraudResult

pspReference

getPspReference

setPspReference

refusalReason

getRefusalReason

setRefusalReason

resultCode

getResultCode

setResultCode

transactionLimit

getTransactionLimit

setTransactionLimit

equals

hashCode

toString

fromJson

toJson