Package com.adyen.model.balanceplatform

Class PaymentInstrument

  • public class PaymentInstrument
extends Object
    PaymentInstrument

    • Constructor Detail

      • PaymentInstrument

        public PaymentInstrument()

    • Method Detail

      • setAdditionalBankAccountIdentifications

        @Deprecated
public void setAdditionalBankAccountIdentifications​(List<PaymentInstrumentAdditionalBankAccountIdentificationsInner> additionalBankAccountIdentifications)
        Deprecated.
        Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
        Parameters:
        additionalBankAccountIdentifications -

      • 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)
        The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
        Parameters:
        balanceAccountId -

      • getBankAccount

        public BankAccountDetails getBankAccount()
        Get bankAccount
        Returns:
        bankAccount

      • setBankAccount

        public void setBankAccount​(BankAccountDetails bankAccount)
        bankAccount
        Parameters:
        bankAccount -

      • getCard

        public Card getCard()
        Get card
        Returns:
        card

      • setCard

        public void setCard​(Card card)
        card
        Parameters:
        card -

      • getDescription

        public String getDescription()
        Your description for the payment instrument, maximum 300 characters.
        Returns:
        description

      • setDescription

        public void setDescription​(String description)
        Your description for the payment instrument, maximum 300 characters.
        Parameters:
        description -

      • getId

        public String getId()
        The unique identifier of the payment instrument.
        Returns:
        id

      • setId

        public void setId​(String id)
        The unique identifier of the payment instrument.
        Parameters:
        id -

      • 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)
        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**.
        Parameters:
        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)
        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.
        Parameters:
        paymentInstrumentGroupId -

      • getReference

        public String getReference()
        Your reference for the payment instrument, maximum 150 characters.
        Returns:
        reference

      • setReference

        public void setReference​(String reference)
        Your reference for the payment instrument, maximum 150 characters.
        Parameters:
        reference -

      • 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)
        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.
        Parameters:
        status -

      • 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)
        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.
        Parameters:
        statusReason -

      • getType

        public PaymentInstrument.TypeEnum getType()
        Type of payment instrument. Possible value: **card**, **bankAccount**.
        Returns:
        type

      • setType

        public void setType​(PaymentInstrument.TypeEnum type)
        Type of payment instrument. Possible value: **card**, **bankAccount**.
        Parameters:
        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

      • 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