com.bitpay.sdk.model.payout.PayoutRecipients 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.payout;

import com.bitpay.sdk.model.ModelConfiguration;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;

/**
 * The type Payout recipients.
 *
 * @see REST API Payouts
 */
public class PayoutRecipients {
    protected String guid;
    protected List recipients;
    protected String token = ModelConfiguration.DEFAULT_NON_SENT_VALUE;

    /**
     * Constructor, create an recipient-full request PayoutBatch object.
     *
     * @param recipients array of JSON objects, with containing the following parameters.
     */
    public PayoutRecipients(List recipients) {
        this.recipients = recipients;
    }

    // API fields
    //

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

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

    /**
     * Gets Payout recipients token.
     *
     * @return the token
     */
    @JsonProperty("token")
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public String getToken() {
        return this.token;
    }

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

    // Required fields
    //

    /**
     * Gets instructions.
     *
     * @return the instructions
     */
    @JsonProperty("recipients")
    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
    public List getInstructions() {
        return this.recipients;
    }

    /**
     * Sets instructions.
     *
     * @param recipients the recipients
     */
    @JsonProperty("recipients")
    public void setInstructions(List recipients) {
        this.recipients = recipients;
    }
}