Inttegro.Refunds.Refund (inttegro v0.2.0)

A request to return money from paid order line items to the original payment method.

Refund processing is asynchronous. Inspect status, line items, amount, and error information, and reconcile completed refunds using balance transactions.

Summary

Types

t()

The decoded refund value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Refunds.Refund and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Refunds.Refund{
  canceled_at: String.t() | nil,
  created_at: String.t(),
  custom_data: %{optional(String.t()) => String.t()} | nil,
  failed_at: String.t() | nil,
  id: String.t(),
  line_items: [Inttegro.Refunds.LineItem.t()],
  order_id: String.t(),
  processing_at: String.t() | nil,
  reason: Inttegro.Refunds.Reason.t(),
  reason_details: String.t() | nil,
  reference: String.t() | nil,
  status: Inttegro.Refunds.Status.t(),
  succeeded_at: String.t() | nil,
  total: Inttegro.Money.Amount.t()
}

The decoded refund value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Refunds.Refund and raises KeyError when a required field is missing.