com.bitpay.sdk.model.ledger.Ledger 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.

The newest version!

/*
 * Copyright (c) 2019 BitPay.
 * All rights reserved.
 */

package com.bitpay.sdk.model.ledger;

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

/**
 * Ledgers are records of money movement.
 *
 * @see REST API Ledgers
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class Ledger {

    protected String currency = ModelConfiguration.DEFAULT_NON_SENT_VALUE;
    protected Double balance;

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

    /**
     * Gets ISO 4217 3-character currency code for your merchant account.
     *
     * @return the currency
     */
    @JsonIgnore
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public String getCurrency() {
        return this.currency;
    }

    /**
     * Sets ISO 4217 3-character currency code for your merchant account.
     *
     * @param currency the currency
     */
    @JsonProperty("currency")
    public void setCurrency(String currency) {
        this.currency = currency;
    }

    /**
     * Gets balance of the ledger.
     *
     * @return the balance
     */
    @JsonIgnore
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public Double getBalance() {
        return this.balance;
    }

    /**
     * Sets balance of the ledger.
     *
     * @param balance the balance
     */
    @JsonProperty("balance")
    public void setBalance(Double balance) {
        this.balance = balance;
    }
}