TransferReversals

Type Members

case class TransferReversal(id: String, amount: BigDecimal, balanceTransaction: String, created: OffsetDateTime, currency: Currency, metadata: Option[Map[String, String]], transfer: String) extends StripeObject with Product with Serializable

amount
Amount, in cents.
balanceTransaction
Balance transaction that describes the impact on your account balance.
currency
Three-letter ISO code representing the currency.
metadata
A set of key/value pairs that you can attach to the object. It can be useful for storing additional information in a structured format.
transfer
ID of the transfer that was reversed.

See also
https://stripe.com/docs/api#transfer_reversal_object
case class TransferReversalInput(id: String, amount: Option[BigDecimal], description: Option[String], metadata: Option[Map[String, String]], refundApplicationFee: Option[Boolean]) extends Product with Serializable

id
The identifier of the transfer to be reversed.
amount
A positive integer in cents representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts.
description
An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the dashboard. This will be unset if you POST an empty value.
metadata
A set of key/value pairs that you can attach to a reversal object. It can be useful for storing additional information about the reversal in a structured format. You can unset individual keys if you POST an empty value for that key. You can clear all keys if you POST an empty value for metadata.
refundApplicationFee
Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.

See also
https://stripe.com/docs/api#create_transfer_reversal
case class TransferReversalList(url: String, hasMore: Boolean, data: List[TransferReversal], totalCount: Option[Long]) extends List[TransferReversal] with Product with Serializable
case class TransferReversalListInput(id: String, endingBefore: Option[String], limit: Option[Long], startingAfter: Option[String]) extends Product with Serializable

id
The ID of the transfer whose reversals will be retrieved.
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 endingBefore=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.
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.

See also
https://stripe.com/docs/api#list_transfer_reversals

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 TransferReversalInput extends Serializable
object TransferReversalList extends ListJsonMappers[TransferReversal] with Serializable
object TransferReversalListInput extends Serializable
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(id: String, transferId: String)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[TransferReversal]]
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(transferReversalListInput: TransferReversalListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[TransferReversalList]]
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
implicit val transferReversalInputReads: Reads[TransferReversalInput]
implicit val transferReversalInputWrites: Writes[TransferReversalInput]
implicit val transferReversalReads: Reads[TransferReversal]
implicit val transferReversalWrites: Writes[TransferReversal]
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 TransferReversals extends LazyLogging

Type Members

case class TransferReversal(id: String, amount: BigDecimal, balanceTransaction: String, created: OffsetDateTime, currency: Currency, metadata: Option[Map[String, String]], transfer: String) extends StripeObject with Product with Serializable

case class TransferReversalInput(id: String, amount: Option[BigDecimal], description: Option[String], metadata: Option[Map[String, String]], refundApplicationFee: Option[Boolean]) extends Product with Serializable

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

case class TransferReversalListInput(id: String, endingBefore: Option[String], limit: Option[Long], startingAfter: Option[String]) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object TransferReversalInput extends Serializable

object TransferReversalList extends ListJsonMappers[TransferReversal] with Serializable

object TransferReversalListInput extends Serializable

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def create(transferReversalInput: TransferReversalInput)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[TransferReversal]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def list(transferReversalListInput: TransferReversalListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[TransferReversalList]]

lazy val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

implicit val transferReversalInputReads: Reads[TransferReversalInput]

implicit val transferReversalInputWrites: Writes[TransferReversalInput]

implicit val transferReversalReads: Reads[TransferReversal]

implicit val transferReversalWrites: Writes[TransferReversal]

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