Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// File generated from our OpenAPI spec
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.Getter;
@Getter
public class PayoutCreateParams extends ApiRequestParams {
/** Required. A positive integer in cents representing how much to payout. */
@SerializedName("amount")
Long amount;
/**
* Required. Three-letter ISO currency code, in lowercase.
* Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/** An arbitrary string attached to the object. Often useful for displaying to users. */
@SerializedName("description")
String description;
/**
* The ID of a bank account or a card to send the payout to. If you don't provide a destination,
* we use the default external account for the specified currency.
*/
@SerializedName("destination")
String destination;
/** Specifies which fields in the response should be expanded. */
@SerializedName("expand")
List expand;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* Set of key-value pairs that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format. Individual keys can be unset by posting an empty value to them. All keys can
* be unset by posting an empty value to {@code metadata}.
*/
@SerializedName("metadata")
Map metadata;
/**
* The method used to send this payout, which is {@code standard} or {@code instant}. We support
* {@code instant} for payouts to debit cards and bank accounts in certain countries. Learn more
* about bank support for Instant
* Payouts.
*/
@SerializedName("method")
Method method;
/**
* The balance type of your Stripe balance to draw this payout from. Balances for different
* payment sources are kept separately. You can find the amounts with the Balances API. One of
* {@code bank_account}, {@code card}, or {@code fpx}.
*/
@SerializedName("source_type")
SourceType sourceType;
/**
* A string that displays on the recipient's bank or card statement (up to 22 characters). A
* {@code statement_descriptor} that's longer than 22 characters return an error. Most banks
* truncate this information and display it inconsistently. Some banks might not display it at
* all.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
private PayoutCreateParams(
Long amount,
String currency,
String description,
String destination,
List expand,
Map extraParams,
Map metadata,
Method method,
SourceType sourceType,
String statementDescriptor) {
this.amount = amount;
this.currency = currency;
this.description = description;
this.destination = destination;
this.expand = expand;
this.extraParams = extraParams;
this.metadata = metadata;
this.method = method;
this.sourceType = sourceType;
this.statementDescriptor = statementDescriptor;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private String currency;
private String description;
private String destination;
private List expand;
private Map extraParams;
private Map metadata;
private Method method;
private SourceType sourceType;
private String statementDescriptor;
/** Finalize and obtain parameter instance from this builder. */
public PayoutCreateParams build() {
return new PayoutCreateParams(
this.amount,
this.currency,
this.description,
this.destination,
this.expand,
this.extraParams,
this.metadata,
this.method,
this.sourceType,
this.statementDescriptor);
}
/** Required. A positive integer in cents representing how much to payout. */
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* Required. Three-letter ISO currency code, in lowercase.
* Must be a supported currency.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
/** An arbitrary string attached to the object. Often useful for displaying to users. */
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* The ID of a bank account or a card to send the payout to. If you don't provide a destination,
* we use the default external account for the specified currency.
*/
public Builder setDestination(String destination) {
this.destination = destination;
return this;
}
/**
* Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* PayoutCreateParams#expand} for the field documentation.
*/
public Builder addExpand(String element) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.add(element);
return this;
}
/**
* Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* PayoutCreateParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* PayoutCreateParams#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link PayoutCreateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call,
* and subsequent calls add additional key/value pairs to the original map. See {@link
* PayoutCreateParams#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `metadata` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link PayoutCreateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/**
* The method used to send this payout, which is {@code standard} or {@code instant}. We support
* {@code instant} for payouts to debit cards and bank accounts in certain countries. Learn more
* about bank support for
* Instant Payouts.
*/
public Builder setMethod(PayoutCreateParams.Method method) {
this.method = method;
return this;
}
/**
* The balance type of your Stripe balance to draw this payout from. Balances for different
* payment sources are kept separately. You can find the amounts with the Balances API. One of
* {@code bank_account}, {@code card}, or {@code fpx}.
*/
public Builder setSourceType(PayoutCreateParams.SourceType sourceType) {
this.sourceType = sourceType;
return this;
}
/**
* A string that displays on the recipient's bank or card statement (up to 22 characters). A
* {@code statement_descriptor} that's longer than 22 characters return an error. Most banks
* truncate this information and display it inconsistently. Some banks might not display it at
* all.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
}
public enum Method implements ApiRequestParams.EnumParam {
@SerializedName("instant")
INSTANT("instant"),
@SerializedName("standard")
STANDARD("standard");
@Getter(onMethod_ = {@Override})
private final String value;
Method(String value) {
this.value = value;
}
}
public enum SourceType implements ApiRequestParams.EnumParam {
@SerializedName("bank_account")
BANK_ACCOUNT("bank_account"),
@SerializedName("card")
CARD("card"),
@SerializedName("fpx")
FPX("fpx");
@Getter(onMethod_ = {@Override})
private final String value;
SourceType(String value) {
this.value = value;
}
}
}
