com.stripe.param

Class TopupCreateParams.Builder

java.lang.Object

com.stripe.param.TopupCreateParams.Builder

Enclosing class:

TopupCreateParams

public static class TopupCreateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TopupCreateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
TopupCreateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
TopupCreateParams	build() Finalize and obtain parameter instance from this builder.
TopupCreateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
TopupCreateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
TopupCreateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
TopupCreateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
TopupCreateParams.Builder	setAmount(java.lang.Long amount) A positive integer representing how much to transfer.
TopupCreateParams.Builder	setCurrency(java.lang.String currency) Three-letter ISO currency code, in lowercase.
TopupCreateParams.Builder	setDescription(java.lang.String description) An arbitrary string attached to the object.
TopupCreateParams.Builder	setMetadata(EmptyParam metadata) Set of key-value pairs that you can attach to an object.
TopupCreateParams.Builder	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) Set of key-value pairs that you can attach to an object.
TopupCreateParams.Builder	setSource(java.lang.String source) The ID of a source to transfer funds from.
TopupCreateParams.Builder	setStatementDescriptor(java.lang.String statementDescriptor) Extra information about a top-up for the source's bank statement.
TopupCreateParams.Builder	setTransferGroup(java.lang.String transferGroup) A string that identifies this top-up as part of a group.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public TopupCreateParams build()

Finalize and obtain parameter instance from this builder.

setAmount

public TopupCreateParams.Builder setAmount(java.lang.Long amount)

A positive integer representing how much to transfer.

setCurrency

public TopupCreateParams.Builder setCurrency(java.lang.String currency)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

setDescription

public TopupCreateParams.Builder setDescription(java.lang.String description)

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

addExpand

public TopupCreateParams.Builder addExpand(java.lang.String element)

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 TopupCreateParams.expand for the field documentation.

addAllExpand

public TopupCreateParams.Builder addAllExpand(java.util.List<java.lang.String> elements)

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 TopupCreateParams.expand for the field documentation.

putExtraParam

public TopupCreateParams.Builder putExtraParam(java.lang.String key,
                                               java.lang.Object value)

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 TopupCreateParams.extraParams for the field documentation.

putAllExtraParam

public TopupCreateParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)

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 TopupCreateParams.extraParams for the field documentation.

putMetadata

public TopupCreateParams.Builder putMetadata(java.lang.String key,
                                             java.lang.String value)

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 TopupCreateParams.metadata for the field documentation.

putAllMetadata

public TopupCreateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)

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 TopupCreateParams.metadata for the field documentation.

setMetadata

public TopupCreateParams.Builder setMetadata(EmptyParam metadata)

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.

setMetadata

public TopupCreateParams.Builder setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

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.

setSource

public TopupCreateParams.Builder setSource(java.lang.String source)

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

setStatementDescriptor

public TopupCreateParams.Builder setStatementDescriptor(java.lang.String statementDescriptor)

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

setTransferGroup

public TopupCreateParams.Builder setTransferGroup(java.lang.String transferGroup)

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