com.bitpay.sdk.model.invoice.InvoiceBuyerProvidedInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bitpay_sdk Show documentation
Full implementation of the BitPay Payment Gateway. This library implements BitPay's Cryptographically Secure RESTful API.
There is a newer version: 10.1.1
Show newest version
/*
 * Copyright (c) 2019 BitPay.
 * All rights reserved.
 */

package com.bitpay.sdk.model.invoice;

import com.bitpay.sdk.model.ModelConfiguration;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Information collected from the buyer during the process of paying an invoice. Initially this object is empty.
 *
 * @see REST API Invoices
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class InvoiceBuyerProvidedInfo {

    protected String name = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
    protected String phoneNumber = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
    protected String selectedTransactionCurrency = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
    protected String emailAddress = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
    protected String selectedWallet = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
    protected String sms = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
    protected Boolean smsVerified;

    /**
     * Instantiates a new Invoice buyer provided info.
     */
    public InvoiceBuyerProvidedInfo() {
    }

    /**
     * Gets name. Populated with the buyer's name address if passed in the buyer object by the merchant.
     *
     * @return the name
     */
    @JsonIgnore
    public String getName() {
        return this.name;
    }

    /**
     * Sets name. Populated with the buyer's name address if passed in the buyer object by the merchant.
     *
     * @param name the name
     */
    @JsonProperty("name")
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Gets phone number. Populated with the buyer's phone number if passed in the buyer object by the merchant.
     *
     * @return the phone number
     */
    @JsonIgnore
    public String getPhoneNumber() {
        return this.phoneNumber;
    }

    /**
     * Sets phone number. Populated with the buyer's phone number if passed in the buyer object by the merchant.
     *
     * @param phoneNumber the phone number
     */
    @JsonProperty("phoneNumber")
    public void setPhoneNumber(String phoneNumber) {
        this.phoneNumber = phoneNumber;
    }

    /**
     * Gets selected transaction currency. This field will be populated with the cryptocurrency selected to pay
     * the BitPay invoice, current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD", "USDC", "XRP",
     * "DOGE", "DAI" and "WBTC". If not yet selected, this field will not be returned.
     *
     * @return the selected transaction currency
     */
    @JsonIgnore
    public String getSelectedTransactionCurrency() {
        return this.selectedTransactionCurrency;
    }

    /**
     * Sets selected transaction currency. This field will be populated with the cryptocurrency selected to pay
     * the BitPay invoice, current supported values are "BTC", "BCH", "ETH", "GUSD", "PAX", "BUSD", "USDC", "XRP",
     * "DOGE", "DAI" and "WBTC". If not yet selected, this field will not be returned.
     *
     * @param selectedTransactionCurrency the selected transaction currency
     */
    @JsonProperty("selectedTransactionCurrency")
    public void setSelectedTransactionCurrency(String selectedTransactionCurrency) {
        this.selectedTransactionCurrency = selectedTransactionCurrency;
    }

    /**
     * Gets email address. Populated with the buyer's email address if passed in the buyer object, otherwise this
     * field is not returned in the response.
     *
     * @return the email address
     */
    @JsonIgnore
    public String getEmailAddress() {
        return this.emailAddress;
    }

    /**
     * Sets email address. Populated with the buyer's email address if passed in the buyer object, otherwise this
     * field is not returned in the response.
     *
     * @param emailAddress the email address
     */
    @JsonProperty("emailAddress")
    public void setEmailAddress(String emailAddress) {
        this.emailAddress = emailAddress;
    }

    /**
     * Gets selected wallet. This field contains the name of the cryptocurrency wallet selected by the shopper to
     * complete the payment.
     *
     * @return the selected wallet
     */
    @JsonIgnore
    public String getSelectedWallet() {
        return this.selectedWallet;
    }

    /**
     * Sets selected wallet. This field contains the name of the cryptocurrency wallet selected by the shopper to
     * complete the payment.
     *
     * @param selectedWallet the selected wallet
     */
    @JsonProperty("selectedWallet")
    public void setSelectedWallet(String selectedWallet) {
        this.selectedWallet = selectedWallet;
    }

    /**
     * Gets SMS provided by user for communications. This is only used for instances where a buyers email
     * (primary form of buyer communication) is can not be gathered.
     *
     * @return the sms
     */
    @JsonIgnore
    public String getSms() {
        return this.sms;
    }

    /**
     * Sets SMS provided by user for communications. This is only used for instances where a buyers email
     * (primary form of buyer communication) is can not be gathered.
     *
     * @param sms the sms
     */
    @JsonProperty("sms")
    public void setSms(String sms) {
        this.sms = sms;
    }

    /**
     * Gets verification status of SMS (ie. have they passed the challenge).
     *
     * @return the sms verified
     */
    @JsonIgnore
    public Boolean getSmsVerified() {
        return this.smsVerified;
    }

    /**
     * Sets verification status of SMS (ie. have they passed the challenge).
     *
     * @param smsVerified the sms verified
     */
    @JsonProperty("smsVerified")
    public void setSmsVerified(Boolean smsVerified) {
        this.smsVerified = smsVerified;
    }
}