All Implemented Interfaces:
```
public final class CardPayment.Element.CardBalanceInquiry

                    
```
A Card Balance Inquiry object. This field will be present in the JSON response if and only if category is equal to card_balance_inquiry. Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a customer requests their balance at an ATM.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CardPayment.Element.CardBalanceInquiry.Builder`	A builder for CardBalanceInquiry.
`public final class`	`CardPayment.Element.CardBalanceInquiry.AdditionalAmounts`	Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.
`public final class`	`CardPayment.Element.CardBalanceInquiry.Currency`	The ISO 4217 code for the account's currency.
`public final class`	`CardPayment.Element.CardBalanceInquiry.NetworkDetails`	Fields specific to the `network`.
`public final class`	`CardPayment.Element.CardBalanceInquiry.NetworkIdentifiers`	Network-specific identifiers for a specific request or transaction.
`public final class`	`CardPayment.Element.CardBalanceInquiry.Type`	A constant representing the object's type. For this resource it will always be `card_balance_inquiry`.
`public final class`	`CardPayment.Element.CardBalanceInquiry.Verification`	Fields related to verification of cardholder-provided values.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	The Card Balance Inquiry identifier.
`final CardPayment.Element.CardBalanceInquiry.AdditionalAmounts`	`additionalAmounts()`	Additional amounts associated with the card authorization, such as ATM surcharges fees.
`final Long`	`balance()`	The balance amount in the minor unit of the account's currency.
`final String`	`cardPaymentId()`	The ID of the Card Payment this transaction belongs to.
`final CardPayment.Element.CardBalanceInquiry.Currency`	`currency()`	The ISO 4217 code for the account's currency.
`final Optional<String>`	`digitalWalletTokenId()`	If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
`final String`	`merchantAcceptorId()`	The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
`final String`	`merchantCategoryCode()`	The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
`final Optional<String>`	`merchantCity()`	The city the merchant resides in.
`final String`	`merchantCountry()`	The country the merchant resides in.
`final String`	`merchantDescriptor()`	The merchant descriptor of the merchant the card is transacting with.
`final Optional<String>`	`merchantPostalCode()`	The merchant's postal code.
`final Optional<String>`	`merchantState()`	The state the merchant resides in.
`final CardPayment.Element.CardBalanceInquiry.NetworkDetails`	`networkDetails()`	Fields specific to the `network`.
`final CardPayment.Element.CardBalanceInquiry.NetworkIdentifiers`	`networkIdentifiers()`	Network-specific identifiers for a specific request or transaction.
`final Optional<Long>`	`networkRiskScore()`	The risk score generated by the card network.
`final Optional<String>`	`physicalCardId()`	If the authorization was made in-person with a physical card, the Physical Card that was used.
`final Optional<String>`	`realTimeDecisionId()`	The identifier of the Real-Time Decision sent to approve or decline this transaction.
`final Optional<String>`	`terminalId()`	The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.
`final CardPayment.Element.CardBalanceInquiry.Type`	`type()`	A constant representing the object's type.
`final CardPayment.Element.CardBalanceInquiry.Verification`	`verification()`	Fields related to verification of cardholder-provided values.
`final JsonField<String>`	`_id()`	Returns the raw JSON value of id.
`final JsonField<CardPayment.Element.CardBalanceInquiry.AdditionalAmounts>`	`_additionalAmounts()`	Returns the raw JSON value of additionalAmounts.
`final JsonField<Long>`	`_balance()`	Returns the raw JSON value of balance.
`final JsonField<String>`	`_cardPaymentId()`	Returns the raw JSON value of cardPaymentId.
`final JsonField<CardPayment.Element.CardBalanceInquiry.Currency>`	`_currency()`	Returns the raw JSON value of currency.
`final JsonField<String>`	`_digitalWalletTokenId()`	Returns the raw JSON value of digitalWalletTokenId.
`final JsonField<String>`	`_merchantAcceptorId()`	Returns the raw JSON value of merchantAcceptorId.
`final JsonField<String>`	`_merchantCategoryCode()`	Returns the raw JSON value of merchantCategoryCode.
`final JsonField<String>`	`_merchantCity()`	Returns the raw JSON value of merchantCity.
`final JsonField<String>`	`_merchantCountry()`	Returns the raw JSON value of merchantCountry.
`final JsonField<String>`	`_merchantDescriptor()`	Returns the raw JSON value of merchantDescriptor.
`final JsonField<String>`	`_merchantPostalCode()`	Returns the raw JSON value of merchantPostalCode.
`final JsonField<String>`	`_merchantState()`	Returns the raw JSON value of merchantState.
`final JsonField<CardPayment.Element.CardBalanceInquiry.NetworkDetails>`	`_networkDetails()`	Returns the raw JSON value of networkDetails.
`final JsonField<CardPayment.Element.CardBalanceInquiry.NetworkIdentifiers>`	`_networkIdentifiers()`	Returns the raw JSON value of networkIdentifiers.
`final JsonField<Long>`	`_networkRiskScore()`	Returns the raw JSON value of networkRiskScore.
`final JsonField<String>`	`_physicalCardId()`	Returns the raw JSON value of physicalCardId.
`final JsonField<String>`	`_realTimeDecisionId()`	Returns the raw JSON value of realTimeDecisionId.
`final JsonField<String>`	`_terminalId()`	Returns the raw JSON value of terminalId.
`final JsonField<CardPayment.Element.CardBalanceInquiry.Type>`	`_type()`	Returns the raw JSON value of type.
`final JsonField<CardPayment.Element.CardBalanceInquiry.Verification>`	`_verification()`	Returns the raw JSON value of verification.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final CardPayment.Element.CardBalanceInquiry.Builder`	`toBuilder()`
`final CardPayment.Element.CardBalanceInquiry`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static CardPayment.Element.CardBalanceInquiry.Builder`	`builder()`	Returns a mutable builder for constructing an instance of CardBalanceInquiry.

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

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    The Card Balance Inquiry identifier.
  - additionalAmounts
```
 final CardPayment.Element.CardBalanceInquiry.AdditionalAmounts additionalAmounts()
```
    Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the amount field and are used to provide more detailed information about the transaction.
  - balance
```
 final Long balance()
```
    The balance amount in the minor unit of the account's currency. For dollars, for example, this is cents.
  - cardPaymentId
```
 final String cardPaymentId()
```
    The ID of the Card Payment this transaction belongs to.
  - currency
```
 final CardPayment.Element.CardBalanceInquiry.Currency currency()
```
    The ISO 4217 code for the account's currency.
  - digitalWalletTokenId
```
 final Optional<String> digitalWalletTokenId()
```
    If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
  - merchantAcceptorId
```
 final String merchantAcceptorId()
```
    The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
  - merchantCategoryCode
```
 final String merchantCategoryCode()
```
    The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
  - merchantCity
```
 final Optional<String> merchantCity()
```
    The city the merchant resides in.
  - merchantCountry
```
 final String merchantCountry()
```
    The country the merchant resides in.
  - merchantDescriptor
```
 final String merchantDescriptor()
```
    The merchant descriptor of the merchant the card is transacting with.
  - merchantPostalCode
```
 final Optional<String> merchantPostalCode()
```
    The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash.
  - merchantState
```
 final Optional<String> merchantState()
```
    The state the merchant resides in.
  - networkDetails
```
 final CardPayment.Element.CardBalanceInquiry.NetworkDetails networkDetails()
```
    Fields specific to the network.
  - networkIdentifiers
```
 final CardPayment.Element.CardBalanceInquiry.NetworkIdentifiers networkIdentifiers()
```
    Network-specific identifiers for a specific request or transaction.
  - networkRiskScore
```
 final Optional<Long> networkRiskScore()
```
    The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest.
  - physicalCardId
```
 final Optional<String> physicalCardId()
```
    If the authorization was made in-person with a physical card, the Physical Card that was used.
  - realTimeDecisionId
```
 final Optional<String> realTimeDecisionId()
```
    The identifier of the Real-Time Decision sent to approve or decline this transaction.
  - terminalId
```
 final Optional<String> terminalId()
```
    The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.
  - type
```
 final CardPayment.Element.CardBalanceInquiry.Type type()
```
    A constant representing the object's type. For this resource it will always be card_balance_inquiry.
  - verification
```
 final CardPayment.Element.CardBalanceInquiry.Verification verification()
```
    Fields related to verification of cardholder-provided values.
  - _id
```
 final JsonField<String> _id()
```
    Returns the raw JSON value of id.
    Unlike id, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalAmounts
```
 final JsonField<CardPayment.Element.CardBalanceInquiry.AdditionalAmounts> _additionalAmounts()
```
    Returns the raw JSON value of additionalAmounts.
    Unlike additionalAmounts, this method doesn't throw if the JSON field has an unexpected type.
  - _balance
```
 final JsonField<Long> _balance()
```
    Returns the raw JSON value of balance.
    Unlike balance, this method doesn't throw if the JSON field has an unexpected type.
  - _cardPaymentId
```
 final JsonField<String> _cardPaymentId()
```
    Returns the raw JSON value of cardPaymentId.
    Unlike cardPaymentId, this method doesn't throw if the JSON field has an unexpected type.
  - _currency
```
 final JsonField<CardPayment.Element.CardBalanceInquiry.Currency> _currency()
```
    Returns the raw JSON value of currency.
    Unlike currency, this method doesn't throw if the JSON field has an unexpected type.
  - _digitalWalletTokenId
```
 final JsonField<String> _digitalWalletTokenId()
```
    Returns the raw JSON value of digitalWalletTokenId.
    Unlike digitalWalletTokenId, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantAcceptorId
```
 final JsonField<String> _merchantAcceptorId()
```
    Returns the raw JSON value of merchantAcceptorId.
    Unlike merchantAcceptorId, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantCategoryCode
```
 final JsonField<String> _merchantCategoryCode()
```
    Returns the raw JSON value of merchantCategoryCode.
    Unlike merchantCategoryCode, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantCity
```
 final JsonField<String> _merchantCity()
```
    Returns the raw JSON value of merchantCity.
    Unlike merchantCity, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantCountry
```
 final JsonField<String> _merchantCountry()
```
    Returns the raw JSON value of merchantCountry.
    Unlike merchantCountry, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantDescriptor
```
 final JsonField<String> _merchantDescriptor()
```
    Returns the raw JSON value of merchantDescriptor.
    Unlike merchantDescriptor, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantPostalCode
```
 final JsonField<String> _merchantPostalCode()
```
    Returns the raw JSON value of merchantPostalCode.
    Unlike merchantPostalCode, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantState
```
 final JsonField<String> _merchantState()
```
    Returns the raw JSON value of merchantState.
    Unlike merchantState, this method doesn't throw if the JSON field has an unexpected type.
  - _networkDetails
```
 final JsonField<CardPayment.Element.CardBalanceInquiry.NetworkDetails> _networkDetails()
```
    Returns the raw JSON value of networkDetails.
    Unlike networkDetails, this method doesn't throw if the JSON field has an unexpected type.
  - _networkIdentifiers
```
 final JsonField<CardPayment.Element.CardBalanceInquiry.NetworkIdentifiers> _networkIdentifiers()
```
    Returns the raw JSON value of networkIdentifiers.
    Unlike networkIdentifiers, this method doesn't throw if the JSON field has an unexpected type.
  - _networkRiskScore
```
 final JsonField<Long> _networkRiskScore()
```
    Returns the raw JSON value of networkRiskScore.
    Unlike networkRiskScore, this method doesn't throw if the JSON field has an unexpected type.
  - _physicalCardId
```
 final JsonField<String> _physicalCardId()
```
    Returns the raw JSON value of physicalCardId.
    Unlike physicalCardId, this method doesn't throw if the JSON field has an unexpected type.
  - _realTimeDecisionId
```
 final JsonField<String> _realTimeDecisionId()
```
    Returns the raw JSON value of realTimeDecisionId.
    Unlike realTimeDecisionId, this method doesn't throw if the JSON field has an unexpected type.
  - _terminalId
```
 final JsonField<String> _terminalId()
```
    Returns the raw JSON value of terminalId.
    Unlike terminalId, this method doesn't throw if the JSON field has an unexpected type.
  - _type
```
 final JsonField<CardPayment.Element.CardBalanceInquiry.Type> _type()
```
    Returns the raw JSON value of type.
    Unlike type, this method doesn't throw if the JSON field has an unexpected type.
  - _verification
```
 final JsonField<CardPayment.Element.CardBalanceInquiry.Verification> _verification()
```
    Returns the raw JSON value of verification.
    Unlike verification, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final CardPayment.Element.CardBalanceInquiry.Builder toBuilder()
```
  - validate
```
 final CardPayment.Element.CardBalanceInquiry validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static CardPayment.Element.CardBalanceInquiry.Builder builder()
```
    Returns a mutable builder for constructing an instance of CardBalanceInquiry.
    The following fields are required:
    .id() .additionalAmounts() .balance() .cardPaymentId() .currency() .digitalWalletTokenId() .merchantAcceptorId() .merchantCategoryCode() .merchantCity() .merchantCountry() .merchantDescriptor() .merchantPostalCode() .merchantState() .networkDetails() .networkIdentifiers() .networkRiskScore() .physicalCardId() .realTimeDecisionId() .terminalId() .type() .verification()

Class CardPayment.Element.CardBalanceInquiry

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

additionalAmounts

balance

cardPaymentId

currency

digitalWalletTokenId

merchantAcceptorId

merchantCategoryCode

merchantCity

merchantCountry

merchantDescriptor

merchantPostalCode

merchantState

networkDetails

networkIdentifiers

networkRiskScore

physicalCardId

realTimeDecisionId

terminalId

type

verification

_id

_additionalAmounts

_balance

_cardPaymentId

_currency

_digitalWalletTokenId

_merchantAcceptorId

_merchantCategoryCode

_merchantCity

_merchantCountry

_merchantDescriptor

_merchantPostalCode

_merchantState

_networkDetails

_networkIdentifiers

_networkRiskScore

_physicalCardId

_realTimeDecisionId

_terminalId

_type

_verification

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder