com.bitpay.sdk.model.Token Maven / Gradle / Ivy

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.0
Show newest version
/*
 * Copyright (c) 2019 BitPay.
 * All rights reserved.
 */

package com.bitpay.sdk.model;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;

/**
 * The type Token.
 *
 * @see Tokens concept
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class Token {

    protected String guid;
    protected String id;
    protected String pairingCode;
    protected Long pairingExpiration;
    protected String facade;
    protected String label;
    protected Integer count = 0;
    protected List policies;
    protected String resource;
    protected String value;
    protected Long dateCreated;

    /**
     * Instantiates a new Token.
     */
    public Token() {
    }

    // API fields
    //

    /**
     * Gets guid. A passthru variable provided by the merchant and designed to be used by the merchant to correlate
     * the invoice with an order ID in their system.
     *
     * @return the guid
     */
    @JsonProperty("guid")
    public String getGuid() {
        return this.guid;
    }

    /**
     * Sets guid. A passthru variable provided by the merchant and designed to be used by the merchant to correlate
     * the invoice with an order ID in their system.
     *
     * @param guid the guid
     */
    @JsonProperty("guid")
    public void setGuid(String guid) {
        this.guid = guid;
    }

    // Required fields
    //

    /**
     * Gets id.
     *
     * @return the id
     */
    @JsonProperty("id")
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public String getId() {
        return this.id;
    }

    /**
     * Sets id.
     *
     * @param id the id
     */
    @JsonProperty("id")
    public void setId(String id) {
        this.id = id;
    }

    // Optional fields
    //

    /**
     * Gets pairing code. Access approval code. To be validated via the BitPay dashboard in order to activate
     * the token returned in the same payload.
     *
     * @return the pairing code
     */
    @JsonProperty("pairingCode")
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public String getPairingCode() {
        return this.pairingCode;
    }

    /**
     * Sets pairing code. Access approval code. To be validated via the BitPay dashboard in order to activate
     * the token returned in the same payload.
     *
     * @param pairingCode the pairing code
     */
    @JsonProperty("pairingCode")
    public void setPairingCode(String pairingCode) {
        this.pairingCode = pairingCode;
    }

    /**
     * Gets facade. Can be "merchant", "pos" or "payout".
     *
     * @return the facade
     */
    @JsonProperty("facade")
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public String getFacade() {
        return this.facade;
    }

    /**
     * Sets facade. Can be "merchant", "pos" or "payout".
     *
     * @param facade the facade
     */
    @JsonProperty("facade")
    public void setFacade(String facade) {
        this.facade = facade;
    }

    /**
     * Gets token label, may include spaces, underscores, and dashes. BitPay invites the merchants to pass their
     * Business Name or website in this field.
     *
     * @return the label
     */
    @JsonProperty("label")
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public String getLabel() {
        return this.label;
    }

    /**
     * Sets token label, may include spaces, underscores, and dashes. BitPay invites the merchants to pass their
     * Business Name or website in this field.
     *
     * @param label the label
     */
    @JsonProperty("label")
    public void setLabel(String label) {
        this.label = label;
    }

    /**
     * Gets count.
     *
     * @return the count
     */
    @JsonProperty("count")
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public Integer getCount() {
        return this.count;
    }

    /**
     * Sets count.
     *
     * @param count the count
     */
    @JsonProperty("count")
    public void setCount(Integer count) {
        this.count = count;
    }

    // Response fields
    //

    /**
     * Gets UNIX time of expiration, in milliseconds.
     *
     * @return the pairing expiration
     */
    @JsonIgnore
    public Long getPairingExpiration() {
        return this.pairingExpiration;
    }

    /**
     * Sets UNIX time of expiration, in milliseconds.
     *
     * @param pairingExpiration the pairing expiration
     */
    @JsonProperty("pairingExpiration")
    public void setPairingExpiration(Long pairingExpiration) {
        this.pairingExpiration = pairingExpiration;
    }

    /**
     * Gets policies.
     *
     * @return the policies
     */
    @JsonIgnore
    public List getPolicies() {
        return this.policies;
    }

    /**
     * Sets policies.
     *
     * @param policies the policies
     */
    @JsonProperty("policies")
    public void setPolicies(List policies) {
        this.policies = policies;
    }

    /**
     * Gets Token identifier. This field can be ignored in merchant implementations.
     *
     * @return the resource
     */
    @JsonIgnore
    public String getResource() {
        return this.resource;
    }

    /**
     * Sets Token identifier. This field can be ignored in merchant implementations.
     *
     * @param resource the resource
     */
    @JsonProperty("resource")
    public void setResource(String resource) {
        this.resource = resource;
    }

    /**
     * Gets value.
     *
     * @return the value
     */
    @JsonIgnore
    public String getValue() {
        return this.value;
    }

    /**
     * Sets value.
     *
     * @param value the value
     */
    @JsonProperty("token")
    public void setValue(String value) {
        this.value = value;
    }

    /**
     * Gets UNIX time of creation, in milliseconds.
     *
     * @return the date created
     */
    @JsonIgnore
    public Long getDateCreated() {
        return this.dateCreated;
    }

    /**
     * Sets UNIX time of creation, in milliseconds.
     *
     * @param dateCreated the date created
     */
    @JsonProperty("dateCreated")
    public void setDateCreated(Long dateCreated) {
        this.dateCreated = dateCreated;
    }

}