All Implemented Interfaces:: com.increase.api.core.Params


public final class CardBalanceInquiryCreateParams
 implements Params

Simulates a balance inquiry on a #cards.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CardBalanceInquiryCreateParams.Builder`	A builder for CardBalanceInquiryCreateParams.
`public final class`	`CardBalanceInquiryCreateParams.Body`
`public final class`	`CardBalanceInquiryCreateParams.DeclineReason`	Forces a card decline with a specific reason. No real time decision will be sent.
`public final class`	`CardBalanceInquiryCreateParams.NetworkDetails`	Fields specific to a given card network.

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 Optional<Long>`	`balance()`	The balance amount in cents.
`final Optional<String>`	`cardId()`	The identifier of the Card to be authorized.
`final Optional<CardBalanceInquiryCreateParams.DeclineReason>`	`declineReason()`	Forces a card decline with a specific reason.
`final Optional<String>`	`digitalWalletTokenId()`	The identifier of the Digital Wallet Token to be authorized.
`final Optional<String>`	`eventSubscriptionId()`	The identifier of the Event Subscription to use.
`final Optional<String>`	`merchantAcceptorId()`	The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
`final Optional<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 Optional<String>`	`merchantCountry()`	The country the merchant resides in.
`final Optional<String>`	`merchantDescriptor()`	The merchant descriptor of the merchant the card is transacting with.
`final Optional<String>`	`merchantState()`	The state the merchant resides in.
`final Optional<CardBalanceInquiryCreateParams.NetworkDetails>`	`networkDetails()`	Fields specific to a given card network.
`final Optional<Long>`	`networkRiskScore()`	The risk score generated by the card network.
`final Optional<String>`	`physicalCardId()`	The identifier of the Physical Card to be authorized.
`final Optional<String>`	`terminalId()`	The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.
`final JsonField<Long>`	`_balance()`	Returns the raw JSON value of balance.
`final JsonField<String>`	`_cardId()`	Returns the raw JSON value of cardId.
`final JsonField<CardBalanceInquiryCreateParams.DeclineReason>`	`_declineReason()`	Returns the raw JSON value of declineReason.
`final JsonField<String>`	`_digitalWalletTokenId()`	Returns the raw JSON value of digitalWalletTokenId.
`final JsonField<String>`	`_eventSubscriptionId()`	Returns the raw JSON value of eventSubscriptionId.
`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>`	`_merchantState()`	Returns the raw JSON value of merchantState.
`final JsonField<CardBalanceInquiryCreateParams.NetworkDetails>`	`_networkDetails()`	Returns the raw JSON value of networkDetails.
`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>`	`_terminalId()`	Returns the raw JSON value of terminalId.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final CardBalanceInquiryCreateParams.Builder`	`toBuilder()`
`final CardBalanceInquiryCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static CardBalanceInquiryCreateParams`	`none()`
`final static CardBalanceInquiryCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of CardBalanceInquiryCreateParams.

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

- Constructor Detail
- Method Detail
  - balance
```
 final Optional<Long> balance()
```
    The balance amount in cents. The account balance will be used if not provided.
  - cardId
```
 final Optional<String> cardId()
```
    The identifier of the Card to be authorized.
  - declineReason
```
 final Optional<CardBalanceInquiryCreateParams.DeclineReason> declineReason()
```
    Forces a card decline with a specific reason. No real time decision will be sent.
  - digitalWalletTokenId
```
 final Optional<String> digitalWalletTokenId()
```
    The identifier of the Digital Wallet Token to be authorized.
  - eventSubscriptionId
```
 final Optional<String> eventSubscriptionId()
```
    The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.
  - merchantAcceptorId
```
 final Optional<String> merchantAcceptorId()
```
    The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
  - merchantCategoryCode
```
 final Optional<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 Optional<String> merchantCountry()
```
    The country the merchant resides in.
  - merchantDescriptor
```
 final Optional<String> merchantDescriptor()
```
    The merchant descriptor of the merchant the card is transacting with.
  - merchantState
```
 final Optional<String> merchantState()
```
    The state the merchant resides in.
  - networkDetails
```
 final Optional<CardBalanceInquiryCreateParams.NetworkDetails> networkDetails()
```
    Fields specific to a given card network.
  - 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.
  - physicalCardId
```
 final Optional<String> physicalCardId()
```
    The identifier of the Physical Card to be authorized.
  - terminalId
```
 final Optional<String> terminalId()
```
    The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.
  - _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.
  - _cardId
```
 final JsonField<String> _cardId()
```
    Returns the raw JSON value of cardId.
    Unlike cardId, this method doesn't throw if the JSON field has an unexpected type.
  - _declineReason
```
 final JsonField<CardBalanceInquiryCreateParams.DeclineReason> _declineReason()
```
    Returns the raw JSON value of declineReason.
    Unlike declineReason, 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.
  - _eventSubscriptionId
```
 final JsonField<String> _eventSubscriptionId()
```
    Returns the raw JSON value of eventSubscriptionId.
    Unlike eventSubscriptionId, 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.
  - _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<CardBalanceInquiryCreateParams.NetworkDetails> _networkDetails()
```
    Returns the raw JSON value of networkDetails.
    Unlike networkDetails, 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.
  - _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.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final CardBalanceInquiryCreateParams.Builder toBuilder()
```
  - _body
```
 final CardBalanceInquiryCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static CardBalanceInquiryCreateParams none()
```
  - builder
```
 final static CardBalanceInquiryCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of CardBalanceInquiryCreateParams.

Class CardBalanceInquiryCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

balance

cardId

declineReason

digitalWalletTokenId

eventSubscriptionId

merchantAcceptorId

merchantCategoryCode

merchantCity

merchantCountry

merchantDescriptor

merchantState

networkDetails

networkRiskScore

physicalCardId

terminalId

_balance

_cardId

_declineReason

_digitalWalletTokenId

_eventSubscriptionId

_merchantAcceptorId

_merchantCategoryCode

_merchantCity

_merchantCountry

_merchantDescriptor

_merchantState

_networkDetails

_networkRiskScore

_physicalCardId

_terminalId

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

none

builder