Balances

Type Members

case class Balance(available: List[BalanceFund], livemode: Boolean, pending: List[BalanceFund]) extends StripeObject with Product with Serializable

available
Funds that are available to be paid out automatically by Stripe or explicitly via the transfers API. The available balance for each currency and payment type can be found in the sourceTypes property.
pending
Funds that are not available in the balance yet, due to the 7-day rolling pay cycle. The pending balance for each currency and payment type can be found in the sourceTypes property

See also
https://stripe.com/docs/api#balance_object
case class BalanceFund(currency: Currency, amount: BigDecimal, sourceTypes: SourceTypes) extends Product with Serializable
case class BalanceHistoryListInput(availableOn: Option[ListFilterInput] = None, created: Option[ListFilterInput] = None, currency: Option[Currency] = None, endingBefore: Option[String] = None, limit: Option[Long] = None, source: Option[String] = None, startingAfter: Option[String] = None, transfer: Option[Boolean] = None, type: Option[Type] = None) extends Product with Serializable

availableOn
A filter on the list based on the object availableOn field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
created
A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
endingBefore
A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
limit
A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
source
Only returns transactions that are related to the specified Stripe object ID (e.g. filtering by a charge ID will return all related charge transactions).
startingAfter
A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next page of the list.
transfer
For automatic Stripe transfers only, only returns transactions that were transferred out on the specified transfer ID.

See also
https://stripe.com/docs/api#balance_history
case class BalanceTransaction(id: String, amount: BigDecimal, availableOn: OffsetDateTime, created: OffsetDateTime, currency: Currency, description: String, fee: BigDecimal, feeDetails: List[FeeDetails], net: BigDecimal, source: String, sourcedTransfers: TransferList, status: Option[Status], type: Type) extends StripeObject with Product with Serializable

amount
Gross amount of the transaction, in cents.
availableOn
The date the transaction’s net funds will become available in the Stripe balance.
fee
Fees (in cents) paid for this transaction
feeDetails
Detailed breakdown of fees (in cents) paid for this transaction
net
Net amount of the transaction, in cents.
source
The Stripe object this transaction is related to.
sourcedTransfers
The transfers (if any) for which source is a sourceTransaction.
status
If the transaction’s net funds are available in the Stripe balance yet. Either Status.Available or Status.Pending.

See also
https://stripe.com/docs/api#balance_transaction_object
case class BalanceTransactionList(url: String, hasMore: Boolean, data: List[BalanceTransaction], totalCount: Option[Long]) extends List[BalanceTransaction] with Product with Serializable
case class FeeDetails(amount: BigDecimal, application: String, currency: Currency, description: String, type: FeeType) extends Product with Serializable
sealed abstract class FeeType extends EnumEntry
case class SourceTypes(card: Option[BigDecimal], bankAccount: Option[BigDecimal], bitcoinReceiver: Option[BigDecimal]) extends Product with Serializable
sealed abstract class Status extends EnumEntry
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 BalanceTransactionList extends ListJsonMappers[BalanceTransaction] with Serializable
object FeeType extends Enum[FeeType]
object Status extends Enum[Status]
object Type extends Enum[Type]
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit val balanceDecoder: Decoder[Balance]
implicit val balanceEncoder: Encoder[Balance]
implicit val balanceFundDecoder: Decoder[BalanceFund]
implicit val balanceFundEncoder: Encoder[BalanceFund]
implicit val balanceTransactionDecoder: Decoder[BalanceTransaction]
implicit val balanceTransactionEncoder: Encoder[BalanceTransaction]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
implicit val feeDetailsDecoder: Decoder[FeeDetails]
implicit val feeDetailsEncoder: Encoder[FeeDetails]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(stripeAccount: Option[String] = None)(implicit apiKey: ApiKey, endpoint: Endpoint, client: HttpExt, materializer: Materializer, executionContext: ExecutionContext): Future[Try[Balance]]

stripeAccount
ID of the Stripe Connect managed account that you want to retrieve the balance for. If None, the platform account balance is retrieved.

See also
https://stripe.com/docs/api#retrieve_balance
def getBalanceTransaction(id: String)(implicit apiKey: ApiKey, endpoint: Endpoint, client: HttpExt, materializer: Materializer, executionContext: ExecutionContext): Future[Try[BalanceTransaction]]

See also
https://stripe.com/docs/api#retrieve_balance_transaction
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def listBalanceHistory(balanceHistoryListInput: BalanceHistoryListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint, client: HttpExt, materializer: Materializer, executionContext: ExecutionContext): Future[Try[BalanceTransactionList]]

See also
https://stripe.com/docs/api#balance_history
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 sourceTypesDecoder: Decoder[SourceTypes]
implicit val sourceTypesEncoder: Encoder[SourceTypes]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 Balances extends LazyLogging

Type Members

case class Balance(available: List[BalanceFund], livemode: Boolean, pending: List[BalanceFund]) extends StripeObject with Product with Serializable

case class BalanceFund(currency: Currency, amount: BigDecimal, sourceTypes: SourceTypes) extends Product with Serializable

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

case class FeeDetails(amount: BigDecimal, application: String, currency: Currency, description: String, type: FeeType) extends Product with Serializable

sealed abstract class FeeType extends EnumEntry

case class SourceTypes(card: Option[BigDecimal], bankAccount: Option[BigDecimal], bitcoinReceiver: Option[BigDecimal]) extends Product with Serializable

sealed abstract class Status extends EnumEntry

sealed abstract class Type extends EnumEntry

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object BalanceTransactionList extends ListJsonMappers[BalanceTransaction] with Serializable

object FeeType extends Enum[FeeType]

object Status extends Enum[Status]

object Type extends Enum[Type]

final def asInstanceOf[T0]: T0

implicit val balanceDecoder: Decoder[Balance]

implicit val balanceEncoder: Encoder[Balance]

implicit val balanceFundDecoder: Decoder[BalanceFund]

implicit val balanceFundEncoder: Encoder[BalanceFund]

implicit val balanceTransactionDecoder: Decoder[BalanceTransaction]

implicit val balanceTransactionEncoder: Encoder[BalanceTransaction]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit val feeDetailsDecoder: Decoder[FeeDetails]

implicit val feeDetailsEncoder: Encoder[FeeDetails]

def finalize(): Unit

def get(stripeAccount: Option[String] = None)(implicit apiKey: ApiKey, endpoint: Endpoint, client: HttpExt, materializer: Materializer, executionContext: ExecutionContext): Future[Try[Balance]]

def getBalanceTransaction(id: String)(implicit apiKey: ApiKey, endpoint: Endpoint, client: HttpExt, materializer: Materializer, executionContext: ExecutionContext): Future[Try[BalanceTransaction]]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def listBalanceHistory(balanceHistoryListInput: BalanceHistoryListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint, client: HttpExt, materializer: Materializer, executionContext: ExecutionContext): Future[Try[BalanceTransactionList]]

lazy val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit val sourceTypesDecoder: Decoder[SourceTypes]

implicit val sourceTypesEncoder: Encoder[SourceTypes]

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

def toString(): String

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