com.stripe.param

Class PayoutCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.PayoutCreateParams

public class PayoutCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PayoutCreateParams.Builder
static class	PayoutCreateParams.Method
static class	PayoutCreateParams.SourceType

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static PayoutCreateParams.Builder	builder()
java.lang.Long	getAmount() A positive integer in cents representing how much to payout.
java.lang.String	getCurrency() Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
java.lang.String	getDescription() An arbitrary string attached to the object.
java.lang.String	getDestination() The ID of a bank account or a card to send the payout to.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() A set of key-value pairs that you can attach to a payout object.
PayoutCreateParams.Method	getMethod() The method used to send this payout, which can be `standard` or `instant`.
PayoutCreateParams.SourceType	getSourceType() The balance type of your Stripe balance to draw this payout from.
java.lang.String	getStatementDescriptor() A string to be displayed on the recipient's bank or card statement.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static PayoutCreateParams.Builder builder()

getAmount

public java.lang.Long getAmount()

A positive integer in cents representing how much to payout.

getCurrency

public java.lang.String getCurrency()

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

getDescription

public java.lang.String getDescription()

An arbitrary string attached to the object. Often useful for displaying to users.

getDestination

public java.lang.String getDestination()

The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

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 @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.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

A set of key-value pairs that you can attach to a payout object. It can be useful for storing additional information about the payout in a structured format.

getMethod

public PayoutCreateParams.Method getMethod()

The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).)

getSourceType

public PayoutCreateParams.SourceType getSourceType()

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 `bank_account` or `card`.

getStatementDescriptor

public java.lang.String getStatementDescriptor()

A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.