Class

org.mdedetrich.stripe.v1.Refunds

RefundInput

Related Doc: package Refunds

Permalink

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

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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RefundInput
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RefundInput(charge: String, reason: Reason, amount: Option[BigDecimal] = None, metadata: Map[String, String] = Map.empty, refundApplicationFee: Option[Boolean] = None, reverseTransfer: Option[Boolean] = None)

    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.

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. val amount: Option[BigDecimal]

    Permalink

    A positive integer in cents representing how much of this charge to refund.

    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.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val charge: String

    Permalink

    The identifier of the charge to refund.

  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Any
  12. val metadata: Map[String, String]

    Permalink

    A set of key/value pairs that you can attach to a refund object.

    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.

  13. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  16. val reason: Reason

    Permalink

    String indicating the reason for the refund.

    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.

  17. val refundApplicationFee: Option[Boolean]

    Permalink

    Boolean indicating whether the application fee should be refunded when refunding this charge.

    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.

  18. val reverseTransfer: Option[Boolean]

    Permalink

    Boolean indicating whether the transfer should be reversed when refunding this charge.

    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.

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

    Permalink
    Definition Classes
    AnyRef
  20. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped