Transfers

Type Members

sealed abstract class FailureCode extends EnumEntry

See also
https://stripe.com/docs/api#transfer_failures
sealed abstract class SourceType extends EnumEntry
sealed abstract class Status extends EnumEntry
case class Transfer(id: String, amount: BigDecimal, amountReversed: BigDecimal, applicationFee: Option[BigDecimal], balanceTransaction: String, bankAccount: Option[BankAccount], created: OffsetDateTime, currency: Currency, date: OffsetDateTime, description: Option[String], destination: String, destinationPayment: Option[String], failureCode: Option[FailureCode], failureMessage: Option[String], livemode: Boolean, metadata: Option[Map[String, String]], recipient: Option[String], reversals: TransferReversalList, reversed: Boolean, sourceTransaction: Option[String], sourceType: SourceType, statementDescriptor: Option[String], status: Status, type: Type) extends Product with Serializable
case class 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]) extends Product with Serializable

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
case class TransferList(url: String, hasMore: Boolean, data: List[Transfer], totalCount: Option[Long]) extends List[Transfer] with Product with Serializable
case class TransferListInput(created: Option[ListFilterInput], date: Option[ListFilterInput], destination: Option[String], endingBefore: Option[String], limit: Option[String], recipient: Option[String], startingAfter: Option[String], status: Option[Status]) extends Product with Serializable
case class TransferReversalList(url: String, hasMore: Boolean, data: List[TransferReversal], totalCount: Option[Long]) extends List[TransferReversal] with Product with Serializable
sealed abstract class Type extends EnumEntry

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
object FailureCode extends Enum[FailureCode]
object SourceType extends Enum[SourceType]
object Status extends Enum[Status]
object TransferInput extends Serializable
object TransferList extends ListJsonMappers[Transfer] with Serializable
object TransferListInput extends Serializable
object TransferReversalList extends ListJsonMappers[TransferReversal] with Serializable
object Type extends Enum[Type]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def create(transferInput: TransferInput)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Transfer]]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit val failureCodeFormats: Format[FailureCode]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(id: String)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Transfer]]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def list(transferListInput: TransferListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[TransferList]]
lazy val logger: Logger

Attributes
protected
Definition Classes
LazyLogging
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit val sourceTypeFormats: Format[SourceType]
implicit val statusFormats: Format[Status]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
implicit val transferReads: Reads[Transfer]
implicit val transferWrites: Writes[Transfer]
implicit val typeFormats: Format[Type]
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 Doc: package v1

object Transfers extends LazyLogging

Type Members

sealed abstract class FailureCode extends EnumEntry

sealed abstract class SourceType extends EnumEntry

sealed abstract class Status extends EnumEntry

case class TransferList(url: String, hasMore: Boolean, data: List[Transfer], totalCount: Option[Long]) extends List[Transfer] with Product with Serializable

case class TransferListInput(created: Option[ListFilterInput], date: Option[ListFilterInput], destination: Option[String], endingBefore: Option[String], limit: Option[String], recipient: Option[String], startingAfter: Option[String], status: Option[Status]) extends Product with Serializable

case class TransferReversalList(url: String, hasMore: Boolean, data: List[TransferReversal], totalCount: Option[Long]) extends List[TransferReversal] with Product with Serializable

sealed abstract class Type extends EnumEntry

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object FailureCode extends Enum[FailureCode]

object SourceType extends Enum[SourceType]

object Status extends Enum[Status]

object TransferInput extends Serializable

object TransferList extends ListJsonMappers[Transfer] with Serializable

object TransferListInput extends Serializable

object TransferReversalList extends ListJsonMappers[TransferReversal] with Serializable

object Type extends Enum[Type]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def create(transferInput: TransferInput)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Transfer]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit val failureCodeFormats: Format[FailureCode]

def finalize(): Unit

def get(id: String)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Transfer]]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def list(transferListInput: TransferListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[TransferList]]

lazy val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit val sourceTypeFormats: Format[SourceType]

implicit val statusFormats: Format[Status]

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

def toString(): String

implicit val transferReads: Reads[Transfer]

implicit val transferWrites: Writes[Transfer]

implicit val typeFormats: Format[Type]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped