com.adyen.model.balanceplatform.UpdatePaymentInstrument Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of adyen-java-api-library Show documentation
Show all versions of adyen-java-api-library Show documentation
Adyen API Client Library for Java
/*
* Configuration API
*
* The version of the OpenAPI document: 2
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.adyen.model.balanceplatform;
import java.util.Objects;
import java.util.Map;
import java.util.HashMap;
import com.adyen.model.balanceplatform.BankAccountDetails;
import com.adyen.model.balanceplatform.Card;
import com.adyen.model.balanceplatform.PaymentInstrumentAdditionalBankAccountIdentificationsInner;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.core.JsonProcessingException;
/**
* UpdatePaymentInstrument
*/
@JsonPropertyOrder({
UpdatePaymentInstrument.JSON_PROPERTY_ADDITIONAL_BANK_ACCOUNT_IDENTIFICATIONS,
UpdatePaymentInstrument.JSON_PROPERTY_BALANCE_ACCOUNT_ID,
UpdatePaymentInstrument.JSON_PROPERTY_BANK_ACCOUNT,
UpdatePaymentInstrument.JSON_PROPERTY_CARD,
UpdatePaymentInstrument.JSON_PROPERTY_DESCRIPTION,
UpdatePaymentInstrument.JSON_PROPERTY_ID,
UpdatePaymentInstrument.JSON_PROPERTY_ISSUING_COUNTRY_CODE,
UpdatePaymentInstrument.JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID,
UpdatePaymentInstrument.JSON_PROPERTY_REFERENCE,
UpdatePaymentInstrument.JSON_PROPERTY_REPLACED_BY_ID,
UpdatePaymentInstrument.JSON_PROPERTY_REPLACEMENT_OF_ID,
UpdatePaymentInstrument.JSON_PROPERTY_STATUS,
UpdatePaymentInstrument.JSON_PROPERTY_STATUS_COMMENT,
UpdatePaymentInstrument.JSON_PROPERTY_STATUS_REASON,
UpdatePaymentInstrument.JSON_PROPERTY_TYPE
})
public class UpdatePaymentInstrument {
public static final String JSON_PROPERTY_ADDITIONAL_BANK_ACCOUNT_IDENTIFICATIONS = "additionalBankAccountIdentifications";
@Deprecated // deprecated since Configuration API v2: Please use `bankAccount` object instead
private List additionalBankAccountIdentifications;
public static final String JSON_PROPERTY_BALANCE_ACCOUNT_ID = "balanceAccountId";
private String balanceAccountId;
public static final String JSON_PROPERTY_BANK_ACCOUNT = "bankAccount";
private BankAccountDetails bankAccount;
public static final String JSON_PROPERTY_CARD = "card";
private Card card;
public static final String JSON_PROPERTY_DESCRIPTION = "description";
private String description;
public static final String JSON_PROPERTY_ID = "id";
private String id;
public static final String JSON_PROPERTY_ISSUING_COUNTRY_CODE = "issuingCountryCode";
private String issuingCountryCode;
public static final String JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID = "paymentInstrumentGroupId";
private String paymentInstrumentGroupId;
public static final String JSON_PROPERTY_REFERENCE = "reference";
private String reference;
public static final String JSON_PROPERTY_REPLACED_BY_ID = "replacedById";
private String replacedById;
public static final String JSON_PROPERTY_REPLACEMENT_OF_ID = "replacementOfId";
private String replacementOfId;
/**
* 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.
*/
public enum StatusEnum {
ACTIVE(String.valueOf("active")),
CLOSED(String.valueOf("closed")),
INACTIVE(String.valueOf("inactive")),
SUSPENDED(String.valueOf("suspended"));
private String value;
StatusEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static StatusEnum fromValue(String value) {
for (StatusEnum b : StatusEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_STATUS = "status";
private StatusEnum status;
public static final String JSON_PROPERTY_STATUS_COMMENT = "statusComment";
private String statusComment;
/**
* 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.
*/
public enum StatusReasonEnum {
ACCOUNTCLOSURE(String.valueOf("accountClosure")),
DAMAGED(String.valueOf("damaged")),
ENDOFLIFE(String.valueOf("endOfLife")),
EXPIRED(String.valueOf("expired")),
LOST(String.valueOf("lost")),
OTHER(String.valueOf("other")),
STOLEN(String.valueOf("stolen")),
SUSPECTEDFRAUD(String.valueOf("suspectedFraud")),
TRANSACTIONRULE(String.valueOf("transactionRule"));
private String value;
StatusReasonEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static StatusReasonEnum fromValue(String value) {
for (StatusReasonEnum b : StatusReasonEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_STATUS_REASON = "statusReason";
private StatusReasonEnum statusReason;
/**
* The type of payment instrument. Possible values: **card**, **bankAccount**.
*/
public enum TypeEnum {
BANKACCOUNT(String.valueOf("bankAccount")),
CARD(String.valueOf("card"));
private String value;
TypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}
public static final String JSON_PROPERTY_TYPE = "type";
private TypeEnum type;
public UpdatePaymentInstrument() {
}
/**
* Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
*
* @param additionalBankAccountIdentifications Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*
* @deprecated since Configuration API v2
* Please use `bankAccount` object instead
*/
@Deprecated // deprecated since Configuration API v2: Please use `bankAccount` object instead
public UpdatePaymentInstrument additionalBankAccountIdentifications(List additionalBankAccountIdentifications) {
this.additionalBankAccountIdentifications = additionalBankAccountIdentifications;
return this;
}
public UpdatePaymentInstrument addAdditionalBankAccountIdentificationsItem(PaymentInstrumentAdditionalBankAccountIdentificationsInner additionalBankAccountIdentificationsItem) {
if (this.additionalBankAccountIdentifications == null) {
this.additionalBankAccountIdentifications = new ArrayList<>();
}
this.additionalBankAccountIdentifications.add(additionalBankAccountIdentificationsItem);
return this;
}
/**
* Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
* @return additionalBankAccountIdentifications Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
* @deprecated // deprecated since Configuration API v2: Please use `bankAccount` object instead
*/
@Deprecated // deprecated since Configuration API v2: Please use `bankAccount` object instead
@JsonProperty(JSON_PROPERTY_ADDITIONAL_BANK_ACCOUNT_IDENTIFICATIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getAdditionalBankAccountIdentifications() {
return additionalBankAccountIdentifications;
}
/**
* Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
*
* @param additionalBankAccountIdentifications Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
*
* @deprecated since Configuration API v2
* Please use `bankAccount` object instead
*/
@Deprecated // deprecated since Configuration API v2: Please use `bankAccount` object instead
@JsonProperty(JSON_PROPERTY_ADDITIONAL_BANK_ACCOUNT_IDENTIFICATIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAdditionalBankAccountIdentifications(List additionalBankAccountIdentifications) {
this.additionalBankAccountIdentifications = additionalBankAccountIdentifications;
}
/**
* The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
*
* @param 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.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument balanceAccountId(String balanceAccountId) {
this.balanceAccountId = balanceAccountId;
return this;
}
/**
* The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
* @return 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.
*/
@JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBalanceAccountId() {
return 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.
*
* @param 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.
*/
@JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBalanceAccountId(String balanceAccountId) {
this.balanceAccountId = balanceAccountId;
}
/**
* bankAccount
*
* @param bankAccount
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument bankAccount(BankAccountDetails bankAccount) {
this.bankAccount = bankAccount;
return this;
}
/**
* Get bankAccount
* @return bankAccount
*/
@JsonProperty(JSON_PROPERTY_BANK_ACCOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public BankAccountDetails getBankAccount() {
return bankAccount;
}
/**
* bankAccount
*
* @param bankAccount
*/
@JsonProperty(JSON_PROPERTY_BANK_ACCOUNT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBankAccount(BankAccountDetails bankAccount) {
this.bankAccount = bankAccount;
}
/**
* card
*
* @param card
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument card(Card card) {
this.card = card;
return this;
}
/**
* Get card
* @return card
*/
@JsonProperty(JSON_PROPERTY_CARD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Card getCard() {
return card;
}
/**
* card
*
* @param card
*/
@JsonProperty(JSON_PROPERTY_CARD)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCard(Card card) {
this.card = card;
}
/**
* Your description for the payment instrument, maximum 300 characters.
*
* @param description Your description for the payment instrument, maximum 300 characters.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument description(String description) {
this.description = description;
return this;
}
/**
* Your description for the payment instrument, maximum 300 characters.
* @return description Your description for the payment instrument, maximum 300 characters.
*/
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescription() {
return description;
}
/**
* Your description for the payment instrument, maximum 300 characters.
*
* @param description Your description for the payment instrument, maximum 300 characters.
*/
@JsonProperty(JSON_PROPERTY_DESCRIPTION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDescription(String description) {
this.description = description;
}
/**
* The unique identifier of the payment instrument.
*
* @param id The unique identifier of the payment instrument.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument id(String id) {
this.id = id;
return this;
}
/**
* The unique identifier of the payment instrument.
* @return id The unique identifier of the payment instrument.
*/
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getId() {
return id;
}
/**
* The unique identifier of the payment instrument.
*
* @param id The unique identifier of the payment instrument.
*/
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setId(String id) {
this.id = id;
}
/**
* 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**.
*
* @param 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**.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument issuingCountryCode(String issuingCountryCode) {
this.issuingCountryCode = issuingCountryCode;
return this;
}
/**
* 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**.
* @return 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**.
*/
@JsonProperty(JSON_PROPERTY_ISSUING_COUNTRY_CODE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getIssuingCountryCode() {
return 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**.
*
* @param 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**.
*/
@JsonProperty(JSON_PROPERTY_ISSUING_COUNTRY_CODE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setIssuingCountryCode(String issuingCountryCode) {
this.issuingCountryCode = issuingCountryCode;
}
/**
* 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.
*
* @param 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.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument paymentInstrumentGroupId(String paymentInstrumentGroupId) {
this.paymentInstrumentGroupId = paymentInstrumentGroupId;
return this;
}
/**
* 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.
* @return 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.
*/
@JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPaymentInstrumentGroupId() {
return 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.
*
* @param 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.
*/
@JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPaymentInstrumentGroupId(String paymentInstrumentGroupId) {
this.paymentInstrumentGroupId = paymentInstrumentGroupId;
}
/**
* Your reference for the payment instrument, maximum 150 characters.
*
* @param reference Your reference for the payment instrument, maximum 150 characters.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument reference(String reference) {
this.reference = reference;
return this;
}
/**
* Your reference for the payment instrument, maximum 150 characters.
* @return reference Your reference for the payment instrument, maximum 150 characters.
*/
@JsonProperty(JSON_PROPERTY_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getReference() {
return reference;
}
/**
* Your reference for the payment instrument, maximum 150 characters.
*
* @param reference Your reference for the payment instrument, maximum 150 characters.
*/
@JsonProperty(JSON_PROPERTY_REFERENCE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setReference(String reference) {
this.reference = reference;
}
/**
* The unique identifier of the payment instrument that replaced this payment instrument.
*
* @param replacedById The unique identifier of the payment instrument that replaced this payment instrument.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument replacedById(String replacedById) {
this.replacedById = replacedById;
return this;
}
/**
* The unique identifier of the payment instrument that replaced this payment instrument.
* @return replacedById The unique identifier of the payment instrument that replaced this payment instrument.
*/
@JsonProperty(JSON_PROPERTY_REPLACED_BY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getReplacedById() {
return replacedById;
}
/**
* The unique identifier of the payment instrument that replaced this payment instrument.
*
* @param replacedById The unique identifier of the payment instrument that replaced this payment instrument.
*/
@JsonProperty(JSON_PROPERTY_REPLACED_BY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setReplacedById(String replacedById) {
this.replacedById = replacedById;
}
/**
* The unique identifier of the payment instrument that is replaced by this payment instrument.
*
* @param replacementOfId The unique identifier of the payment instrument that is replaced by this payment instrument.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument replacementOfId(String replacementOfId) {
this.replacementOfId = replacementOfId;
return this;
}
/**
* The unique identifier of the payment instrument that is replaced by this payment instrument.
* @return replacementOfId The unique identifier of the payment instrument that is replaced by this payment instrument.
*/
@JsonProperty(JSON_PROPERTY_REPLACEMENT_OF_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getReplacementOfId() {
return replacementOfId;
}
/**
* The unique identifier of the payment instrument that is replaced by this payment instrument.
*
* @param replacementOfId The unique identifier of the payment instrument that is replaced by this payment instrument.
*/
@JsonProperty(JSON_PROPERTY_REPLACEMENT_OF_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setReplacementOfId(String replacementOfId) {
this.replacementOfId = replacementOfId;
}
/**
* 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.
*
* @param 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.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument status(StatusEnum status) {
this.status = status;
return this;
}
/**
* 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.
* @return 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.
*/
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public StatusEnum getStatus() {
return 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.
*
* @param 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.
*/
@JsonProperty(JSON_PROPERTY_STATUS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStatus(StatusEnum status) {
this.status = status;
}
/**
* Comment for the status of the payment instrument. Required if `statusReason` is **other**.
*
* @param statusComment Comment for the status of the payment instrument. Required if `statusReason` is **other**.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument statusComment(String statusComment) {
this.statusComment = statusComment;
return this;
}
/**
* Comment for the status of the payment instrument. Required if `statusReason` is **other**.
* @return statusComment Comment for the status of the payment instrument. Required if `statusReason` is **other**.
*/
@JsonProperty(JSON_PROPERTY_STATUS_COMMENT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getStatusComment() {
return statusComment;
}
/**
* Comment for the status of the payment instrument. Required if `statusReason` is **other**.
*
* @param statusComment Comment for the status of the payment instrument. Required if `statusReason` is **other**.
*/
@JsonProperty(JSON_PROPERTY_STATUS_COMMENT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStatusComment(String statusComment) {
this.statusComment = statusComment;
}
/**
* 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.
*
* @param 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.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument statusReason(StatusReasonEnum statusReason) {
this.statusReason = statusReason;
return this;
}
/**
* 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.
* @return 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.
*/
@JsonProperty(JSON_PROPERTY_STATUS_REASON)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public StatusReasonEnum getStatusReason() {
return 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.
*
* @param 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.
*/
@JsonProperty(JSON_PROPERTY_STATUS_REASON)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setStatusReason(StatusReasonEnum statusReason) {
this.statusReason = statusReason;
}
/**
* The type of payment instrument. Possible values: **card**, **bankAccount**.
*
* @param type The type of payment instrument. Possible values: **card**, **bankAccount**.
* @return the current {@code UpdatePaymentInstrument} instance, allowing for method chaining
*/
public UpdatePaymentInstrument type(TypeEnum type) {
this.type = type;
return this;
}
/**
* The type of payment instrument. Possible values: **card**, **bankAccount**.
* @return type The type of payment instrument. Possible values: **card**, **bankAccount**.
*/
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public TypeEnum getType() {
return type;
}
/**
* The type of payment instrument. Possible values: **card**, **bankAccount**.
*
* @param type The type of payment instrument. Possible values: **card**, **bankAccount**.
*/
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setType(TypeEnum type) {
this.type = type;
}
/**
* Return true if this UpdatePaymentInstrument object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
UpdatePaymentInstrument updatePaymentInstrument = (UpdatePaymentInstrument) o;
return Objects.equals(this.additionalBankAccountIdentifications, updatePaymentInstrument.additionalBankAccountIdentifications) &&
Objects.equals(this.balanceAccountId, updatePaymentInstrument.balanceAccountId) &&
Objects.equals(this.bankAccount, updatePaymentInstrument.bankAccount) &&
Objects.equals(this.card, updatePaymentInstrument.card) &&
Objects.equals(this.description, updatePaymentInstrument.description) &&
Objects.equals(this.id, updatePaymentInstrument.id) &&
Objects.equals(this.issuingCountryCode, updatePaymentInstrument.issuingCountryCode) &&
Objects.equals(this.paymentInstrumentGroupId, updatePaymentInstrument.paymentInstrumentGroupId) &&
Objects.equals(this.reference, updatePaymentInstrument.reference) &&
Objects.equals(this.replacedById, updatePaymentInstrument.replacedById) &&
Objects.equals(this.replacementOfId, updatePaymentInstrument.replacementOfId) &&
Objects.equals(this.status, updatePaymentInstrument.status) &&
Objects.equals(this.statusComment, updatePaymentInstrument.statusComment) &&
Objects.equals(this.statusReason, updatePaymentInstrument.statusReason) &&
Objects.equals(this.type, updatePaymentInstrument.type);
}
@Override
public int hashCode() {
return Objects.hash(additionalBankAccountIdentifications, balanceAccountId, bankAccount, card, description, id, issuingCountryCode, paymentInstrumentGroupId, reference, replacedById, replacementOfId, status, statusComment, statusReason, type);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class UpdatePaymentInstrument {\n");
sb.append(" additionalBankAccountIdentifications: ").append(toIndentedString(additionalBankAccountIdentifications)).append("\n");
sb.append(" balanceAccountId: ").append(toIndentedString(balanceAccountId)).append("\n");
sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n");
sb.append(" card: ").append(toIndentedString(card)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" issuingCountryCode: ").append(toIndentedString(issuingCountryCode)).append("\n");
sb.append(" paymentInstrumentGroupId: ").append(toIndentedString(paymentInstrumentGroupId)).append("\n");
sb.append(" reference: ").append(toIndentedString(reference)).append("\n");
sb.append(" replacedById: ").append(toIndentedString(replacedById)).append("\n");
sb.append(" replacementOfId: ").append(toIndentedString(replacementOfId)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" statusComment: ").append(toIndentedString(statusComment)).append("\n");
sb.append(" statusReason: ").append(toIndentedString(statusReason)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
/**
* Create an instance of UpdatePaymentInstrument given an JSON string
*
* @param jsonString JSON string
* @return An instance of UpdatePaymentInstrument
* @throws JsonProcessingException if the JSON string is invalid with respect to UpdatePaymentInstrument
*/
public static UpdatePaymentInstrument fromJson(String jsonString) throws JsonProcessingException {
return JSON.getMapper().readValue(jsonString, UpdatePaymentInstrument.class);
}
/**
* Convert an instance of UpdatePaymentInstrument to an JSON string
*
* @return JSON string
*/
public String toJson() throws JsonProcessingException {
return JSON.getMapper().writeValueAsString(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy