Stripe.Params.PaymentRecordReportRefundParams (tiger_stripe v0.3.0)

Parameters for payment record report refund.

Summary

Types

amount()

processor_details()

processor_details_custom()

refunded()

t()

Types

amount()

@type amount() :: %{
  optional(:currency) => String.t() | nil,
  optional(:value) => integer() | nil,
  optional(String.t()) => term()
}

currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.
value - A positive integer representing the amount in the currency's minor unit. For example, 100 can represent 1 USD or 100 JPY.

processor_details()

@type processor_details() :: %{
  optional(:custom) => processor_details_custom() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}

custom - Information about the custom processor used to make this refund.
type - The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor. Possible values: custom.

processor_details_custom()

@type processor_details_custom() :: %{
  optional(:refund_reference) => String.t() | nil,
  optional(String.t()) => term()
}

refund_reference - A reference to the external refund. This field must be unique across all refunds. Max length: 5000.

refunded()

@type refunded() :: %{
  optional(:refunded_at) => integer() | nil,
  optional(String.t()) => term()
}

refunded_at - When the reported refund completed. Measured in seconds since the Unix epoch. Format: Unix timestamp.

t()

@type t() :: %Stripe.Params.PaymentRecordReportRefundParams{
  amount: amount() | nil,
  expand: [String.t()] | nil,
  initiated_at: integer() | nil,
  metadata: map() | nil,
  outcome: String.t(),
  processor_details: processor_details(),
  refunded: refunded()
}

amount - A positive integer in the smallest currency unit representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment.
expand - Specifies which fields in the response should be expanded.
initiated_at - When the reported refund was initiated. Measured in seconds since the Unix epoch. Format: Unix timestamp.
metadata - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
outcome - The outcome of the reported refund. Possible values: refunded.
processor_details - Processor information for this refund.
refunded - Information about the payment attempt refund.