java.lang.Object
- com.adyen.model.balanceplatform.PaymentInstrument

public class PaymentInstrument
extends Object

PaymentInstrument

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PaymentInstrument.StatusEnum`	The status of the payment instrument.
`static class`	`PaymentInstrument.StatusReasonEnum`	The reason for the status of the payment instrument.
`static class`	`PaymentInstrument.TypeEnum`	Type of payment instrument.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_BALANCE_ACCOUNT_ID`
`static String`	`JSON_PROPERTY_BANK_ACCOUNT`
`static String`	`JSON_PROPERTY_CARD`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_ISSUING_COUNTRY_CODE`
`static String`	`JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_STATUS`
`static String`	`JSON_PROPERTY_STATUS_REASON`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

PaymentInstrument()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentInstrument`	`balanceAccountId(String balanceAccountId)`
`PaymentInstrument`	`bankAccount(PaymentInstrumentBankAccount bankAccount)`
`PaymentInstrument`	`card(Card card)`
`PaymentInstrument`	`description(String description)`
`boolean`	`equals(Object o)`	Return true if this PaymentInstrument object is equal to o.
`static PaymentInstrument`	`fromJson(String jsonString)`	Create an instance of PaymentInstrument given an JSON string
`String`	`getBalanceAccountId()`	The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
`PaymentInstrumentBankAccount`	`getBankAccount()`	Get bankAccount
`Card`	`getCard()`	Get card
`String`	`getDescription()`	Your description for the payment instrument, maximum 300 characters.
`String`	`getId()`	The unique identifier of the payment instrument.
`String`	`getIssuingCountryCode()`	The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued.
`String`	`getPaymentInstrumentGroupId()`	The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs.
`String`	`getReference()`	Your reference for the payment instrument, maximum 150 characters.
`PaymentInstrument.StatusEnum`	`getStatus()`	The status of the payment instrument.
`PaymentInstrument.StatusReasonEnum`	`getStatusReason()`	The reason for the status of the payment instrument.
`PaymentInstrument.TypeEnum`	`getType()`	Type of payment instrument.
`int`	`hashCode()`
`PaymentInstrument`	`id(String id)`
`PaymentInstrument`	`issuingCountryCode(String issuingCountryCode)`
`PaymentInstrument`	`paymentInstrumentGroupId(String paymentInstrumentGroupId)`
`PaymentInstrument`	`reference(String reference)`
`void`	`setBalanceAccountId(String balanceAccountId)`
`void`	`setBankAccount(PaymentInstrumentBankAccount bankAccount)`
`void`	`setCard(Card card)`
`void`	`setDescription(String description)`
`void`	`setId(String id)`
`void`	`setIssuingCountryCode(String issuingCountryCode)`
`void`	`setPaymentInstrumentGroupId(String paymentInstrumentGroupId)`
`void`	`setReference(String reference)`
`void`	`setStatus(PaymentInstrument.StatusEnum status)`
`void`	`setStatusReason(PaymentInstrument.StatusReasonEnum statusReason)`
`void`	`setType(PaymentInstrument.TypeEnum type)`
`PaymentInstrument`	`status(PaymentInstrument.StatusEnum status)`
`PaymentInstrument`	`statusReason(PaymentInstrument.StatusReasonEnum statusReason)`
`String`	`toJson()`	Convert an instance of PaymentInstrument to an JSON string
`String`	`toString()`
`PaymentInstrument`	`type(PaymentInstrument.TypeEnum type)`

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

- Field Detail
  - JSON_PROPERTY_BALANCE_ACCOUNT_ID
```
public static final String JSON_PROPERTY_BALANCE_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BANK_ACCOUNT
```
public static final String JSON_PROPERTY_BANK_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CARD
```
public static final String JSON_PROPERTY_CARD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ISSUING_COUNTRY_CODE
```
public static final String JSON_PROPERTY_ISSUING_COUNTRY_CODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID
```
public static final String JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID
```
    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
  - JSON_PROPERTY_STATUS_REASON
```
public static final String JSON_PROPERTY_STATUS_REASON
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentInstrument
```
public PaymentInstrument()
```
- Method Detail
  - balanceAccountId
```
public PaymentInstrument balanceAccountId(String balanceAccountId)
```
  - getBalanceAccountId
```
public String getBalanceAccountId()
```
    The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
    
    Returns:
    
    balanceAccountId
  - setBalanceAccountId
```
public void setBalanceAccountId(String balanceAccountId)
```
  - bankAccount
```
public PaymentInstrument bankAccount(PaymentInstrumentBankAccount bankAccount)
```
  - getBankAccount
```
public PaymentInstrumentBankAccount getBankAccount()
```
    Get bankAccount
    
    Returns:
    
    bankAccount
  - setBankAccount
```
public void setBankAccount(PaymentInstrumentBankAccount bankAccount)
```
  - card
```
public PaymentInstrument card(Card card)
```
  - getCard
```
public Card getCard()
```
    Get card
    
    Returns:
    
    card
  - setCard
```
public void setCard(Card card)
```
  - description
```
public PaymentInstrument description(String description)
```
  - getDescription
```
public String getDescription()
```
    Your description for the payment instrument, maximum 300 characters.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - id
```
public PaymentInstrument id(String id)
```
  - getId
```
public String getId()
```
    The unique identifier of the payment instrument.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - issuingCountryCode
```
public PaymentInstrument issuingCountryCode(String issuingCountryCode)
```
  - getIssuingCountryCode
```
public String getIssuingCountryCode()
```
    The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.
    
    Returns:
    
    issuingCountryCode
  - setIssuingCountryCode
```
public void setIssuingCountryCode(String issuingCountryCode)
```
  - paymentInstrumentGroupId
```
public PaymentInstrument paymentInstrumentGroupId(String paymentInstrumentGroupId)
```
  - getPaymentInstrumentGroupId
```
public String getPaymentInstrumentGroupId()
```
    The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs.
    
    Returns:
    
    paymentInstrumentGroupId
  - setPaymentInstrumentGroupId
```
public void setPaymentInstrumentGroupId(String paymentInstrumentGroupId)
```
  - reference
```
public PaymentInstrument reference(String reference)
```
  - getReference
```
public String getReference()
```
    Your reference for the payment instrument, maximum 150 characters.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
  - status
```
public PaymentInstrument status(PaymentInstrument.StatusEnum status)
```
  - getStatus
```
public PaymentInstrument.StatusEnum getStatus()
```
    The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**. Possible values: * **active**: The payment instrument is active and can be used to make payments. * **inactive**: The payment instrument is inactive and cannot be used to make payments. * **suspended**: The payment instrument is suspended, either because it was stolen or lost. * **closed**: The payment instrument is permanently closed. This action cannot be undone.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(PaymentInstrument.StatusEnum status)
```
  - statusReason
```
public PaymentInstrument statusReason(PaymentInstrument.StatusReasonEnum statusReason)
```
  - getStatusReason
```
public PaymentInstrument.StatusReasonEnum getStatusReason()
```
    The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change.
    
    Returns:
    
    statusReason
  - setStatusReason
```
public void setStatusReason(PaymentInstrument.StatusReasonEnum statusReason)
```
  - type
```
public PaymentInstrument type(PaymentInstrument.TypeEnum type)
```
  - getType
```
public PaymentInstrument.TypeEnum getType()
```
    Type of payment instrument. Possible value: **card**, **bankAccount**.
    
    Returns:
    
    type
  - setType
```
public void setType(PaymentInstrument.TypeEnum type)
```
  - equals
```
public boolean equals(Object o)
```
    Return true if this PaymentInstrument 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 PaymentInstrument fromJson(String jsonString)
                                  throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PaymentInstrument given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentInstrument
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentInstrument
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PaymentInstrument to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class PaymentInstrument

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_BALANCE_ACCOUNT_ID

JSON_PROPERTY_BANK_ACCOUNT

JSON_PROPERTY_CARD

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_ID

JSON_PROPERTY_ISSUING_COUNTRY_CODE

JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_STATUS

JSON_PROPERTY_STATUS_REASON

JSON_PROPERTY_TYPE

Constructor Detail

PaymentInstrument

Method Detail

balanceAccountId

getBalanceAccountId

setBalanceAccountId

bankAccount

getBankAccount

setBankAccount

card

getCard

setCard

description

getDescription

setDescription

id

getId

setId

issuingCountryCode

getIssuingCountryCode

setIssuingCountryCode

paymentInstrumentGroupId

getPaymentInstrumentGroupId

setPaymentInstrumentGroupId

reference

getReference

setReference

status

getStatus

setStatus

statusReason

getStatusReason

setStatusReason

type

getType

setType

equals

hashCode

toString

fromJson

toJson