TransferInput

amount: A positive integer in cents representing how much to transfer.
currency: 3-letter ISO code for currency.
destination: The id of a bank account or a card to send the transfer to, or the string default_for_currency to use the default external account for the specified currency. If you use Stripe Connect, this can be the the id of a connected Stripe account; see the details about when such transfers are permitted.
description: An arbitrary string which you can attach to a transfer object. It is displayed when in the web interface alongside the transfer.
metadata: A set of key/value pairs that you can attach to a transfer object. It can be useful for storing additional information about the transfer in a structured format.
sourceTransaction: You can use this parameter to transfer funds from a charge (or other transaction) 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.
statementDescriptor: A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a statementDescriptor 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.
stripeAccount: The Stripe Connect managed account on whose behalf the transfer should be initiated.
sourceType: The source balance to draw this transfer from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. Valid options are: SourceType.AlipayAccount, SourceType.BankAccount, SourceType.BitcoinReceiver, and SourceType.Card.

Exceptions thrown: StatementDescriptorInvalidCharacter - If statementDescriptor has an invalid character
StatementDescriptorTooLong - If statementDescriptor is longer than 22 characters
See also: https://stripe.com/docs/api#create_transfer

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new TransferInput(amount: BigDecimal, currency: Currency, destination: String, description: Option[String], metadata: Option[Map[String, String]], sourceTransaction: Option[String], statementDescriptor: Option[String], stripeAccount: Option[String], sourceType: Option[SourceType])

amount
A positive integer in cents representing how much to transfer.
currency
3-letter ISO code for currency.
destination
The id of a bank account or a card to send the transfer to, or the string default_for_currency to use the default external account for the specified currency. If you use Stripe Connect, this can be the the id of a connected Stripe account; see the details about when such transfers are permitted.
description
An arbitrary string which you can attach to a transfer object. It is displayed when in the web interface alongside the transfer.
metadata
A set of key/value pairs that you can attach to a transfer object. It can be useful for storing additional information about the transfer in a structured format.
sourceTransaction
You can use this parameter to transfer funds from a charge (or other transaction) 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.
statementDescriptor
A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a statementDescriptor 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.
stripeAccount
The Stripe Connect managed account on whose behalf the transfer should be initiated.
sourceType
The source balance to draw this transfer from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. Valid options are: SourceType.AlipayAccount, SourceType.BankAccount, SourceType.BitcoinReceiver, and SourceType.Card.

Exceptions thrown
StatementDescriptorInvalidCharacter - If statementDescriptor has an invalid character
StatementDescriptorTooLong - If statementDescriptor is longer than 22 characters

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val amount: BigDecimal

A positive integer in cents representing how much to transfer.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val currency: Currency

3-letter ISO code for currency.
val description: Option[String]

An arbitrary string which you can attach to a transfer object.
An arbitrary string which you can attach to a transfer object. It is displayed when in the web interface alongside the transfer.
val destination: String

The id of a bank account or a card to send the transfer to, or the string default_for_currency to use the default external account for the specified currency.
The id of a bank account or a card to send the transfer to, or the string default_for_currency to use the default external account for the specified currency. If you use Stripe Connect, this can be the the id of a connected Stripe account; see the details about when such transfers are permitted.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val metadata: Option[Map[String, String]]

A set of key/value pairs that you can attach to a transfer object.
A set of key/value pairs that you can attach to a transfer object. It can be useful for storing additional information about the transfer in a structured format.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val sourceTransaction: Option[String]

You can use this parameter to transfer funds from a charge (or other transaction) before they are added to your available balance.
You can use this parameter to transfer funds from a charge (or other transaction) 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.
val sourceType: Option[SourceType]

The source balance to draw this transfer from.
The source balance to draw this transfer from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. Valid options are: SourceType.AlipayAccount, SourceType.BankAccount, SourceType.BitcoinReceiver, and SourceType.Card.
val statementDescriptor: Option[String]

A string to be displayed on the recipient's bank or card statement.
A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a statementDescriptor 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.
val stripeAccount: Option[String]

The Stripe Connect managed account on whose behalf the transfer should be initiated.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object TransferInput | package Transfers

Instance Constructors

new TransferInput(amount: BigDecimal, currency: Currency, destination: String, description: Option[String], metadata: Option[Map[String, String]], sourceTransaction: Option[String], statementDescriptor: Option[String], stripeAccount: Option[String], sourceType: Option[SourceType])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val amount: BigDecimal

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val currency: Currency

val description: Option[String]

val destination: String

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val metadata: Option[Map[String, String]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val sourceTransaction: Option[String]

val sourceType: Option[SourceType]

val statementDescriptor: Option[String]

val stripeAccount: Option[String]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped