Object

org.mdedetrich.stripe.v1

Refunds

Related Doc: package v1

Permalink

object Refunds extends LazyLogging

See also

https://stripe.com/docs/api/curl#refunds

Linear Supertypes
LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Refunds
  2. LazyLogging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class Reason extends EnumEntry

    Permalink
  2. case class Refund(id: String, amount: BigDecimal, balanceTransaction: String, charge: String, created: OffsetDateTime, currency: Currency, metadata: Option[Map[String, String]], reason: Reason, receiptNumber: Option[String]) extends Product with Serializable

    Permalink

    amount

    Amount, in cents.

    balanceTransaction

    Balance transaction that describes the impact on your account balance.

    charge

    ID of the charge that was refunded.

    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.

    reason

    Reason for the refund. If set, possible values are Reason.Duplicate, Reason.Fraudulent, and Reason.RequestedByCustomer.

    receiptNumber

    This is the transaction number that appears on email receipts sent for this refund.

    See also

    https://stripe.com/docs/api#refund_object

  3. case class RefundInput(charge: String, reason: Reason, amount: Option[BigDecimal], metadata: Map[String, String], refundApplicationFee: Option[Boolean], reverseTransfer: Option[Boolean]) extends Product with Serializable

    Permalink

    charge

    The identifier of the charge to refund.

    reason

    String indicating the reason for the refund. If set, possible values are Reason.Duplicate, Reason.Fraudulent, and Reason.RequestedByCustomer. Specifying fraudulent as the reason when you believe the charge to be fraudulent will help us improve our fraud detection algorithms.

    amount

    A positive integer in cents representing how much of this charge to refund. Can only refund up to the unrefunded amount remaining of the charge.

    metadata

    A set of key/value pairs that you can attach to a refund object. It can be useful for storing additional information about the refund 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 refunding this charge. If a full charge refund is given, the full application fee will be refunded. Else, the application fee will be refunded with an amount proportional to the amount of the charge refunded. An application fee can only be refunded by the application that created the charge.

    reverseTransfer

    Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed for the same amount being refunded (either the entire or partial amount). A transfer can only be reversed by the application that created the charge.

    See also

    https://stripe.com/docs/api#create_refund

  4. case class RefundList(url: String, hasMore: Boolean, data: List[Refund], totalCount: Option[Long]) extends List[Refund] with Product with Serializable

    Permalink
  5. case class RefundListInput(charge: Option[String], endingBefore: Option[String], limit: Option[Long], startingAfter: Option[String]) extends Product with Serializable

    Permalink

    charge

    Only return refunds for the charge specified by this charge ID.

    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_refunds

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Reason extends Enum[Reason]

    Permalink
  5. object RefundInput extends Serializable

    Permalink
  6. object RefundList extends ListJsonMappers[Refund] with Serializable

    Permalink
  7. object RefundListInput extends Serializable

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def create(refundInput: RefundInput)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Refund]]

    Permalink
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def get(id: String)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[Refund]]

    Permalink
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  18. def list(refundListInput: RefundListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[RefundList]]

    Permalink
  19. lazy val logger: Logger

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

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. implicit val reasonFormats: Format[Reason]

    Permalink
  24. implicit val refundInputPostParams: PostParams[RefundInput]

    Permalink
  25. implicit val refundInputReads: Reads[RefundInput]

    Permalink
  26. implicit val refundInputWrites: Writes[RefundInput]

    Permalink
  27. implicit val refundReads: Reads[Refund]

    Permalink
  28. implicit val refundWrites: Writes[Refund]

    Permalink
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped