com.stripe.param

Class TransferCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.TransferCreateParams

public class TransferCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferCreateParams.Builder
static class	TransferCreateParams.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 TransferCreateParams.Builder	builder()
java.lang.Long	getAmount() A positive integer in %s representing how much to transfer.
java.lang.String	getCurrency() 3-letter ISO code for currency.
java.lang.String	getDescription() An arbitrary string attached to the object.
java.lang.String	getDestination() The ID of a connected Stripe account.
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() Set of key-value pairs that you can attach to an object.
java.lang.String	getSourceTransaction() You can use this parameter to transfer funds from a charge before they are added to your available balance.
TransferCreateParams.SourceType	getSourceType() The source balance to use for this transfer.
java.lang.String	getTransferGroup() A string that identifies this transaction as part of a group.

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 TransferCreateParams.Builder builder()

getAmount

public java.lang.Long getAmount()

A positive integer in %s representing how much to transfer.

getCurrency

public java.lang.String getCurrency()

3-letter ISO code for currency.

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 connected Stripe account. <a href="/docs/connect/charges-transfers">See the Connect documentation</a> for details.

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()

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

getSourceTransaction

public java.lang.String getSourceTransaction()

You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. See the Connect documentation for details.

getSourceType

public TransferCreateParams.SourceType getSourceType()

The source balance to use for this transfer. One of bank_account, card, or fpx. For most users, this will default to card.

getTransferGroup

public java.lang.String getTransferGroup()

A string that identifies this transaction as part of a group. See the Connect documentation for details.