com.stripe.param

Class TopupCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.TopupCreateParams

public class TopupCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopupCreateParams.Builder

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 TopupCreateParams.Builder	builder()
java.lang.Long	getAmount() A positive integer representing how much to transfer.
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.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	getSource() The ID of a source to transfer funds from.
java.lang.String	getStatementDescriptor() Extra information about a top-up for the source's bank statement.
java.lang.String	getTransferGroup() A string that identifies this top-up 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 TopupCreateParams.Builder builder()

getAmount

public java.lang.Long getAmount()

A positive integer representing how much to transfer.

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.

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.

getSource

public java.lang.String getSource()

The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)).

getStatementDescriptor

public java.lang.String getStatementDescriptor()

Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.

getTransferGroup

public java.lang.String getTransferGroup()

A string that identifies this top-up as part of a group.